All Functions and Procedures

Name Unit Description
ALLEGRO_BPM_TO_SECS Allegro5

Converts beats per minute to seconds.

ALLEGRO_BPS_TO_SECS Allegro5

Converts beats per second to seconds.

ALLEGRO_END_OF_MENU al5nativedlg

Helper to build native menus.

ALLEGRO_EVENT_TYPE_IS_USER Allegro5

Returns True if the event type is not a builtin event type, i.e.

ALLEGRO_GET_EVENT_TYPE Allegro5

Makes an event type identifier, which is a 32-bit integer.

ALLEGRO_ITEM_OF_MENU al5nativedlg

Helper to build native menus.

ALLEGRO_MENU_SEPARATOR al5nativedlg

Helper to build native menus.

ALLEGRO_MSECS_TO_SECS Allegro5

Converts milliseconds to seconds.

ALLEGRO_USECS_TO_SECS Allegro5

Converts microseconds to seconds.

al_acknowledge_drawing_halt Allegro5

 

al_acknowledge_drawing_resume Allegro5

 

al_acknowledge_resize Allegro5

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.

al_add_config_comment Allegro5

Adds a comment in a section of a configuration.

al_add_config_section Allegro5

Adds a section to a configuration structure with the given name.

al_add_new_bitmap_flag Allegro5

A convenience function which does the same as

  al_set_new_bitmap_flags (al_get_new_bitmap_flags OR flag);

al_add_timer_count Allegro5

 

al_append_menu_item al5nativedlg

Appends a menu item to the end of the menu.

al_append_native_text_log al5nativedlg

Appends a line of text to the message log window and scrolls to the bottom (if the line would not be visible otherwise).

al_attach_audio_stream_to_mixer al5audio

Attach an audio stream to a mixer.

al_attach_audio_stream_to_voice al5audio

Attaches an audio stream to a voice.

al_attach_mixer_to_mixer al5audio

 

al_attach_mixer_to_voice al5audio

Attaches a mixer to a voice.

al_attach_sample_instance_to_mixer al5audio

 

al_attach_sample_instance_to_voice al5audio

Attaches a sample instance to a voice, and allows it to play.

al_attach_shader_source Allegro5

Attaches the shader's source code to the shader object and compiles it.

al_attach_shader_source_file Allegro5

Like al_attach_shader_source but reads the source code for the shader from the named file.

al_build_camera_transform Allegro5

 

al_build_menu al5nativedlg

Builds a menu based on the specifications of a sequence of ALLEGRO_MENU_INFO elements.

al_build_shader Allegro5

This is required before the shader can be used with al_use_shader.

al_build_transform Allegro5

 

al_calculate_arc al5primitives

When thickness <= 0 this function computes positions of num_points regularly spaced points on an elliptical arc.

al_calculate_ribbon al5primitives

 

al_calculate_spline al5primitives

 

al_calloc Allegro5

Like calloc in the C standard library, but the implementation may be overridden.

al_calloc_with_context Allegro5

This calls calloc from the Allegro library (this matters on Windows), unless overridden with al_set_memory_interface.

al_check_inverse Allegro5

 

al_clear_depth_buffer Allegro5

 

al_clear_to_color Allegro5

Clears the complete target bitmap, but confined by the clipping rectangle.

al_clipboard_has_text Allegro5

 

al_clone_bitmap Allegro5

Create a new bitmap with al_create_bitmap, and copy the pixel data from the old bitmap across.

al_clone_menu al5nativedlg

Makes a copy of a menu so that it can be reused on another display.

al_clone_menu_for_popup al5nativedlg

Exactly like al_clone_menu, except that the copy is for a popup menu.

al_close_native_text_log al5nativedlg

Closes a message log window opened with al_open_native_text_log earlier.

al_color_cmyk al5color

 

al_color_cmyk_to_rgb al5color

 

al_color_hsl al5color

 

al_color_hsl_to_rgb al5color

 

al_color_hsv al5color

 

al_color_hsv_to_rgb al5color

 

al_color_html al5color

 

al_color_html_to_rgb al5color

 

al_color_name al5color

 

al_color_name_to_rgb al5color

 

al_color_rgb_to_cmyk al5color

 

al_color_rgb_to_hsl al5color

 

al_color_rgb_to_hsv al5color

 

al_color_rgb_to_html al5color

 

al_color_rgb_to_name al5color

 

al_color_rgb_to_yuv al5color

 

al_color_yuv al5color

 

al_color_yuv_to_rgb al5color

 

al_compose_transform Allegro5

 

al_convert_bitmap Allegro5

Converts the bitmap to the current bitmap flags and format.

al_convert_mask_to_alpha Allegro5

Converts the given mask color to an alpha channel in the bitmap.

al_convert_memory_bitmap Allegro5

If you create a bitmap when there is no current display (for example because you have not called al_create_display in the current thread) and are using the ALLEGRO_CONVERT_BITMAP bitmap flag (which is set by default) then the bitmap will be created successfully, but as a memory bitmap.

al_copy_transform Allegro5

 

al_create_audio_stream al5audio

Stream functions

al_create_bitmap Allegro5

Creates a new bitmap using the bitmap format and flags for the current thread.

al_create_builtin_font al5font

 

al_create_config Allegro5

Creates an empty configuration structure.

al_create_display Allegro5

Creates a display, or window, with the specified dimensions.

al_create_event_queue Allegro5

Creates a new, empty event queue.

al_create_file_handle Allegro5

Creates an empty, opened file handle with some abstract user data.

al_create_index_buffer al5primitives

 

al_create_menu al5nativedlg

Creates a menu container that can hold menu items.

al_create_mixer al5audio

Mixer functions

