Allegro MAnual

User Manual:

Open the PDF directly: View PDF .
Page Count: 385 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Scroll down to view the document on your mobile browser.

Contents
Getting started guide
- Introduction
- Structure of the library and its addons
- The main function
- Initialisation
- Opening a window
- Display an image
- Changing the drawing target
- Event queues and input
- Displaying some text
- Drawing primitives
- Blending
- Sound
- Unstable API
- Not the end
Configuration files
- ALLEGRO_CONFIG
- ALLEGRO_CONFIG_SECTION
- ALLEGRO_CONFIG_ENTRY
- al_create_config
- al_destroy_config
- al_load_config_file
- al_load_config_file_f
- al_save_config_file
- al_save_config_file_f
- al_add_config_section
- al_remove_config_section
- al_add_config_comment
- al_get_config_value
- al_set_config_value
- al_remove_config_key
- al_get_first_config_section
- al_get_next_config_section
- al_get_first_config_entry
- al_get_next_config_entry
- al_merge_config
- al_merge_config_into
Displays
- Display creation
- Display operations
- Display size and position
- Display settings
- Drawing halts
  - al_acknowledge_drawing_halt
  - al_acknowledge_drawing_resume
- Screensaver
  - al_inhibit_screensaver
- Clipboard
Event system and events
- ALLEGRO_EVENT
  - ALLEGRO_EVENT_JOYSTICK_AXIS
  - ALLEGRO_EVENT_JOYSTICK_BUTTON_DOWN
  - ALLEGRO_EVENT_JOYSTICK_BUTTON_UP
  - ALLEGRO_EVENT_JOYSTICK_CONFIGURATION
  - ALLEGRO_EVENT_KEY_DOWN
  - ALLEGRO_EVENT_KEY_UP
  - ALLEGRO_EVENT_KEY_CHAR
  - ALLEGRO_EVENT_MOUSE_AXES
  - ALLEGRO_EVENT_MOUSE_BUTTON_DOWN
  - ALLEGRO_EVENT_MOUSE_BUTTON_UP
  - ALLEGRO_EVENT_MOUSE_WARPED
  - ALLEGRO_EVENT_MOUSE_ENTER_DISPLAY
  - ALLEGRO_EVENT_MOUSE_LEAVE_DISPLAY
  - ALLEGRO_EVENT_TOUCH_BEGIN
  - ALLEGRO_EVENT_TOUCH_END
  - ALLEGRO_EVENT_TOUCH_MOVE
  - ALLEGRO_EVENT_TOUCH_CANCEL
  - ALLEGRO_EVENT_TIMER
  - ALLEGRO_EVENT_DISPLAY_EXPOSE
  - ALLEGRO_EVENT_DISPLAY_RESIZE
  - ALLEGRO_EVENT_DISPLAY_CLOSE
  - ALLEGRO_EVENT_DISPLAY_LOST
  - ALLEGRO_EVENT_DISPLAY_FOUND
  - ALLEGRO_EVENT_DISPLAY_SWITCH_OUT
  - ALLEGRO_EVENT_DISPLAY_SWITCH_IN
  - ALLEGRO_EVENT_DISPLAY_ORIENTATION
  - ALLEGRO_EVENT_DISPLAY_HALT_DRAWING
  - ALLEGRO_EVENT_DISPLAY_RESUME_DRAWING
  - ALLEGRO_EVENT_DISPLAY_CONNECTED
  - ALLEGRO_EVENT_DISPLAY_DISCONNECTED
