Search
|
These functions are declared in the main Allegro header file:
Display creationALLEGRO_DISPLAY
An opaque type representing an open display or window. al_create_display
Create a display, or window, with the specified dimensions. The parameters of the display are determined by the last calls to al_set_new_display_*. Default parameters are used if none are set explicitly. Creating a new display will automatically make it the active one, with the backbuffer selected for drawing. Returns NULL on error. See also: al_set_new_display_flags, al_set_new_display_option, al_set_new_display_refresh_rate al_get_new_display_flags
Gets the current flags used for newly created displays. See also: al_set_new_display_flags, al_toggle_display_flag al_get_new_display_refresh_rate
Gets the current refresh rate used for newly created displays. See also: al_set_new_display_refresh_rate al_get_new_window_position
Gets the position where newly created non-fullscreen displays will be placed. See also: al_set_new_window_position al_set_new_display_option
Sets an extra display option. Allegro itself will not care about those options itself, but you may want to specify them, for example if you want to use multisampling. The 'importance' parameter can be either:
The supported options are:
FIXME: document them all in detail See also: al_set_new_display_flags al_get_new_display_option
Retrieve an extra display setting which was previously set with al_set_new_display_option. al_reset_new_display_options
This undoes any previous calls to al_set_new_display_option. al_set_new_display_flags
Sets various flags for display creation. flags is a bitfield containing any reasonable combination of the following:
Make the window span the entire screen. Unlike ALLEGRO_FULLSCREEN this will never attempt to modify the screen resolution. Instead the pixel dimensions of the created display will be the same as the desktop. The passed width and height are only used if the window is switched out of fullscreen mode later but will be ignored initially. Under Windows and X11 a fullscreen display created with this flag will behave differently from one created with the ALLEGRO_FULLSCREEN flag - even if the ALLEGRO_FULLSCREEN display is passed the desktop dimensions. The exact difference is platform dependent, but some things which may be different is how alt-tab works, how fast you can toggle between fullscreen/windowed mode or how additional monitors behave while your display is in fullscreen mode.
0 can be used for default values. See also: al_set_new_display_option, al_get_display_option al_set_new_display_refresh_rate
Sets the refresh rate to use for newly created displays. If the refresh rate is not available, al_create_display will fail. A list of modes with refresh rates can be found with al_get_num_display_modes and al_get_display_mode. al_set_new_window_position
Sets where the top left pixel of the client area of newly created windows (non-fullscreen) will be on screen. Negative values allowed on some multihead systems. See also: al_get_new_window_position Display operationsal_acknowledge_resize
When the user receives a resize event from a resizable display, if they wish the display to be resized they must call this function to let the graphics driver know that it can now resize the display. Returns true on success. Adjusts the clipping rectangle to the full size of the backbuffer. Note that a resize event may be outdated by the time you acknowledge it; there could be further resize events generated in the meantime. See also: al_resize_display, ALLEGRO_EVENT al_flip_display
Copies or updates the front and back buffers so that what has been drawn previously on the currently selected display becomes visible on screen. Pointers to the special back and front buffer bitmaps remain valid and retain their semantics as back and front buffers respectively, although their contents may have changed. Several display options change how this function behaves: With ALLEGRO_SINGLE_BUFFER, no flipping is done. You still have to call this function to display graphics, depending on how the used graphics system works. The ALLEGRO_SWAP_METHOD option may have additional information about what kind of operation is used internally to flip the front and back buffers. If ALLEGRO_VSYNC is 1, this function will force waiting for vsync. If ALLEGRO_VSYNC is 2, this function will not wait for vsync. With many drivers the vsync behavior is controlled by the user and not the application, and ALLEGRO_VSYNC will not be set; in this case al_flip_display will wait for vsync depending on the settings set in the system's graphics preferences. See also: al_set_new_display_flags, al_set_new_display_option al_get_backbuffer
Return a special bitmap representing the back-buffer of the current display. Care should be taken when using the backbuffer bitmap (and its sub-bitmaps) as the source bitmap (e.g as the bitmap argument to al_draw_bitmap). Only untransformed operations are hardware accelerated. This consists of al_draw_bitmap and al_draw_bitmap_region when the current transformation is the identity. If the tranformation is not the identity, or some other drawing operation is used, the call will be routed through the memory bitmap routines, which are slow. If you need those operations to be accelerated, then first copy a region of the backbuffer into a temporary bitmap (via the al_draw_bitmap and al_draw_bitmap_region), and then use that temporary bitmap as the source bitmap. See also: al_get_frontbuffer al_get_current_display
Query for the current display in the calling thread. Returns NULL if there is none. See also: al_set_current_display al_get_display_flags
Gets the flags of the current display. See also: al_set_new_display_flags al_get_display_format
Gets the pixel format of the current display. See also: ALLEGRO_PIXEL_FORMAT al_get_display_height
Gets the height of the current display. This is like SCREEN_H in Allegro 4.x. See also: al_get_display_width al_get_display_refresh_rate
Gets the refresh rate of the current display. See also: al_set_new_display_refresh_rate al_get_display_width
Gets the width of the current display. This is like SCREEN_W in Allegro 4.x. See also: al_get_display_height al_get_frontbuffer
Return a special bitmap representing the front-buffer of the current display. This may not be supported by the driver; returns NULL in that case. See also: al_get_backbuffer al_get_window_position
Gets the position of a non-fullscreen display. See also: al_set_window_position al_inhibit_screensaver
This function allows the user to stop the system screensaver from starting up if true is passed, or resets the system back to the default state (the state at program start) if false is passed. It returns true if the state was set successfully, otherwise false. al_resize_display
Resize the current display. Returns true on success, or false on error. This works on both fullscreen and windowed displays, regardless of the ALLEGRO_RESIZABLE flag. Adjusts the clipping rectangle to the full size of the backbuffer. See also: al_acknowledge_resize al_set_current_display
Change the current display for the calling thread. Also sets the target bitmap to the display's backbuffer. A display may not be "current" for multiple threads simultaneously. To stop a display being current for the calling thread, call Returns true on success. See also: al_get_current_display al_set_display_icon
Changes the icon associated with the current display (window). Note: If the underlying OS can not use an icon with the size of the provided bitmap, it will be scaled. TODO: Describe best practice for the size? TODO: Allow providing multiple icons in differet sizes? al_get_display_option
Return an extra display setting of the current display. See also: al_set_new_display_option al_set_window_position
Sets the position on screen of a non-fullscreen display. See also: al_get_window_position al_toggle_display_flag
Enable or disable one of the display flags. The flags are the same as for al_set_new_display_flags. Note however that some of the flags cannot be changed after the display has been created. Returns true if the driver supports toggling the specified flag else false. You can use al_get_display_flags to query whether the given display property actually changed. See also: al_set_new_display_flags, al_get_display_flags al_update_display_region
Does the same as al_flip_display, but tries to update only the specified region. With many drivers this is not possible, but for some it can improve performance. The ALLEGRO_UPDATE_DISPLAY_REGION option (see al_get_display_option) will specify the behavior of this function in the current display. See also: al_flip_display, al_get_display_option al_wait_for_vsync
Wait for the beginning of a vertical retrace. Some driver/card/monitor combinations may not be capable of this. Note how al_flip_display usually already waits for the vertical retrace, so unless you are doing something special, there is no reason to call this function. Returns false if not possible, true if successful. See also: al_flip_display al_get_display_event_source
Retrieve the associated event source. Fullscreen display modesALLEGRO_DISPLAY_MODE
Used for display mode queries. Contains information about a supported fullscreen display mode.
See also: al_get_display_mode al_get_display_mode
Retrieves a display mode. Display parameters should not be changed between a call of al_get_num_display_modes and al_get_display_mode. index must be between 0 and the number returned from al_get_num_display_modes-1. mode must be an allocated ALLEGRO_DISPLAY_MODE structure. This function will return NULL on failure, and the mode parameter that was passed in on success. See also: ALLEGRO_DISPLAY_MODE, al_get_num_display_modes al_get_num_display_modes
Get the number of available fullscreen display modes for the current set of display parameters. This will use the values set with al_set_new_display_refresh_rate, and al_set_new_display_flags to find the number of modes that match. Settings the new display parameters to zero will give a list of all modes for the default driver. See also: al_get_display_mode MonitorsALLEGRO_MONITOR_INFO
Describes a monitors size and position relative to other monitors. x1, y1 will be 0, 0 on the primary display. Other monitors can have negative values if they are to the left or above the primary display.
See also: al_get_monitor_info al_get_current_video_adapter
Gets the video adapter index where new displays will be created. See also: al_set_current_video_adapter al_set_current_video_adapter
Sets the adapter to use for newly created displays. The adapter has a monitor attached to it. Information about the monitor can be gotten using al_get_num_video_adapters and al_get_monitor_info. See also: al_get_num_video_adapters, al_get_monitor_info al_get_monitor_info
Get information about a monitor's position on the desktop. adapter is a number from 0 to al_get_num_video_adapters()-1. See also: ALLEGRO_MONITOR_INFO, al_get_num_video_adapters al_get_num_video_adapters
Get the number of video "adapters" attached to the computer. Each video card attached to the computer counts as one or more adapters. An adapter is thus really a video port that can have a monitor connected to it. See also: al_get_monitor_info |
Last updated: 2010-05-26 10:53:16 UTC