al_create_mouse_cursor Allegro5

Creates a mouse cursor from the bitmap provided.

al_create_native_file_dialog al5nativedlg

Creates a new native file dialog.

al_create_popup_menu al5nativedlg

Creates a menu container for popup menus.

al_create_sample al5audio

Sample functions

al_create_sample_instance al5audio

Sample instance functions

al_create_shader Allegro5

Creates a shader object.

al_create_sub_bitmap Allegro5

Creates a sub-bitmap of the parent, at the specified coordinates and of the specified size.

al_create_timer Allegro5

Allocates and initializes a timer.

al_create_vertex_buffer al5primitives

 

al_create_vertex_buffer_ex al5primitives

 

al_create_vertex_decl al5primitives

Creates a vertex declaration, which describes a custom vertex format.

al_create_voice al5audio

Creates a voice structure and allocates a voice from the digital sound driver.

al_cstr Allegro5

Get a AL_STRptr pointer to the data in a string.

al_cstr_dup Allegro5

Creates a NUL ($00) terminated copy of the string.

al_destroy_audio_stream al5audio

 

al_destroy_bitmap Allegro5

Destroys the given bitmap, freeing all resources used by it.

al_destroy_config Allegro5

Frees the resources used by a configuration structure.

al_destroy_display Allegro5

Destroys a display.

al_destroy_event_queue Allegro5

Destroys the event queue specified.

al_destroy_font al5font

 

al_destroy_index_buffer al5primitives

 

al_destroy_menu al5nativedlg

Destroys an entire menu, including its sub-menus.

al_destroy_mixer al5audio

 

al_destroy_mouse_cursor Allegro5

Frees the memory used by the given cursor.

al_destroy_native_file_dialog al5nativedlg

Frees up all resources used by the file dialog.

al_destroy_sample al5audio

 

al_destroy_sample_instance al5audio

 

al_destroy_shader Allegro5

Destroy a shader.

al_destroy_timer Allegro5

 

al_destroy_user_event_source Allegro5

Destroys an event source initialised with al_init_user_event_source.

al_destroy_vertex_buffer al5primitives

 

al_destroy_vertex_decl al5primitives

Destroys a vertex declaration.

al_destroy_voice al5audio

Destroys the voice and deallocates it from the digital driver.

al_detach_audio_stream al5audio

 

al_detach_mixer al5audio

 

al_detach_sample_instance al5audio

 

al_detach_voice al5audio

Detaches the mixer, sample instance or audio stream from the voice.

al_disable_menu_event_source al5nativedlg

Disables a unique event source for the menu, causing it to use the default event source.

al_drain_audio_stream al5audio

 

al_draw_arc al5primitives

 

al_draw_bitmap Allegro5

Draws an unscaled, unrotated bitmap at the given position to the current target bitmap.

al_draw_bitmap_region Allegro5

Draws a region of the given bitmap to the target bitmap.

al_draw_circle al5primitives

Draws an outlined circle.

al_draw_ellipse al5primitives

 

al_draw_elliptical_arc al5primitives

 

al_draw_filled_circle al5primitives

 

al_draw_filled_ellipse al5primitives

 

al_draw_filled_pieslice al5primitives

 

al_draw_filled_polygon al5primitives

 

al_draw_filled_polygon_with_holes al5primitives

 

al_draw_filled_rectangle al5primitives

 

al_draw_filled_rounded_rectangle al5primitives

 

al_draw_filled_triangle al5primitives

Draws a filled triangle.

al_draw_glyph al5font

 

al_draw_indexed_buffer al5primitives

 

al_draw_indexed_prim al5primitives

 

al_draw_justified_text al5font

 

al_draw_justified_ustr al5font

 

al_draw_line al5primitives

Draws a line segment between two points.

al_draw_pieslice al5primitives

 

al_draw_pixel Allegro5

 

al_draw_polygon al5primitives

 

al_draw_polyline al5primitives

 

al_draw_prim al5primitives

Draws a subset of the passed vertex array.

al_draw_prim_ex al5primitives

 

al_draw_rectangle al5primitives

Draws an outlined rectangle.

al_draw_ribbon al5primitives

 

al_draw_rotated_bitmap Allegro5

Draws a rotated version of the given bitmap to the target bitmap.

al_draw_rounded_rectangle al5primitives

 

al_draw_scaled_bitmap Allegro5

Draws a scaled version of the given bitmap to the target bitmap.

al_draw_scaled_rotated_bitmap Allegro5

Like al_draw_rotated_bitmap, but can also scale the bitmap.

al_draw_soft_line al5primitives

 

al_draw_soft_triangle al5primitives

Custom primitives

al_draw_spline al5primitives

 

al_draw_text al5font

Writes the string text onto the target bitmap at position x, y, using the specified font.

al_draw_tinted_bitmap Allegro5

Like al_draw_bitmap but multiplies all colors in the bitmap with the given color.

al_draw_tinted_bitmap_region Allegro5

Like al_draw_bitmap_region but multiplies all colors in the bitmap with the given color.

al_draw_tinted_rotated_bitmap Allegro5

Like al_draw_rotated_bitmap but multiplies all colors in the bitmap with the given color.

al_draw_tinted_scaled_bitmap Allegro5

Like al_draw_scaled_bitmap but multiplies all colors in the bitmap with the given color.

al_draw_tinted_scaled_rotated_bitmap Allegro5

Like al_draw_tinted_scaled_rotated_bitmap but you specify an area within the bitmap to be drawn.

al_draw_tinted_scaled_rotated_bitmap_region Allegro5

Like al_draw_tinted_scaled_rotated_bitmap but you specify an area within the bitmap to be drawn.

al_draw_triangle al5primitives

Draws an outlined triangle.

