[[tags: allegro game]]
== allegro
This document pertains to display related methods found in the Allegro egg.
Please see the main [allegro] wiki page for more information.
[[toc:]]
== Constants
* default-display-adapter
* vertex-cache-size
== Enums
=== display-flag
(display-flag->int display-flag)
{{display-flag}} may be one of the following symbols:
* windowed
* fullscreen
* opengl
* direct3d-internal
* resizable
* noframe
* generate-expose-events
* opengl3
* opengl-forward-compatible
* fullscreen-window
* minimized
(int->display-flag integer)
=== display-option
(display-option->int display-option)
{{display-option}} may be one of the following symbols:
* red-size
* green-size
* blue-size
* alpha-size
* red-shift
* green-shift
* blue-shift
* alpha-shift
* acc-red-size
* acc-green-size
* acc-blue-size
* acc-alpha-size
* stereo
* aux-buffers
* color-size
* depth-size
* stencil-size
* sample-buffers
* samples
* render-method
* float-color
* float-depth
* single-buffer
* swap-method
* compatible-display
* update-display-region
* vsync
* max-bitmap-size
* support-npot-bitmap
* can-draw-into-bitmap
* support-separate-alpha
(int->display-option integer)
=== display-option-importance
(display-option-importance->int display-option-importance)
{{display-option-importance}} may be one of the following symbols:
* dont-care
* require
* suggest
(int->display-option-importance integer)
=== display-orientation
(display-orientation->int display-orientation)
{{display-orientation}} may be one of the following symbols:
* degrees-0
* degrees-90
* degrees-180
* degrees-270
* face-up
* face-down
(int->display-oprientation integer)
=== gl-variant
(gl-variant->int gl-variant)
{{gl-variant}} may be one of the following symbols:
* opengl
* opengl-es
(int->gl-variant integer)
== Records
=== display
display
=== display-mode
display-mode
(make-display-mode*)
(make-display-mode)
(free-display-mode! display-mode)
(display-mode-width display-mode)
(display-mode-width-set! display-mode integer)
(display-mode-height display-mode)
(display-mode-height-set! display-mode integer)
(display-mode-format display-mode)
(display-mode-format-set! display-mode pixel-format)
(display-mode-refresh-rate display-mode)
(display-mode-refresh-rate-set! display-mode integer)
=== monitor
monitor
(make-monitor*)
(make-monitor)
(free-monitor! monitor)
(monitor-x1 monitor)
(monitor-y1 monitor)
(monitor-x2 monitor)
(monitor-y2 monitor)
== Functions
=== Display
(new-display-refresh-rate)
Implements al_get_new_display_refresh_rate.
(new-display-refresh-rate-set! integer)
Implements al_set_new_display_refresh_rate.
(new-display-flags)
Implements al_get_new_display_flags.
(new-display-flags-set! integer)
Implements al_set_new_display_flags.
(new-display-adapter)
Implements al_get_new_display_adapter.
(new-display-adapter-set! integer)
Implements al_set_new_display_adpater.
(new-display-window-position)
Returns a 2-element list consisting of the new display coordinates.
(new-display-window-position-set! (integer x) (integer y))
Sets the a new display's window position.
(new-display-option-value display-option)
Retrieves the value for a particular display-option for newly created displays.
(new-display-option-importance display-option)
Retrieves the importance for a particular display-option for newly created dispalys.
(new-display-option-set! display-option (integer value) display-option-importance)
Implements al_set_new_display_option.
(new-display-reset-options)
Implements al_reset_new_display_options.
(make-display* (integer width) (integer height))
Implements al_create_display.
(make-display (integer width) (integer height))
Implements al_create_display, with (free-display!) declared as a finalizer.
(make-display/mode* display-mode (integer adapter) (integer flags))
Creates a new display, taking the refresh rate, width and height from a display-mode struct.
(make-display/mode display-mode (integer adapter) (integer flags))
Creates a new display, taking the refresh rate, width and height from a display-mode struct, with (free-display-mode!) declared as a finalizer.
(free-display! display)
Implements al_destroy_display.
(current-display)
Implements al_get_current_display.
(display-mode-count)
Implements al_get_num_display_modes.
(display-mode-init! display-mode (integer index))
Implements al_get_display_mode, returning #f if unsuccessful.
(update-display-region! (integer x) (integer y) (integer width) (integer height))
Implements al_update_display_region.
(compatible-bitmap? bitmap)
Implements al_is_compatible_bitmap.
(wait-for-vsync)
Implements al_wait_for_vsync.
(draw-pixel (float x) (floay y) color)
Implements al_draw_pixel.
(video-adapter-count)
Implements al_get_num_video_adapters.
(monitor-init! monitor (integer adapter))
Implements al_get_monitor_info.
(display-option display display-option)
Implements al_get_display_option.
(display-hold-bitmap-drawing! bool)
Implements al_hold_bitmap_drawing.
(display-bitmap-drawing-held?)
Implements al_is_bitmap_drawing_help.
(display-window-title-set! display string)
Implements al_set_window_title.
(display-width display)
Implements al_get_display_width.
(display-height display)
Implements al_get_display_height.
(display-format display)
Implements al_get_display_format.
(display-refresh-rate display)
Implements al_get_display_refresh_rate.
(display-flags display)
Implements al_get_display_flags.
(display-toggle-flag! display display-flag bool)
Implements al_toggle_display_flag.
(display-backbuffer display)
Implements al_get_backbuffer.
(display-acknowledge-resize display)
Implements al_acknowledge_resize.
(display-resize! display (integer width) (integer height))
Implements al_resize_display.
(display-event-source display)
Implements al_get_display_event_source.
(display-iconset! display bitmap)
Implements al_set_display_icon.
(clear-to-color color)
Implements al_clear_to_color.
(target-bitmap)
Implements al_get_target_bitmap.
(target-bitmap-set! bitmap)
Implements al_set_target_bitmap.
(target-backbuffer-set! display)
Implements al_set_target_backbuffer.
(flip-display)
Implements al_flip_display.
=== Direct3D
(d3d-non-pow2-texture-support?)
Implements al_have_d3d_non_pow2_texture_support.
(d3d-non-square-texture-support?)
Implements al_have_d3d_non_square_texture_support.
==== Bitmap Specific
(bitmap-d3d-system-texture bitmap)
Implements al_get_d3d_system_texture.
(bitmap-d3d-video-texture bitmap)
Implements al_get_d3d_video_texture.
(bitmap-d3d-texture-position bitmap)
Returns a 2-element list consisting of a u, v pair.
==== Display Specific
(display-d3d-device-lost? display)
Implements al_is_d3d_device_lost.
(display-d3d-device display)
Implements al_get_d3d_device.
=== OpenGL
(opengl-addon-version)
Implements al_get_opengl_version.
(opengl-extension-exists? string)
Implements al_have_opengl_extension.
(opengl-proc-address string)
Implements al_get_opengl_proc_address.
(opengl-texture bitmap)
Implements al_get_opengl_texture.
(opengl-remove-fbo! bitmap)
Implements al_remove_opengl_fbo.
(opengl-fbo bitmap)
Implements al_get_opengl_fbo.
(opengl-texture-size bitmap)
Returns a 2-element list of the width and height of the opengl texture for the given bitmap.
(opengl-texture-position bitmap)
Returns a 2-element list of the u,v position of the opengl texture for the given bitmap.
(opengl-context-set! display)
Implements al_set_current_opengl_context.
(opengl-variant)
Implements al_get_opengl_variant.
=== Windows
(windows-window-handle)
Implements al_get_win_window_handle.