- ALLEGRO_USER_EVENT
- ALLEGRO_EVENT_QUEUE
- ALLEGRO_EVENT_SOURCE
- ALLEGRO_EVENT_TYPE
- ALLEGRO_GET_EVENT_TYPE
- ALLEGRO_EVENT_TYPE_IS_USER
- al_create_event_queue
- al_destroy_event_queue
- al_register_event_source
- al_unregister_event_source
- al_is_event_source_registered
- al_pause_event_queue
- al_is_event_queue_paused
- al_is_event_queue_empty
- al_get_next_event
- al_peek_next_event
- al_drop_next_event
- al_flush_event_queue
- al_wait_for_event
- al_wait_for_event_timed
- al_wait_for_event_until
- al_init_user_event_source
- al_destroy_user_event_source
- al_emit_user_event
- al_unref_user_event
- al_get_event_source_data
- al_set_event_source_data
File I/O
- ALLEGRO_FILE
- ALLEGRO_FILE_INTERFACE
- ALLEGRO_SEEK
- al_fopen
- al_fopen_interface
- al_fopen_slice
- al_fclose
- al_fread
- al_fwrite
- al_fflush
- al_ftell
- al_fseek
- al_feof
- al_ferror
- al_ferrmsg
- al_fclearerr
- al_fungetc
- al_fsize
- al_fgetc
- al_fputc
- al_fprintf
- al_vfprintf
- al_fread16le
- al_fread16be
- al_fwrite16le
- al_fwrite16be
- al_fread32le
- al_fread32be
- al_fwrite32le
- al_fwrite32be
- al_fgets
- al_fget_ustr
- al_fputs
- Standard I/O specific routines
  - al_fopen_fd
  - al_make_temp_file
- Alternative file streams
  - al_set_new_file_interface
  - al_set_standard_file_interface
  - al_get_new_file_interface
  - al_create_file_handle
  - al_get_file_userdata
Fixed point math routines
- al_fixed
- al_itofix
- al_fixtoi
- al_fixfloor
- al_fixceil
- al_ftofix
- al_fixtof
- al_fixmul
- al_fixdiv
- al_fixadd
- al_fixsub
- Fixed point trig
File system routines
- ALLEGRO_FS_ENTRY
- ALLEGRO_FILE_MODE
- al_create_fs_entry
- al_destroy_fs_entry
- al_get_fs_entry_name
- al_update_fs_entry
- al_get_fs_entry_mode
- al_get_fs_entry_atime
- al_get_fs_entry_ctime
- al_get_fs_entry_mtime
- al_get_fs_entry_size
- al_fs_entry_exists
- al_remove_fs_entry
- al_filename_exists
- al_remove_filename
- Directory functions
- Alternative filesystem functions
Fullscreen modes
- ALLEGRO_DISPLAY_MODE
- al_get_display_mode
- al_get_num_display_modes
Graphics routines
- Colors
- Locking and pixel formats
- Bitmap creation
- Bitmap properties
- Drawing operations
- Target bitmap
- Blending modes
- Clipping
- Graphics utility functions
  - al_convert_mask_to_alpha
- Deferred drawing
  - al_hold_bitmap_drawing
  - al_is_bitmap_drawing_held