al_draw_ustr al5font

 

al_draw_vertex_buffer al5primitives

 

al_drop_next_event Allegro5

 

al_emit_user_event Allegro5

The second argument is ALLEGRO_EVENT instead of ALLEGRO_USER_EVENT * to prevent users passing a pointer to a too-short structure.

al_enable_menu_event_source al5nativedlg

Enables a unique event source for this menu.

al_fclearerr Allegro5

Clears the error indicator for the given file.

al_fclose Allegro5

Close the given file, writing any buffered output data (if any).

al_feof Allegro5

Returns True if the end-of-file indicator has been set on the file, i.e.

al_ferrmsg Allegro5

Returns a message string with details about the last error that occurred on the given file handle.

al_ferror Allegro5

Returns non-zero if the error indicator is set on the given file, i.e.

al_fflush Allegro5

Flush any pending writes to the given file.

al_fgetc Allegro5

Reads and returns next byte in the given file.

al_fgets Allegro5

Reads a string of bytes terminated with a newline or end-of-file into the buffer given.

al_fget_ustr Allegro5

Read a string of bytes terminated with a newline or end-of-file.

al_fill_silence al5audio

Fill a buffer with silence, for the given format and channel configuration.

al_find_menu al5nativedlg

Searches in the haystack menu for any submenu with the given id.

al_find_menu_item al5nativedlg

Searches in the haystack menu for an item with the given id.

al_flip_display Allegro5

Copies or updates the front and back buffers so that what has been drawn previously on the currently selected display becomes visible on screen.

al_flush_event_queue Allegro5

 

al_fopen Allegro5

Creates and opens a file (real or virtual) given the path and mode.

al_fopen_interface Allegro5

Opens a file using the specified interface, instead of the interface set with al_set_new_file_interface.

al_fopen_slice Allegro5

/* Specific to stdio backend.

al_fputc Allegro5

Writes a single byte to the given file.

al_fputs Allegro5

Writes a string to file.

al_fread Allegro5

Read size bytes into the buffer pointed to by ptr, from the given file.

al_fread16be Allegro5

Reads a 16-bit word in big-endian format (MSB first).

al_fread16le Allegro5

Reads a 16-bit word in little-endian format (LSB first).

al_fread32be Allegro5

Reads a 32-bit word in big-endian format (MSB first).

al_fread32le Allegro5

Reads a 32-bit word in little-endian format (LSB first).

al_free Allegro5

Like free in the C standard library, but the implementation may be overridden.

al_free_with_context Allegro5

This calls free from the Allegro library (this matters on Windows), unless overridden with al_set_memory_interface.

al_fseek Allegro5

Set the current position of the given file to a position relative to that specified by whence, plus offset number of bytes.

al_fsize Allegro5

Returns the size of the file, if it can be determined, or -1 otherwise.

al_ftell Allegro5

Returns the current position in the given file, or -1 on error.

al_fungetc Allegro5

Ungets a single byte from a file.

al_fwrite Allegro5

Write size bytes from the buffer pointed to by ptr into the given file.

al_fwrite16be Allegro5

Writes a 16-bit word in big-endian format (MSB first).

al_fwrite16le Allegro5

Writes a 16-bit word in little-endian format (LSB first).

al_fwrite32be Allegro5

Writes a 32-bit word in big-endian format (MSB first).

al_fwrite32le Allegro5

Writes a 32-bit word in little-endian format (LSB first).

al_get_allegro_acodec_version al5acodec

Returns the (compiled) version of the addon, in the same format as al_get_allegro_version.

al_get_allegro_audio_version al5audio

Returns the (compiled) version of the addon, in the same format as al_get_allegro_version.

al_get_allegro_color_version al5color

 

al_get_allegro_font_version al5font

Returns the (compiled) version of the addon, in the same format as al_get_allegro_version.

al_get_allegro_image_version al5image

Returns the (compiled) version of the addon, in the same format as al_get_allegro_version.

al_get_allegro_native_dialog_version al5nativedlg

Returns the (compiled) version of the addon, in the same format as al_get_allegro_version.

al_get_allegro_primitives_version al5primitives

Returns the (compiled) version of the addon, in the same format as al_get_allegro_version.

al_get_allegro_ttf_version al5ttf

Returns the (compiled) version of the addon, in the same format as al_get_allegro_version.

al_get_allegro_version Allegro5

Returns the (compiled) version of the Allegro library, packed into a single integer as groups of 8 bits.

al_get_audio_depth_size al5audio

Return the size of a sample, in bytes, for the given format.

al_get_audio_stream_attached al5audio

 

al_get_audio_stream_channels al5audio

 

al_get_audio_stream_depth al5audio

 

al_get_audio_stream_event_source al5audio

 

al_get_audio_stream_fragment al5audio

 

al_get_audio_stream_fragments al5audio

 

al_get_audio_stream_frequency al5audio

 

al_get_audio_stream_gain al5audio

 

al_get_audio_stream_length al5audio

 

al_get_audio_stream_length_secs al5audio

 

al_get_audio_stream_pan al5audio

 

al_get_audio_stream_playing al5audio

 

al_get_audio_stream_playmode al5audio

 

al_get_audio_stream_position_secs al5audio

 

al_get_audio_stream_speed al5audio

 

al_get_available_audio_stream_fragments al5audio

 

al_get_backbuffer Allegro5

Returns a special bitmap representing the back-buffer of the display.

al_get_bitmap_flags Allegro5

Returns the flags user to create the bitmap.

al_get_bitmap_format Allegro5

Returns the pixel format of a bitmap.

al_get_bitmap_height Allegro5

Returns the height of a bitmap in pixels.

al_get_bitmap_width Allegro5

Returns the width of a bitmap in pixels.

al_get_bitmap_x Allegro5

For a sub-bitmap, return it's x position within the parent.

al_get_bitmap_y Allegro5

For a sub-bitmap, return it's y position within the parent.

al_get_blender Allegro5

Returns the active blender for the current thread.

al_get_blend_color Allegro5

Returns the color currently used for constant color blending (white by default).

al_get_channel_count al5audio

Return the number of channels for the given channel configuration, which is one of the values listed under ALLEGRO_CHANNEL_CONF.

al_get_clipboard_text Allegro5

* clipboard.h * * Clipboard handling.

al_get_clipping_rectangle Allegro5

Gets the clipping rectangle of the target bitmap.

al_get_config_value Allegro5

Sets a pointer to an internal character buffer that will only remain valid as long as the ALLEGRO_CONFIGptr structure is not destroyed.

al_get_cpu_count Allegro5

Returns the number of CPU cores that the system Allegro is running on has and which could be detected, or a negative number if detection failed.

al_get_current_display Allegro5

 

al_get_current_inverse_transform Allegro5

 

al_get_current_projection_transform Allegro5

 

al_get_current_transform Allegro5

 

al_get_default_menu_event_source al5nativedlg

Returns the default event source used for menu clicks.

al_get_default_mixer al5audio

 

al_get_default_shader_source Allegro5

Returns a string containing the source code to Allegro's default vertex or pixel shader appropriate for the passed platform.

al_get_default_voice al5audio

 

al_get_display_event_source Allegro5

Retrieve the associated event source.

al_get_display_flags Allegro5

Gets the flags of the display.

al_get_display_format Allegro5

Gets the pixel format of the display.

al_get_display_height Allegro5

 

al_get_display_menu al5nativedlg

Returns the menu associated with the display, or Nil if it does not have a menu.

al_get_display_mode Allegro5

Retrieves a fullscreen mode.

al_get_display_option Allegro5

 

al_get_display_orientation Allegro5

 

al_get_display_refresh_rate Allegro5

 

al_get_display_width Allegro5

 

al_get_errno Allegro5

Some Allegro functions will set an error number as well as returning an error code.

al_get_event_source_data Allegro5

 

al_get_file_userdata Allegro5

Returns a pointer to the custom userdata that is attached to the file handle.

al_get_first_config_entry Allegro5

Returns the name of the first key in the given section in the given config or Nil if the section is empty.

al_get_first_config_section Allegro5

Returns the name of the first section in the given config file.

al_get_font_ascent al5font

 

al_get_font_descent al5font

 

al_get_font_line_height al5font

 

al_get_font_ranges al5font

Gets information about all glyphs contained in a font, as a list of ranges.

al_get_glyph_advance al5font

 

al_get_index_buffer_size al5primitives

 

al_get_joystick Allegro5

 

al_get_joystick_active Allegro5

 

al_get_joystick_axis_name Allegro5

 

al_get_joystick_button_name Allegro5

 

al_get_joystick_event_source Allegro5

Retrieves the global joystick event source.

al_get_joystick_name Allegro5

 

al_get_joystick_num_axes Allegro5

 

al_get_joystick_num_buttons Allegro5

 

al_get_joystick_num_sticks Allegro5

 

al_get_joystick_state Allegro5

 

al_get_joystick_stick_flags Allegro5

 

al_get_joystick_stick_name Allegro5

 

al_get_keyboard_event_source Allegro5

Retrieve the keyboard event source.

al_get_keyboard_state Allegro5

Save the state of the keyboard specified at the time the function is called into the structure pointed to by ret_state.

al_get_menu_item_caption al5nativedlg

Returns the caption associated with the menu item.

al_get_menu_item_flags al5nativedlg

Returns the currently set flags.

al_get_menu_item_icon al5nativedlg

Returns the icon associated with the menu.

al_get_mixer_attached al5audio

 

al_get_mixer_channels al5audio

 

al_get_mixer_depth al5audio

 

al_get_mixer_frequency al5audio

 

al_get_mixer_gain al5audio

 

al_get_mixer_playing al5audio

 

al_get_mixer_quality al5audio

 

al_get_monitor_info Allegro5

 

al_get_mouse_cursor_position Allegro5

On platforms where this information is available, this function returns the global location of the mouse cursor, relative to the desktop.

al_get_mouse_event_source Allegro5

Retrieve the mouse event source.

al_get_mouse_num_axes Allegro5

Returns the number of axes on the mouse.

al_get_mouse_num_buttons Allegro5

Returns the number of buttons on the mouse.

al_get_mouse_state Allegro5

Saves the state of the mouse specified at the time the function is called into the given structure.

al_get_mouse_state_axis Allegro5

Extracts the mouse axis value from the saved state.

al_get_mouse_wheel_precision Allegro5

Gets the precision of the mouse wheel (the z and w coordinates).

al_get_native_file_dialog_count al5nativedlg

Returns the number of files selected, or 0 if the dialog was cancelled.

al_get_native_file_dialog_path al5nativedlg

Returns one of the selected paths with index i.

al_get_native_text_log_event_source al5nativedlg

Get an event source for a text log window.

al_get_new_bitmap_flags Allegro5

Returns the flags used for newly created bitmaps.

al_get_new_bitmap_format Allegro5

Returns the format used for newly created bitmaps.

al_get_new_display_adapter Allegro5

Stuff for multihead/window management

al_get_new_display_flags Allegro5

 

al_get_new_display_option Allegro5

 

al_get_new_display_refresh_rate Allegro5

 

al_get_new_file_interface Allegro5

Return a pointer to the ALLEGRO_FILE_INTERFACEptr table in effect for the calling thread.

al_get_new_window_position Allegro5

 

al_get_new_window_title Allegro5

 

al_get_next_config_entry Allegro5

Returns the next key for the iterator obtained by al_get_first_config_entry.

al_get_next_config_section Allegro5

Returns the name of the next section in the given config file or Nil if there are no more sections.

al_get_next_event Allegro5

Takes the next event out of the event queue specified, and copy the contents into ret_event, returning True.

al_get_num_display_modes Allegro5

 

al_get_num_joysticks Allegro5

 

al_get_num_video_adapters Allegro5

 

al_get_opengl_fbo al5opengl

 

al_get_opengl_proc_address al5opengl

Helper to get the address of an OpenGL symbol.

al_get_opengl_texture al5opengl

Returns the OpenGL texture id internally used by the given bitmap if it uses one, else 0.

al_get_opengl_texture_position al5opengl

 

al_get_opengl_texture_size al5opengl

 

al_get_opengl_variant al5opengl

 

al_get_opengl_version al5opengl

Returns the OpenGL or OpenGL ES version number of the client (the computer the program is running on), for the current display.

al_get_parent_bitmap Allegro5

Returns the bitmap this bitmap is a sub-bitmap of.

al_get_pixel Allegro5

Get a pixel's color value from the specified bitmap.

al_get_pixel_block_height Allegro5

Return the height of the pixel block of this format.

al_get_pixel_block_size Allegro5

Return the number of bytes that a block of pixels with this format occupies.

al_get_pixel_block_width Allegro5

Return the width of the pixel block of this format.

al_get_pixel_format_bits Allegro5

Return the number of bits that a pixel of the given format occupies.

al_get_pixel_size Allegro5

Return the number of bytes that a pixel of the given format occupies.

al_get_ram_size Allegro5

Returns the size in MB of the random access memory that the system Allegro is running on has and which could be detected, or a negative number if detection failed.

al_get_sample al5audio

 

al_get_sample_channels al5audio

 

al_get_sample_data al5audio

 

al_get_sample_depth al5audio

 

al_get_sample_frequency al5audio

 

al_get_sample_instance_attached al5audio

 

al_get_sample_instance_channels al5audio

 

al_get_sample_instance_depth al5audio

 

al_get_sample_instance_frequency al5audio

 

al_get_sample_instance_gain al5audio

 

al_get_sample_instance_length al5audio

 

al_get_sample_instance_pan al5audio

 

al_get_sample_instance_playing al5audio

 

al_get_sample_instance_playmode al5audio

 

al_get_sample_instance_position al5audio

 

al_get_sample_instance_speed al5audio

 

al_get_sample_instance_time al5audio

 

al_get_sample_length al5audio

 

al_get_separate_blender Allegro5

 

al_get_shader_log Allegro5

Return a read-only string containing the information log for a shader program.

al_get_shader_platform Allegro5

Returns the platform the shader was created with (either ALLEGRO_SHADER_HLSL or ALLEGRO_SHADER_GLSL).

al_get_target_bitmap Allegro5

Returns the target bitmap of the calling thread.

al_get_text_dimensions al5font

 

al_get_text_width al5font

 

al_get_time Allegro5

Returns the number of seconds since the Allegro library was initialised.

al_get_timer_count Allegro5

 

al_get_timer_event_source Allegro5

 

al_get_timer_speed Allegro5

 

al_get_timer_started Allegro5

 

al_get_ustr_dimensions al5font

 

al_get_ustr_width al5font

 

al_get_vertex_buffer_size al5primitives

 

al_get_voice_channels al5audio

 

al_get_voice_depth al5audio

 

al_get_voice_frequency al5audio

 

al_get_voice_playing al5audio

 

al_get_voice_position al5audio

 

al_get_window_constraints Allegro5

 

al_get_window_position Allegro5

 

al_grab_font_from_bitmap al5font

Creates a new font from an Allegro bitmap.

al_grab_mouse Allegro5

Confines the mouse cursor to the given display.

al_have_opengl_extension al5opengl

This function is a helper to determine whether an OpenGL extension is available on the given display or not.

al_hide_mouse_cursor Allegro5

Hide the mouse cursor in the given display.

al_hold_bitmap_drawing Allegro5

Deferred drawing

al_horizontal_shear_transform Allegro5

 

AL_ID Allegro5

This function can be used to create a packed 32 bit integer from 8 bit characters, on both 32 and 64 bit machines.

al_identify_bitmap Allegro5

This works exactly as al_identify_bitmap_f but you specify the filename of the file for which to detect the type and not a file handle.

al_identify_bitmap_f Allegro5

Tries to guess the bitmap file type of the given file by reading the first few bytes.

al_identity_transform Allegro5

 

al_inhibit_screensaver Allegro5

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.

al_init Allegro5

Like al_install_system, but automatically passes in the version and uses the atexit function visible in the current compilation unit.

al_init_acodec_addon al5acodec

Registers all the known audio file type handlers for al_load_sample, al_save_sample, al_load_audio_stream, etc.

al_init_font_addon al5font

Initialise the font addon.

al_init_image_addon al5image

Initializes the image addon.

al_init_native_dialog_addon al5nativedlg

Initialise the native dialog addon.

al_init_primitives_addon al5primitives

Initializes the primitives addon.

al_init_timeout Allegro5

Set timeout value of some number of seconds after the function call.

al_init_ttf_addon al5ttf

Initializes the TTF addon.

al_init_user_event_source Allegro5

Initialices an event source for emitting user events.

al_insert_menu_item al5nativedlg

Inserts a menu item at the spot specified.

al_install_audio al5audio

Install the audio subsystem.

al_install_joystick Allegro5

Install a joystick driver, returning True if successful.

al_install_keyboard Allegro5

Installs a keyboard driver.

al_install_mouse Allegro5

Installs mouse driver.

al_install_system Allegro5

Initializes the Allegro system.

al_invert_transform Allegro5

 

al_is_audio_installed al5audio

Returns True if al_install_audio was called previously and returned successfully.

al_is_bitmap_drawing_held Allegro5

 

al_is_bitmap_locked Allegro5

Returns whether or not a bitmap is already locked.

al_is_compatible_bitmap Allegro5

 

al_is_event_queue_empty Allegro5

 

al_is_event_queue_paused Allegro5

 

al_is_event_source_registered Allegro5

 

al_is_joystick_installed Allegro5

 

al_is_keyboard_installed Allegro5

Returns True if al_install_keyboard was called successfully.

al_is_mouse_installed Allegro5

Returns True if al_install_mouse was called successfully.

al_is_sub_bitmap Allegro5

Returns true if the specified bitmap is a sub-bitmap, false otherwise.

al_is_system_installed Allegro5

Returns True if Allegro is initialized, otherwise returns False.

al_keycode_to_name Allegro5

Converts the given keycode to a description of the key.

al_key_down Allegro5

Returns True if the key specified was held down in the state specified.

al_load_audio_stream al5audio

Loads an audio file from disk as it is needed.

al_load_bitmap Allegro5

Loads an image file into a new ALLEGRO_BITMAPptr.

al_load_bitmap_f Allegro5

Loads an image from an ALLEGRO_FILEptr stream into a new ALLEGRO_BITMAPptr.

al_load_bitmap_flags Allegro5

Loads an image file into a new ALLEGRO_BITMAPptr.

al_load_bitmap_flags_f Allegro5

Loads an image from an ALLEGRO_FILEptr stream into a new ALLEGRO_BITMAPptr.

al_load_bitmap_font al5font

Loads a bitmap font from a file.

al_load_bitmap_font_flags al5font

 

al_load_config_file Allegro5

Read a configuration file from disk.

al_load_config_file_f Allegro5

Read a configuration file from an already open file.

al_load_font al5font

Loads a font from disk.

al_load_sample al5audio

Loads a few different audio file formats based on their extension.

al_load_ttf_font al5ttf

 

al_load_ttf_font_stretch al5ttf

 

al_lock_bitmap Allegro5

Lock an entire bitmap for reading or writing.

al_lock_bitmap_blocked Allegro5

Like al_lock_bitmap, but allows locking bitmaps with a blocked pixel format (i.e.

al_lock_bitmap_region Allegro5

Like al_lock_bitmap, but only locks a specific area of the bitmap.

al_lock_bitmap_region_blocked Allegro5

Like al_lock_bitmap_blocked, but allows locking a sub-region, for performance.

al_lock_index_buffer al5primitives

 

al_lock_vertex_buffer al5primitives

 

al_malloc Allegro5

Like malloc in the C standard library, but the implementation may be overridden.

al_malloc_with_context Allegro5

This calls malloc from the Allegro library (this matters on Windows), unless overridden with al_set_memory_interface.

al_map_rgb Allegro5

Convert r, g, b (ranging from 0-255) into an ALLEGRO_COLOR, using 255 for alpha.

al_map_rgba Allegro5

Convert r, g, b, a (ranging from 0-255) into an ALLEGRO_COLOR.

al_map_rgba_f Allegro5

Convert r, g, b, a (ranging from 0.0f-1.0f) into an ALLEGRO_COLOR.

al_map_rgb_f Allegro5

Convert r, g, b (ranging from 0.0f-1.0f) into an ALLEGRO_COLOR, using 1.0f for alpha.

al_mouse_button_down Allegro5

Returns True if the mouse button specified was held down in the state specified.

al_open_native_text_log al5nativedlg

Opens a window to which you can append log messages with al_append_native_text_log.

al_orthographic_transform Allegro5

 

al_pause_event_queue Allegro5

 

al_peek_next_event Allegro5

 

al_perspective_transform Allegro5

 

al_play_sample al5audio

Plays a sample on one of the sample instances created by al_reserve_samples.

al_play_sample_instance al5audio

 

al_popup_menu al5nativedlg

Displays a context menu next to the mouse cursor.

al_premul_rgba Allegro5

This is a shortcut for al_map_rgba (r * a / 255, g * a / 255, b * a / 255, a).

al_premul_rgba_f Allegro5

This is a shortcut for al_map_rgba (r * a, g * a, b * a, a).

al_put_blended_pixel Allegro5

Like al_put_pixel, but the pixel color is blended using the current blenders before being drawn.

al_put_pixel Allegro5

Draws a single pixel on the target bitmap.

al_realloc Allegro5

Like realloc in the C standard library, but the implementation may be overridden.

al_realloc_with_context Allegro5

This calls realloc from the Allegro library (this matters on Windows), unless overridden with al_set_memory_interface.

al_reconfigure_joysticks Allegro5

 

al_ref_buffer Allegro5

 

al_ref_cstr Allegro5

Create a string that references the storage of a C-style string.

al_ref_ustr Allegro5

 

al_register_bitmap_identifier Allegro5

Registers an identify handler for al_identify_bitmap.

al_register_bitmap_loader Allegro5

Registers a handler for al_load_bitmap.

al_register_bitmap_loader_f Allegro5

Registers a handler for al_load_bitmap_f.

al_register_bitmap_saver Allegro5

Registers a handler for al_save_bitmap.

al_register_bitmap_saver_f Allegro5

Registers a handler for al_save_bitmap_f.

al_register_event_source Allegro5

Register the event source with the event queue specified.

al_release_joystick Allegro5

 

al_remove_config_key Allegro5

Removes a key and its associated value in a section of a configuration.

al_remove_config_section Allegro5

Removes a section of a configuration.

al_remove_display_menu al5nativedlg

Detaches the menu associated with the display and returns it.

al_remove_menu_item al5nativedlg

Removes the specified item from the menu and destroys it.

al_remove_opengl_fbo al5opengl

 

al_reparent_bitmap Allegro5

For a sub-bitmap, changes the parent, position and size.

al_reserve_samples al5audio

Reserves a number of sample instances, attaching them to the default mixer.

al_reset_clipping_rectangle Allegro5

Equivalent to calling al_set_clipping_rectangle (0, 0, w, h) where w and h are the width and height of the target bitmap respectively.

al_reset_new_display_options Allegro5

 

al_resize_display Allegro5

 

al_rest Allegro5

Waits for the specified number of seconds.

al_restore_default_mixer al5audio

 

al_restore_memory_interface Allegro5

Restores the default behavior of the memory management functions.

al_restore_state Allegro5

Restores part of the state of the current thread from the given ALLEGRO_STATE object.

al_resume_timer Allegro5

 

al_rewind_audio_stream al5audio

 

al_rotate_transform Allegro5

 

al_rotate_transform_3d Allegro5

 

al_run_main Allegro5

This function is useful in cases where you don't have a main function but want to run Allegro (mostly useful in a wrapper library).

al_save_bitmap Allegro5

Saves an ALLEGRO_BITMAP to an image file.

al_save_bitmap_f Allegro5

Saves an ALLEGRO_BITMAP to an ALLEGRO_FILE stream.

al_save_config_file Allegro5

Write out a configuration file to disk.

al_save_config_file_f Allegro5

Write out a configuration file to an already open file.

al_save_sample al5audio

 

al_scale_transform Allegro5

 

al_scale_transform_3D Allegro5

 

al_seek_audio_stream_secs al5audio

 

al_set_audio_stream_fragment al5audio

 

al_set_audio_stream_gain al5audio

 

al_set_audio_stream_loop_secs al5audio

 

al_set_audio_stream_pan al5audio

 

al_set_audio_stream_playing al5audio

 

al_set_audio_stream_playmode al5audio

 

al_set_audio_stream_speed al5audio

 

al_set_blender Allegro5

Sets the function to use for blending for the current thread.

al_set_blend_color Allegro5

Sets the color to use for blending when using the ALLEGRO_CONST_COLOR or ALLEGRO_INVERSE_CONST_COLOR blend functions.

al_set_clipboard_text Allegro5

 

al_set_clipping_rectangle Allegro5

Sets the region of the target bitmap or display that pixels get clipped to.

al_set_config_value Allegro5

Sets a value in a section of a configuration.

al_set_current_opengl_context al5opengl

TODO: al_get_opengl_program_object, when shaders are implemented.

al_set_default_mixer al5audio

 

al_set_default_voice al5audio

 

al_set_display_flag Allegro5

Enable or disable one of the display flags.

al_set_display_icon Allegro5

 

al_set_display_icons Allegro5

 

al_set_display_menu al5nativedlg

Associates the menu with the display and shows it.

al_set_display_option Allegro5

 

al_set_errno Allegro5

Sets the error number for the calling thread.

al_set_event_source_data Allegro5

 

al_set_keyboard_leds Allegro5

Overrides the state of the keyboard LED indicators.

al_set_memory_interface Allegro5

Overrides the memory management functions with implementations of al_malloc_with_context, al_free_with_context, al_realloc_with_context and al_calloc_with_context.

al_set_menu_item_caption al5nativedlg

Updates the menu item caption with the new caption.

al_set_menu_item_flags al5nativedlg

Updates the menu item's flags.

al_set_menu_item_icon al5nativedlg

Sets the icon for the specified menu item.

al_set_mixer_frequency al5audio

 

al_set_mixer_gain al5audio

 

al_set_mixer_playing al5audio

 

al_set_mixer_postprocess_callback al5audio

 

al_set_mixer_quality al5audio

 

al_set_mouse_axis Allegro5

Sets the given mouse axis to the given value.

al_set_mouse_cursor Allegro5

Sets the given mouse cursor to be the current mouse cursor for the given display.

al_set_mouse_w Allegro5

Sets the second mouse wheel position to the given value.

al_set_mouse_wheel_precision Allegro5

Sets the precision of the mouse wheel (the z and w coordinates).

al_set_mouse_xy Allegro5

Tryes to position the mouse at the given coordinates on the given display.

al_set_mouse_z Allegro5

Sets the mouse wheel position to the given value.

al_set_new_bitmap_flags Allegro5

Sets the flags to use for newly created bitmaps.

al_set_new_bitmap_format Allegro5

Sets the pixel format for newly created bitmaps.

al_set_new_display_adapter Allegro5

 

al_set_new_display_flags Allegro5

Sets various flags to be used when creating new displays on the calling thread.

al_set_new_display_option Allegro5

Set an extra display option, to be used when creating new displays on the calling thread.

al_set_new_display_refresh_rate Allegro5

 

al_set_new_file_interface Allegro5

Sets the ALLEGRO_FILE_INTERFACEptr table for the calling thread.

al_set_new_window_position Allegro5

 

al_set_new_window_title Allegro5

 

al_set_render_state Allegro5

Set one of several render attributes.

al_set_sample al5audio

 

al_set_sample_instance_gain al5audio

 

al_set_sample_instance_length al5audio

 

al_set_sample_instance_pan al5audio

 

al_set_sample_instance_playing al5audio

 

al_set_sample_instance_playmode al5audio

 

al_set_sample_instance_position al5audio

 

al_set_sample_instance_speed al5audio

 

al_set_separate_blender Allegro5

Like al_set_blender, but allows specifying a separate blending operation for the alpha channel.

al_set_shader_bool Allegro5

Sets a boolean uniform of the current target bitmap's shader.

al_set_shader_float Allegro5

Sets a float uniform of the current target bitmap's shader.

al_set_shader_float_vector Allegro5

Same as al_set_shader_int_vector except all values are float instead of intteger.

al_set_shader_int Allegro5

Sets an integer uniform of the current target bitmap's shader.

al_set_shader_int_vector Allegro5

Sets an integer vector array uniform of the current target bitmap's shader.

al_set_shader_matrix Allegro5

Sets a matrix uniform of the current target bitmap's shader.

al_set_shader_sampler Allegro5

Sets a texture sampler uniform and texture unit of the current target bitmap's shader.

al_set_standard_file_interface Allegro5

Sets the ALLEGRO_FILE_INTERFACEptr table to the default, for the calling thread.

al_set_system_mouse_cursor Allegro5

Sets the given system mouse cursor to be the current mouse cursor for the given display.

al_set_target_backbuffer Allegro5

Same as al_set_target_bitmap(al_get_backbuffer(display));.

al_set_target_bitmap Allegro5

This function selects the bitmap to which all subsequent drawing operations in the calling thread will draw to.

al_set_timer_count Allegro5

 

al_set_timer_speed Allegro5

 

al_set_voice_playing al5audio

 

al_set_voice_position al5audio

 

al_set_window_constraints Allegro5

 

al_set_window_position Allegro5

 

al_set_window_title Allegro5

 

al_show_mouse_cursor Allegro5

Make a mouse cursor visible in the given display.

al_show_native_file_dialog al5nativedlg

Shows the dialog window.

al_show_native_message_box al5nativedlg

Shows a native GUI message box.

al_shutdown_font_addon al5font

 

al_shutdown_image_addon al5image

Shuts down the image addon.

al_shutdown_native_dialog_addon al5nativedlg

Shut down the native dialog addon.

al_shutdown_primitives_addon al5primitives

Shut down the primitives addon.

al_shutdown_ttf_addon al5ttf

Shuts down the TTF addon.

al_start_timer Allegro5

Starts the timer specified.

al_stop_sample al5audio

 

al_stop_samples al5audio

 

al_stop_sample_instance al5audio

 

al_stop_timer Allegro5

 

al_store_state Allegro5

Stores part of the state of the current thread in the given ALLEGRO_STATE object.

al_toggle_display_flag Allegro5

 

al_transform_coordinates Allegro5

 

al_transform_coordinates_3d Allegro5

 

al_translate_transform Allegro5

 

al_translate_transform_3d Allegro5

 

al_triangulate_polygon al5primitives

 

al_ungrab_mouse Allegro5

Stop confining the mouse cursor to any display belonging to the program.

al_uninstall_audio al5audio

Uninstall the audio subsystem.

al_uninstall_joystick Allegro5

 

al_uninstall_keyboard Allegro5

Uninstalls the active keyboard driver, if any.

al_uninstall_mouse Allegro5

Uninstalls the active mouse driver, if any.

al_uninstall_system Allegro5

Closes down the Allegro system.

al_unlock_bitmap Allegro5

Unlock a previously locked bitmap or bitmap region.

al_unlock_index_buffer al5primitives

 

al_unlock_vertex_buffer al5primitives

 

al_unmap_rgb Allegro5

Retrieves components of an ALLEGRO_COLOR, ignoring alpha.

al_unmap_rgba Allegro5

Retrieves components of an ALLEGRO_COLOR.

al_unmap_rgba_f Allegro5

Retrieves components of an ALLEGRO_COLOR.

al_unmap_rgb_f Allegro5

Retrieves components of an ALLEGRO_COLOR, ignoring alpha.

al_unref_user_event Allegro5

 

al_unregister_event_source Allegro5

 

al_update_display_region Allegro5

 

al_use_projection_transform Allegro5

 

al_use_shader Allegro5

Uses the shader for subsequent drawing operations on the current target bitmap.

al_use_transform Allegro5

Transformations

al_ustr_assign Allegro5

Assign

al_ustr_assign_cstr Allegro5

 

al_ustr_compare Allegro5

 

al_ustr_dup Allegro5

Returns a duplicate copy of a string.

al_ustr_dup_substr Allegro5

Return a new copy of a string, containing its contents in the byte interval [start_pos, end_pos).

al_ustr_empty_string Allegro5

Predefined string

al_ustr_equal Allegro5

Compare

al_ustr_free Allegro5

Frees a previously allocated string.

al_ustr_length Allegro5

 

al_ustr_ncompare Allegro5

 

al_ustr_new Allegro5

Creates a new string containing a copy of the C-style string s.

al_ustr_new_from_buffer Allegro5

Creates a new string containing a copy of the buffer pointed to by s of the given size in bytes.

al_ustr_next Allegro5

Find the byte offset of the next code point in string, beginning at aPos.

al_ustr_offset Allegro5

 

al_ustr_prev Allegro5

Find the byte offset of the previous code point in string, before aPos.

al_ustr_size Allegro5

Sizes and offsets

al_ustr_to_buffer Allegro5

Writes the contents of the string into a pre-allocated buffer of the given size in bytes.

al_vertical_shear_transform Allegro5

 

al_wait_for_event Allegro5

Wait until the event queue specified is non-empty.

al_wait_for_event_timed Allegro5

 

al_wait_for_event_until Allegro5

 

al_wait_for_vsync Allegro5

Wait for the beginning of a vertical retrace.


Generated by PasDoc 0.14.0. Generated on 2017-01-03 17:39:12.