- Image I/O
- Render State
Haptic routines
- ALLEGRO_HAPTIC
- ALLEGRO_HAPTIC_CONSTANTS
- ALLEGRO_HAPTIC_EFFECT
- ALLEGRO_HAPTIC_EFFECT_ID
- al_install_haptic
- al_uninstall_haptic
- al_is_haptic_installed
- al_is_mouse_haptic
- al_is_keyboard_haptic
- al_is_display_haptic
- al_is_joystick_haptic
- al_is_touch_input_haptic
- al_get_haptic_from_mouse
- al_get_haptic_from_keyboard
- al_get_haptic_from_display
- al_get_haptic_from_joystick
- al_get_haptic_from_touch_input
- al_release_haptic
- al_is_haptic_active
- al_get_haptic_capabilities
- al_is_haptic_capable
- al_set_haptic_gain
- al_get_haptic_gain
- al_set_haptic_autocenter
- al_get_haptic_autocenter
- al_get_max_haptic_effects
- al_is_haptic_effect_ok
- al_upload_haptic_effect
- al_play_haptic_effect
- al_upload_and_play_haptic_effect
- al_stop_haptic_effect
- al_is_haptic_effect_playing
- al_get_haptic_effect_duration
- al_release_haptic_effect
- al_rumble_haptic
Joystick routines
- ALLEGRO_JOYSTICK
- ALLEGRO_JOYSTICK_STATE
- ALLEGRO_JOYFLAGS
- al_install_joystick
- al_uninstall_joystick
- al_is_joystick_installed
- al_reconfigure_joysticks
- al_get_num_joysticks
- al_get_joystick
- al_release_joystick
- al_get_joystick_active
- al_get_joystick_name
- al_get_joystick_stick_name
- al_get_joystick_axis_name
- al_get_joystick_button_name
- al_get_joystick_stick_flags
- al_get_joystick_num_sticks
- al_get_joystick_num_axes
- al_get_joystick_num_buttons
- al_get_joystick_state
- al_get_joystick_event_source
Keyboard routines
- ALLEGRO_KEYBOARD_STATE
- Key codes
- Keyboard modifier flags
- al_install_keyboard
- al_is_keyboard_installed
- al_uninstall_keyboard
- al_get_keyboard_state
- al_clear_keyboard_state
- al_key_down
- al_keycode_to_name
- al_set_keyboard_leds
- al_get_keyboard_event_source
Memory management routines
- al_malloc
- al_free
- al_realloc
- al_calloc
- al_malloc_with_context
- al_free_with_context
- al_realloc_with_context
- al_calloc_with_context
- ALLEGRO_MEMORY_INTERFACE
- al_set_memory_interface
Miscellaneous routines
- ALLEGRO_PI
- al_run_main
Monitors
- ALLEGRO_MONITOR_INFO
- al_get_new_display_adapter
- al_set_new_display_adapter
- al_get_monitor_info
- al_get_num_video_adapters
Mouse routines
- ALLEGRO_MOUSE_STATE
- al_install_mouse
- al_is_mouse_installed
- al_uninstall_mouse
- al_get_mouse_num_axes
- al_get_mouse_num_buttons
- al_get_mouse_state
- al_get_mouse_state_axis
- al_mouse_button_down
- al_set_mouse_xy
- al_set_mouse_z
- al_set_mouse_w
- al_set_mouse_axis
- al_get_mouse_event_source
- al_set_mouse_wheel_precision
- al_get_mouse_wheel_precision
- Mouse cursors
Path structures
- al_create_path
- al_create_path_for_directory
- al_destroy_path
- al_clone_path
- al_join_paths
- al_rebase_path
- al_get_path_drive
- al_get_path_num_components
- al_get_path_component
- al_get_path_tail
- al_get_path_filename
- al_get_path_basename
- al_get_path_extension
- al_set_path_drive
- al_append_path_component
- al_insert_path_component
- al_replace_path_component
- al_remove_path_component
- al_drop_path_tail
- al_set_path_filename
- al_set_path_extension
- al_path_cstr
- al_path_ustr
- al_make_path_canonical
State
- ALLEGRO_STATE
- ALLEGRO_STATE_FLAGS
- al_restore_state
- al_store_state
- al_get_errno
- al_set_errno
System routines
- al_install_system
- al_init
- al_uninstall_system
- al_is_system_installed
- al_get_allegro_version
- al_get_standard_path
- al_set_exe_name
- al_set_app_name
- al_set_org_name
- al_get_app_name
- al_get_org_name
- al_get_system_config
- al_register_assert_handler
- al_register_trace_handler
- al_get_cpu_count
- al_get_ram_size
Threads
- ALLEGRO_THREAD
- ALLEGRO_MUTEX
- ALLEGRO_COND
- al_create_thread
- al_start_thread
- al_join_thread
- al_set_thread_should_stop
- al_get_thread_should_stop
- al_destroy_thread
- al_run_detached_thread
- al_create_mutex
- al_create_mutex_recursive
- al_lock_mutex
- al_unlock_mutex
- al_destroy_mutex
- al_create_cond
- al_destroy_cond
- al_wait_cond
- al_wait_cond_until
- al_broadcast_cond
- al_signal_cond
Time routines
- ALLEGRO_TIMEOUT
- al_get_time
- al_init_timeout
- al_rest
Timer routines
- ALLEGRO_TIMER
- ALLEGRO_USECS_TO_SECS
- ALLEGRO_MSECS_TO_SECS
- ALLEGRO_BPS_TO_SECS
- ALLEGRO_BPM_TO_SECS
- al_create_timer
- al_start_timer
- al_resume_timer
- al_stop_timer
- al_get_timer_started
- al_destroy_timer
- al_get_timer_count
- al_set_timer_count
- al_add_timer_count
- al_get_timer_speed
- al_set_timer_speed
- al_get_timer_event_source
Touch input
- ALLEGRO_TOUCH_INPUT
- ALLEGRO_TOUCH_INPUT_MAX_TOUCH_COUNT
- ALLEGRO_TOUCH_STATE
- ALLEGRO_TOUCH_INPUT_STATE
- ALLEGRO_MOUSE_EMULATION_MODE
- al_install_touch_input
- al_uninstall_touch_input
- al_is_touch_input_installed
- al_get_touch_input_state
- al_set_mouse_emulation_mode
- al_get_mouse_emulation_mode
- al_get_touch_input_event_source
- al_get_touch_input_mouse_emulation_event_source
Transformations
- ALLEGRO_TRANSFORM
- al_copy_transform
- al_use_transform
- al_get_current_transform
- al_use_projection_transform
- al_get_current_projection_transform
- al_get_current_inverse_transform
- al_invert_transform
- al_check_inverse
- al_identity_transform
- al_build_transform
- al_build_camera_transform
- al_translate_transform
- al_rotate_transform
- al_scale_transform
- al_transform_coordinates
- al_transform_coordinates_3d
- al_transform_coordinates_4d
- al_transform_coordinates_3d_projective
- al_compose_transform
- al_orthographic_transform
- al_perspective_transform
- al_translate_transform_3d
- al_scale_transform_3d
- al_rotate_transform_3d
- al_horizontal_shear_transform
- al_vertical_shear_transform
UTF-8 string routines
- About UTF-8 string routines
- UTF-8 string types
  - ALLEGRO_USTR
  - ALLEGRO_USTR_INFO
- Creating and destroying strings
- Predefined strings
  - al_ustr_empty_string
- Creating strings by referencing other data
- Sizes and offsets
- Getting code points
- Inserting into strings
- Appending to strings
- Removing parts of strings
- Assigning one string to another
- Replacing parts of string
  - al_ustr_set_chr
  - al_ustr_replace_range
- Searching
- Comparing
- UTF-16 conversion
- Low-level UTF-8 routines
  - al_utf8_width
  - al_utf8_encode
- Low-level UTF-16 routines
  - al_utf16_width
  - al_utf16_encode
Platform-specific functions
- Windows
- Mac OS X
  - al_osx_get_window
- iPhone
- Android
- X11
  - al_get_x_window_id
  - al_x_set_initial_icon
Direct3D integration
- al_get_d3d_device
- al_get_d3d_system_texture
- al_get_d3d_video_texture
- al_have_d3d_non_pow2_texture_support
- al_have_d3d_non_square_texture_support
- al_get_d3d_texture_size
- al_get_d3d_texture_position
- al_is_d3d_device_lost
- al_set_d3d_device_release_callback
- al_set_d3d_device_restore_callback
OpenGL integration
- al_get_opengl_extension_list
- al_get_opengl_proc_address
- al_get_opengl_texture
- al_get_opengl_texture_size
- al_get_opengl_texture_position
- al_get_opengl_program_object
- al_get_opengl_fbo
- al_remove_opengl_fbo
- al_have_opengl_extension
- al_get_opengl_version
- al_get_opengl_variant
- al_set_current_opengl_context
- OpenGL configuration
Audio addon
- Audio types
- Setting up audio
- Misc audio functions
- Voice functions
- Sample functions
- Sample instance functions
- Mixer functions
- Stream functions
- Audio file I/O
- Audio recording
Audio codecs addon
- al_init_acodec_addon
- al_get_allegro_acodec_version
Color addon
- al_color_cmyk
- al_color_cmyk_to_rgb
- al_color_hsl
- al_color_hsl_to_rgb
- al_color_hsv
- al_color_hsv_to_rgb
- al_color_html
- al_color_html_to_rgb
- al_color_rgb_to_html
- al_color_name
- al_color_name_to_rgb
- al_color_rgb_to_cmyk
- al_color_rgb_to_hsl
- al_color_rgb_to_hsv
- al_color_rgb_to_name
- al_color_rgb_to_xyz
- al_color_xyz
- al_color_xyz_to_rgb
- al_color_rgb_to_xyy
- al_color_xyy
- al_color_xyy_to_rgb
- al_color_rgb_to_lab
- al_color_lab
- al_color_lab_to_rgb
- al_color_rgb_to_lch
- al_color_lch
- al_color_lch_to_rgb
- al_color_distance_ciede2000_lab
- al_color_rgb_to_yuv
- al_color_yuv
- al_color_yuv_to_rgb
- al_get_allegro_color_version
- al_is_color_valid
Font addons
- General font routines
- Per glyph text handling
- Multiline text drawing
- Bitmap fonts
- TTF fonts
Image I/O addon
- al_init_image_addon
- al_shutdown_image_addon
- al_get_allegro_image_version
Main addon
Memfile interface
- al_open_memfile
- al_get_allegro_memfile_version
Native dialogs support
- ALLEGRO_FILECHOOSER
- ALLEGRO_TEXTLOG
- al_init_native_dialog_addon
- al_shutdown_native_dialog_addon
- al_create_native_file_dialog
- al_show_native_file_dialog
- al_get_native_file_dialog_count
- al_get_native_file_dialog_path
- al_destroy_native_file_dialog
- al_show_native_message_box
- al_open_native_text_log
- al_close_native_text_log
- al_append_native_text_log
- al_get_native_text_log_event_source
- al_get_allegro_native_dialog_version
- Menus
PhysicsFS integration
- al_set_physfs_file_interface
- al_get_allegro_physfs_version
Primitives addon
- General
- High level drawing routines
- Low level drawing routines
- Custom vertex declaration routines
  - al_create_vertex_decl
  - al_destroy_vertex_decl
- Vertex buffer routines
- Index buffer routines
- Polygon routines
- Structures and types
Shader routines
- ALLEGRO_SHADER
- ALLEGRO_SHADER_TYPE
- ALLEGRO_SHADER_PLATFORM
- al_create_shader
- al_attach_shader_source
- al_attach_shader_source_file
- al_build_shader
- al_get_shader_log
- al_get_shader_platform
- al_use_shader
- al_destroy_shader
- al_set_shader_sampler
- al_set_shader_matrix
- al_set_shader_int
- al_set_shader_float
- al_set_shader_bool
- al_set_shader_int_vector
- al_set_shader_float_vector
- al_get_default_shader_source
Video streaming addon
- ALLEGRO_VIDEO_EVENT_TYPE
  - ALLEGRO_EVENT_VIDEO_FRAME_SHOW
  - ALLEGRO_EVENT_VIDEO_FINISHED
- ALLEGRO_VIDEO_POSITION_TYPE
- al_init_video_addon
- al_shutdown_video_addon
- al_get_allegro_video_version
- al_open_video
- al_close_video
- al_start_video
- al_start_video_with_voice
- al_get_video_event_source
- al_set_video_playing
- al_is_video_playing
- al_get_video_audio_rate
- al_get_video_fps
- al_get_video_scaled_width
- al_get_video_scaled_height
- al_get_video_frame
- al_get_video_position
- al_seek_video

Navigation menu