Allegro Manual: Index

# Index

# A

- ALLEGRO_DATE — Defined to a number with the release date of Allegro.
- ALLEGRO_DATE_STR — Defined to a string with the year Allegro was released.
- ALLEGRO_SUB_VERSION — Defined to the middle version of Allegro.
- ALLEGRO_VERSION — Defined to the major version of Allegro.
- ALLEGRO_VERSION_STR — Defined to a string with the full Allegro version number.
- ALLEGRO_WIP_VERSION — Defined to the minor version of Allegro.
- AL_ID — Converts four 8 bit values to a packed 32 bit integer ID.
- ASSERT — Debugging helper macro to assert.
- AUDIOSTREAM — Stores an audiostream.

# B

- BITMAP — Stores the contents of a bitmap.

# C

- COLOR_MAP — Stores a color map to accelerate drawing.
- COMPILED_SPRITE — Stores the contents of a compiled sprite.

# D

- DATAFILE — Stores an Allegro datafile in memory.
- DAT_ID — Makes an ID value from four letters.
- DIALOG — Stores a GUI description.
- DIALOG_PLAYER — Stores GUI data internally used by Allegro.
- DIGI_*/BeOS — Supported BeOS digital sound drivers.
- DIGI_*/DOS — Supported DOS digital sound drivers.
- DIGI_*/MacOSX — Supported MacOSX digital sound drivers.
- DIGI_*/QNX — Supported QNX digital sound drivers.
- DIGI_*/Unix — Supported Unix digital sound drivers.
- DIGI_*/Windows — Supported Windows digital sound drivers.

# E

- END_OF_FUNCTION — Locks the code used by a timer.
- END_OF_MAIN — Macro to put after your main() function.

# F

- FONT — Stores an Allegro font.

# G

- GFX_*/BeOS — Supported BeOS graphic drivers.
- GFX_*/DOS — Supported DOS graphic drivers.
- GFX_*/Linux — Supported Linux console graphic drivers.
- GFX_*/MacOSX — Supported MacOSX graphic drivers.
- GFX_*/QNX — Supported QNX graphic drivers.
- GFX_*/Windows — Supported Windows graphic drivers.
- GFX_*/X — Supported X graphic drivers.
- GFX_MODE — Stores video mode information.
- GFX_MODE_LIST — Stores an array of GFX_MODE structures.

# J

- JOYSTICK_AXIS_INFO — Stores joystick axis information.
- JOYSTICK_BUTTON_INFO — Stores joystick button information.
- JOYSTICK_INFO — Stores information about joysticks.
- JOYSTICK_STICK_INFO — Stores joystick stick information.
- JOY_TYPE_*/DOS — Supported DOS joystick drivers.
- JOY_TYPE_*/Linux — Supported Linux joystick drivers.
- JOY_TYPE_*/Windows — Supported Windows joystick drivers.

# L

- LOCK_FUNCTION — Locks the memory of a function used by a timer.
- LOCK_VARIABLE — Locks the memory of a variable used by a timer.
- LZSS_PACK_DATA — Opaque structure for handling LZSS compression.
- LZSS_UNPACK_DATA — Opaque structure for handling LZSS decompression.

# M

- MAKE_VERSION — Create a 32 bit integer from the Allegro version
- MASK_COLOR_15 — Constant representing the mask value in sprites.
- MASK_COLOR_16 — Constant representing the mask value in sprites.
- MASK_COLOR_24 — Constant representing the mask value in sprites.
- MASK_COLOR_32 — Constant representing the mask value in sprites.
- MASK_COLOR_8 — Constant representing the mask value in sprites.
- MATRIX — Fixed point matrix structure.
- MATRIX_f — Floating point matrix structure.
- MENU — Stores the entries of a menu.
- MENU_PLAYER — Stores GUI data internally used by Allegro.
- MIDI — Stores MIDI data.
- MIDI_*/BeOS — Supported BeOS MIDI sound drivers.
- MIDI_*/DOS — Supported DOS MIDI sound drivers.
- MIDI_*/MacOSX — Supported MacOSX MIDI sound drivers.
- MIDI_*/QNX — Supported QNX MIDI sound drivers.
- MIDI_*/Unix — Supported Unix MIDI sound drivers.
- MIDI_*/Windows — Supported Windows MIDI sound drivers.

# P

- PACKFILE — Packfile structure, similar to the libc FILE structure.
- PACKFILE_VTABLE — Packfile vtable structure, for custom packfiles.
- PALETTE — Stores palette information.
- PAL_SIZE — Number of entries in a palette.
- POLYTYPE_ATEX — Polygon rendering mode type
- POLYTYPE_ATEX_LIT — Polygon rendering mode type
- POLYTYPE_ATEX_MASK — Polygon rendering mode type
- POLYTYPE_ATEX_MASK_LIT — Polygon rendering mode type
- POLYTYPE_ATEX_MASK_TRANS — Polygon rendering mode type
- POLYTYPE_ATEX_TRANS — Polygon rendering mode type
- POLYTYPE_FLAT — Polygon rendering mode type
- POLYTYPE_GCOL — Polygon rendering mode type
- POLYTYPE_GRGB — Polygon rendering mode type
- POLYTYPE_PTEX — Polygon rendering mode type
- POLYTYPE_PTEX_LIT — Polygon rendering mode type
- POLYTYPE_PTEX_MASK — Polygon rendering mode type
- POLYTYPE_PTEX_MASK_LIT — Polygon rendering mode type
- POLYTYPE_PTEX_MASK_TRANS — Polygon rendering mode type
- POLYTYPE_PTEX_TRANS — Polygon rendering mode type

# Q

- QUAT — Stores quaternion information.

# R

- RGB — Single palette entry.
- RGB_MAP — Stores an rgb map to accelerate conversions.
- RLE_SPRITE — Stores the contents of an RLE sprite.

# S

- SAMPLE — Stores sound data.
- SCREEN_H — Global define to obtain the size of the screen.
- SCREEN_W — Global define to obtain the size of the screen.

# T

- TRACE — Debugging helper macro to trace messages.

# V

- V3D — Fixed point vertex structure used by 3d functions.
- V3D_f — Floating point vertex structure used by 3d functions.
- VIRTUAL_H — Global define to obtain the virtual size of the screen.
- VIRTUAL_W — Global define to obtain the virtual size of the screen.

# Z

- ZBUFFER — Stores 3d zbuffer information.

# _

- _getpixel — Faster specific version of getpixel().
- _getpixel15 — Faster specific version of getpixel().
- _getpixel16 — Faster specific version of getpixel().
- _getpixel24 — Faster specific version of getpixel().
- _getpixel32 — Faster specific version of getpixel().
- _putpixel — Faster specific version of putpixel().
- _putpixel15 — Faster specific version of putpixel().
- _putpixel16 — Faster specific version of putpixel().
- _putpixel24 — Faster specific version of putpixel().
- _putpixel32 — Faster specific version of putpixel().
- _set_color — Inline version of set_color().
- _ustrdup — Duplicates a string with a custom memory allocator.

# a

- acquire_bitmap — Locks the bitmap before drawing onto it.
- acquire_screen — Shortcut of acquire_bitmap(screen);
- active_dialog — Global pointer to the most recent activated dialog.
- active_menu — Global pointer to the most recent activated menu.
- add_clip_rect — Intersects a bitmap's clipping rectangle with the given area.
- adjust_sample — Alters the parameters of a sample while it is playing.
- al_assert — Asserts at the specified file and line number.
- al_ffblk — Cross platform structure storing file information.
- al_ffblk_get_size — Get size of file returned by al_findfirst/al_findnext.
- al_findclose — Closes a previously opened search with al_findfirst().
- al_findfirst — Low-level function for searching files.
- al_findnext — Finds the next file in a search started by al_findfirst().
- al_trace — Outputs a debugging trace message.
- alert — Displays a popup alert box.
- alert3 — Like alert(), but with three buttons.
- allegro_404_char — Character used when Allegro cannot find a glyph.
- allegro_error — Stores the last Allegro error message.
- allegro_exit — Closes down the Allegro system.
- allegro_icon — Pointer to the Allegro X11 icon.
- allegro_id — String containing date and version number of Allegro.
- allegro_init — Macro to initialise the Allegro library.
- allegro_message — Used mainly to show error messages to users.
- allocate_voice — Allocates a sound card voice for a sample.
- append_filename — Concatenates a filename to a path.
- apply_matrix — Multiplies a point by a transformation matrix.
- apply_matrix_f — Multiplies a point by a transformation matrix.
- apply_quat — Multiplies a point by a quaternion.
- arc — Draws a circular arc.

# b

- bestfit_color — Finds a palette color fitting the requested RGB values.
- bitmap_color_depth — Returns the color depth of the specified bitmap.
- bitmap_mask_color — Returns the mask color of the specified bitmap.
- black_palette — A palette containing solid black colors.
- blit — Copies a rectangular area from one bitmap to another.
- blit_from_hdc — Blits from a Windows device context to an Allegro memory bitmap.
- blit_to_hdc — Blits an Allegro memory bitmap to a Windows device context.
- bmp_read_line — Direct access bank switching line selection for reading.
- bmp_unwrite_line — Direct access bank switching line release.
- bmp_write_line — Direct access bank switching line selection for writing.
- broadcast_dialog_message — Broadcasts a message to all the objects in the active dialog.

# c

- calc_spline — Calculates a series of values along a Bezier spline.
- calibrate_joystick — Calibrates the specified joystick.
- calibrate_joystick_name — Returns the next calibration text string.
- canonicalize_filename — Converts any filename into its canonical form.
- centre_dialog — Centers an array of dialog objects.
- check_cpu — Detects the CPU type.
- circle — Draws a circle.
- circlefill — Draws a filled circle.
- clear_bitmap — Clears the bitmap to color 0.
- clear_keybuf — Clears the keyboard buffer.
- clear_scene — Initializes a scene.
- clear_to_color — Clears the bitmap to the specified color.
- clear_zbuffer — Writes a depth value into the given Z-buffer.
- clip3d — Clips the polygon given in vtx using fixed point math.
- clip3d_f — Clips the polygon given in vtx using floating point math,
- close_fli — Closes a FLI file previously opened.
- color_map — Global pointer to the color mapping table.
- config_is_hooked — Tells if a config section has custom hooks.
- convert_bitmap_to_hbitmap — Converts an Allegro memory bitmap to a Windows DDB.
- convert_hbitmap_to_bitmap — Creates an Allegro memory bitmap from a Windows DDB.
- convert_hpalette_to_palette — Converts a Windows palette to an Allegro palette.
- convert_palette_to_hpalette — Converts an Allegro palette to a Windows palette.
- cpu_capabilities — Contains the capability flags of the CPU.
- cpu_family — Contains the CPU type.
- cpu_model — Contains the Intel CPU submodel.
- cpu_vendor — Contains the CPU vendor name.
- create_bitmap — Creates a memory bitmap.
- create_bitmap_ex — Creates a memory bitmap specifying color depth.
- create_blender_table — Emulates truecolor blender effects in paletted modes.
- create_color_table — Fills a color mapping table for customised effects.
- create_datafile_index — Creates an index for a datafile.
- create_light_table — Fills a color mapping table for lighting effects.
- create_lzss_pack_data — Creates an LZSS structure for compression.
- create_lzss_unpack_data — Creates an LZSS structure for decompression.
- create_rgb_table — Generates an RGB mapping table with lookup data for a palette.
- create_sample — Constructs a new sample structure of the specified type.
- create_scene — Allocates memory for a 3d scene.
- create_sub_bitmap — Creates a memory sub bitmap.
- create_sub_zbuffer — Creates a sub-z-buffer.
- create_system_bitmap — Creates a system memory bitmap.
- create_trans_table — Fills a color mapping table for translucency effects.
- create_video_bitmap — Creates a video memory bitmap.
- create_zbuffer — Creates a Z-buffer for a bitmap.
- cross_product — Calculates the cross product.
- cross_product_f — Calculates the cross product.

# d

- d_bitmap_proc — Dialog procedure drawing a bitmap.
- d_box_proc — Dialog procedure drawing boxes onto the screen.
- d_button_proc — Dialog procedure implementing a button object.
- d_check_proc — Dialog procedure implementing a check box object.
- d_clear_proc — Dialog procedure to clear the screen.
- d_ctext_proc — Dialogs procedure drawing text onto the screen.
- d_edit_proc — Dialog procedure implementing an editable text object.
- d_icon_proc — Dialog procedure implementing a bitmap button.
- d_keyboard_proc — Invisible dialog procedure for implementing keyboard shortcuts.
- d_list_proc — Dialog procedure implementing a list box object.
- d_menu_proc — Dialog procedure implementing a menu bar object.
- d_radio_proc — Dialog procedure implementing a radio button object.
- d_rtext_proc — Dialogs procedure drawing text onto the screen.
- d_shadow_box_proc — Dialog procedure drawing boxes onto the screen.
- d_slider_proc — Dialog procedure implementing a slider control object.
- d_text_list_proc — Dialog procedure implementing a list box object with type ahead.
- d_text_proc — Dialogs procedure drawing text onto the screen.
- d_textbox_proc — Dialog procedure implementing a text box object.
- d_yield_proc — Invisible dialog procedure that yields CPU time slices.
- deallocate_voice — Frees a sound card voice.
- default_palette — The default IBM BIOS palette.
- delete_file — Removes a file from the disk.
- desktop_color_depth — Finds out the desktop color depth.
- desktop_palette — The palette used by the Atari ST low resolution desktop.
- destroy_bitmap — Destroys any type of created bitmap.
- destroy_compiled_sprite — Destroys a compiled sprite.
- destroy_datafile_index — Destroys a datafile index.
- destroy_font — Frees the memory being used by a font structure.
- destroy_gfx_mode_list — Frees the list created by get_gfx_mode_list().
- destroy_midi — Destroys a MIDI structure when you are done with it.
- destroy_rle_sprite — Destroys an RLE sprite.
- destroy_sample — Destroys a sample structure when you are done with it.
- destroy_scene — Deallocates the memory used by a scene.
- destroy_zbuffer — Destroys a Z-buffer.
- detect_digi_driver — Detects whether the specified digital sound device is available.
- detect_midi_driver — Detects whether the specified MIDI sound device is available.
- dialog_message — Sends a message to all the objects in an array.
- digi_recorder — Hook notifying you when a new sample buffer becomes available.
- disable_hardware_cursor — Disables the OS hardware cursor.
- do_arc — Calculates all the points in a circular arc.
- do_circle — Calculates all the points in a circle.
- do_dialog — Basic dialog manager function.
- do_ellipse — Calculates all the points in an ellipse.
- do_line — Calculates all the points along a line.
- do_menu — Displays an animates a popup menu.
- do_uconvert — Converts a string to another encoding format.
- dot_product — Calculates the dot product.
- dot_product_f — Calculates the dot product.
- draw_character_ex — Draws non transparent pixels of the sprite with a color.
- draw_compiled_sprite — Draws a compiled sprite.
- draw_gouraud_sprite — Draws a sprite with gouraud shading.
- draw_lit_rle_sprite — Draws a tinted RLE sprite.
- draw_lit_sprite — Draws a sprite tinted with a specific color.
- draw_rle_sprite — Draws an RLE sprite.
- draw_sprite — Draws a copy of the sprite onto the destination bitmap.
- draw_sprite_h_flip — Draws the sprite transformed to the destination bitmap.
- draw_sprite_v_flip — Draws the sprite transformed to the destination bitmap.
- draw_sprite_vh_flip — Draws the sprite transformed to the destination bitmap.
- draw_to_hdc — Draws an Allegro bitmap to a Windows device context.
- draw_trans_rle_sprite — Draws a translucent RLE sprite.
- draw_trans_sprite — Draws a sprite blending it with the destination.
- drawing_mode — Sets the graphics drawing mode.

# e

- ellipse — Draws an ellipse.
- ellipsefill — Draws a filled ellipse.
- empty_string — Universal string NULL terminator.
- enable_hardware_cursor — Enables the OS hardware cursor.
- enable_triple_buffer — Enables triple buffering.
- ex12bit — How to fake a 12-bit truecolor mode on an 8-bit card.
- ex3buf — Mode-X triple buffering and retrace interrupt simulation.
- ex3d — 3d 'bouncy cubes' demo.
- exaccel — Using offscreen video memory to store source graphics for VBE/AF.
- exalpha — Creating and using 32 bit RGBA sprites.
- exbitmap — Loading and displaying PCX and BMP files.
- exblend — Using translucency in truecolor modes.
- excamera — Viewing a 3d world from an arbitrary camera position.
- excolmap — Creating graphical effects with color mapping tables.
- exconfig — Using the configuration routines.
- excustom — Creating custom GUI objects.
- exdata — Accessing the contents of datafiles.
- exdbuf — How to use double buffering to avoid flicker.
- exexedat — Appending datafiles onto your executable.
- exfixed — Using fixed point maths.
- exflame — How to write directly to video memory improving performance.
- exflip — Comparison of double buffering and page flipping.
- exgui — Using the GUI routines.
- exhello — Simple graphical "hello world" program.
- exists — Shortcut version of file_exists() for normal files.
- exjoy — Detecting, calibrating and using joystick input.
- exkeys — How to get input from the keyboard in different ways.
- exlights — One way to do colored lighting effects in a hicolor video mode.
- exmem — Drawing onto memory bitmaps and then blitting them to the screen.
- exmidi — Playing MIDI music.
- exmouse — Getting input from the mouse.
- expackf — Using custom PACKFILE vtables.
- expal — Palette effects and color cycling.
- expat — Using patterned drawing modes and sub-bitmaps.
- exquat — A comparison between Euler angles and quaternions.
- exrgbhsv — RGB <-> HSV color space conversions.
- exsample — Playing digital samples.
- exscale — Loading PCX files and bitmap stretching.
- exscn3d — Using the 3d scene functions.
- exscroll — Mode-X hardware scrolling and split screens.
- exshade — Gouraud shaded sprites.
- exspline — Constructing smooth movement paths from spline curves.
- exsprite — Datafiles access and sprite animation.
- exstars — 3d starfield and lightsourced spaceship.
- exstream — Playing audio streams.
- exswitch — Controlling the console switch mode for background running.
- extimer — Using the timer (delays and interrupts).
- extract_font_range — Extracts a range of characters from a font.
- extrans — Lighting and translucency effects.
- extruec — Truecolor pixel format conversions.
- exunicod — Using Unicode string functions.
- exupdate — Supporting different screen update methods in a single program.
- exxfade — Truecolor image loading and fades.
- exzbuf — Z-buffered polygons demo.

# f

- fade_from — Gradually fades the palette between two others.
- fade_from_range — Gradually fades a part of the palette between two others.
- fade_in — Gradually fades the palette from black.
- fade_in_range — Gradually fades a part of the palette from black.
- fade_interpolate — Calculates a new palette interpolated between two others.
- fade_out — Gradually fades the palette to black.
- fade_out_range — Gradually fades a part of the palette to black.
- fastline — Faster version of line().
- file_exists — Tells if a file exists.
- file_select_ex — Displays the Allegro file selector with a caption.
- file_size_ex — Returns the size of a file in bytes.
- file_time — Returns the modification time of a file.
- find_allegro_resource — Searches for a support file in many places.
- find_datafile_object — Searches a datafile for an object with a name.
- find_dialog_focus — Searches the dialog for the object which has the input focus.
- fix_filename_case — Converts a filename to a standardised case.
- fix_filename_slashes — Converts all the directory separators to a standard character.
- fixacos — Fixed point inverse cosine lookup table.
- fixadd — Safe function to add fixed point numbers clamping overflow.
- fixasin — Fixed point inverse sine lookup table.
- fixatan — Fixed point inverse tangent lookup table.
- fixatan2 — Fixed point version of the libc atan2() routine.
- fixceil — Returns the smallest integer not less than x.
- fixcos — Fixed point cosine of binary angles.
- fixdiv — Fixed point division.
- fixed — Fixed point integer to replace floats.
- fixfloor — Returns the greatest integer not greater than x.
- fixhypot — Fixed point hypotenuse.
- fixmul — Multiplies two fixed point values together.
- fixsin — Fixed point sine of binary angles.
- fixsqrt — Fixed point square root.
- fixsub — Safe function to subtract fixed point numbers clamping underflow.
- fixtan — Fixed point tangent of binary angles.
- fixtof — Converts a fixed point to floating point.
- fixtoi — Converts a fixed point to integer with rounding.
- fixtorad_r — Constant to convert angles in fixed point format to radians.
- fixup_datafile — Fixes truecolor images in compiled datafiles.
- fli_bitmap — Contains the current frame of the animation.
- fli_bmp_dirty_from — Indicate which parts of the image have changed.
- fli_bmp_dirty_to — Indicate which parts of the image have changed.
- fli_frame — Stores the current frame number of the animation.
- fli_pal_dirty_from — Indicate which parts of the palette have changed.
- fli_pal_dirty_to — Indicate which parts of the palette have changed.
- fli_palette — Contains the current palette of the animation.
- fli_timer — Global variable for timing FLI playback.
- floodfill — Floodfills an enclosed area.
- flush_config_file — Flushes the current config file to disk.
- font — A simple 8x8 fixed size font.
- font_has_alpha — Search all pixels of a font for alpha values.
- for_each_file_ex — Executes callback() for each file matching a wildcard.
- free_audio_stream_buffer — Tells the audio stream player new data can be played.
- free_config_entries — Frees memory allocated for config entry lists.
- free_lzss_pack_data — Frees an LZSS structure.
- free_lzss_unpack_data — Frees an LZSS structure.
- freeze_mouse_flag — Flag to avoid redrawing the mouse pointer.
- ftofix — Converts a floating point value to fixed point.

# g

- generate_332_palette — Constructs a fake truecolor palette.
- generate_optimized_palette — Generates an optimized palette for a bitmap.
- get_align_matrix — Rotates a matrix to align it along specified coordinate vectors.
- get_align_matrix_f — Floating point version of get_align_matrix().
- get_audio_stream_buffer — Tells you if you need to fill the audiostream or not.
- get_camera_matrix — Constructs a camera matrix for perspective projection.
- get_camera_matrix_f — Floating point version of get_camera_matrix().
- get_clip_rect — Returns the clipping rectangle of a bitmap.
- get_clip_state — Tells if clipping is on for a bitmap.
- get_color — Retrieves the specified palette entry.
- get_color_conversion — Returns the current color conversion mode.
- get_color_depth — Returns the current pixel color depth.
- get_compiled_sprite — Creates a compiled sprite using a bitmap as source.
- get_config_argv — Reads a token list from the configuration file.
- get_config_float — Retrieves a float from the configuration file.
- get_config_hex — Retrieves a hexadecimal value from the configuration file.
- get_config_id — Retrieves a driver ID from a configuration file.
- get_config_int — Retrieves an integer from the configuration file.
- get_config_string — Retrieves a string from the configuration file.
- get_config_text — Returns a string translated to the current language.
- get_datafile_property — Returns the property string for the object.
- get_desktop_resolution — Finds out the desktop resolution.
- get_display_switch_mode — Returns the current display switching mode.
- get_executable_name — Obtains the full path to the current executable.
- get_extension — Returns a pointer to the extension of a filename.
- get_filename — Returns a pointer to the filename portion of a path.
- get_filename_encoding — Returns the encoding currently assumed for filenames.
- get_font_range_begin — Returns the start of a character range in a font.
- get_font_range_end — Returns the last character of a character range in a font.
- get_font_ranges — Returns the number of character ranges in a font.
- get_gfx_mode_list — Obtains a list of available video modes.
- get_hardware_volume — Retrieves the hardware sound output volume.
- get_midi_length — Determines the total playing time of a midi, in seconds.
- get_mixer_bits — Returns the mixer bit depth (8 or 16).
- get_mixer_buffer_length — Returns the number of samples per channel in the mixer buffer.
- get_mixer_channels — Returns the number of output channels.
- get_mixer_frequency — Returns the mixer frequency, in Hz.
- get_mixer_quality — Returns the current mixing quality.
- get_mixer_voices — Returns the number of voices allocated to the mixer.
- get_mouse_mickeys — How far the mouse has moved since the last call to this function.
- get_palette — Retrieves the entire palette of 256 colors.
- get_palette_range — Retrieves a specific palette range.
- get_refresh_rate — Returns the current refresh rate.
- get_rle_sprite — Creates an RLE sprite using a bitmap as source.
- get_rotation_matrix — Constructs X, Y, Z rotation matrices.
- get_rotation_matrix_f — Constructs X, Y, Z rotation matrices.
- get_rotation_quat — Constructs a quaternion to rotate points around all three axes.
- get_scaling_matrix — Constructs a scaling matrix.
- get_scaling_matrix_f — Constructs a scaling matrix.
- get_sound_input_cap_bits — Checks which audio input sample formats are supported.
- get_sound_input_cap_parm — Detects if the specified recording parameters are supported.
- get_sound_input_cap_rate — Returns the maximum sample frequency for recording.
- get_sound_input_cap_stereo — Tells if the input driver is capable of stereo recording.
- get_transformation_matrix — Constructs X, Y, Z rotation matrices with an angle and scaling.
- get_transformation_matrix_f — Floating point version of get_transformation_matrix().
- get_translation_matrix — Constructs a translation matrix.
- get_translation_matrix_f — Constructs a translation matrix.
- get_uformat — Finds out what text encoding format is currently selected.
- get_vector_rotation_matrix — Constructs X, Y, Z rotation matrices with an angle.
- get_vector_rotation_matrix_f — Constructs X, Y, Z rotation matrices with an angle.
- get_vector_rotation_quat — Constructs a quaternion to rotate points around a vector.
- get_volume — Retrieves the global sound output volume.
- get_x_rotate_matrix — Construct X axis rotation matrices.
- get_x_rotate_matrix_f — Construct X axis rotation matrices.
- get_x_rotate_quat — Construct axis rotation quaternions.
- get_y_rotate_matrix — Construct Y axis rotation matrices.
- get_y_rotate_matrix_f — Construct Y axis rotation matrices.
- get_y_rotate_quat — Construct axis rotation quaternions.
- get_z_rotate_matrix — Construct Z axis rotation matrices.
- get_z_rotate_matrix_f — Construct Z axis rotation matrices.
- get_z_rotate_quat — Construct axis rotation quaternions.
- geta — Extract a color component from the current pixel format.
- geta32 — Extract the alpha component form a 32-bit pixel format color.
- geta_depth — Extract a color component from a color in a specified pixel format.
- getb — Extract a color component from the current pixel format.
- getb15 — Extract a color component from the specified pixel format.
- getb16 — Extract a color component from the specified pixel format.
- getb24 — Extract a color component from the specified pixel format.
- getb32 — Extract a color component from the specified pixel format.
- getb8 — Extract a color component from the specified pixel format.
- getb_depth — Extract a color component from a color in a specified pixel format.
- getg — Extract a color component from the current pixel format.
- getg15 — Extract a color component from the specified pixel format.
- getg16 — Extract a color component from the specified pixel format.
- getg24 — Extract a color component from the specified pixel format.
- getg32 — Extract a color component from the specified pixel format.
- getg8 — Extract a color component from the specified pixel format.
- getg_depth — Extract a color component from a color in a specified pixel format.
- getpixel — Reads a pixel from a bitmap.
- getr — Extract a color component from the current pixel format.
- getr15 — Extract a color component from the specified pixel format.
- getr16 — Extract a color component from the specified pixel format.
- getr24 — Extract a color component from the specified pixel format.
- getr32 — Extract a color component from the specified pixel format.
- getr8 — Extract a color component from the specified pixel format.
- getr_depth — Extract a color component from a color in a specified pixel format.
- gfx_capabilities — Bitfield describing video hardware capabilities.
- gfx_mode_select — Displays the Allegro graphics mode selection dialog.
- gfx_mode_select_ex — Extended version of the graphics mode selection dialog.
- gfx_mode_select_filter — Even more extended version of the graphics mode selection dialog.
- grab_font_from_bitmap — Grabs a font from a bitmap
- gui_bg_color — The foreground and background colors for the standard dialogs.
- gui_button_proc — Hooks to customise the look and feel of Allegro dialogs.
- gui_ctext_proc — Hooks to customise the look and feel of Allegro dialogs.
- gui_edit_proc — Hooks to customise the look and feel of Allegro dialogs.
- gui_fg_color — The foreground and background colors for the standard dialogs.
- gui_font_baseline — Adjusts the keyboard shortcut underscores height.
- gui_get_screen — Returns the bitmap surface GUI routines draw to.
- gui_list_proc — Hooks to customise the look and feel of Allegro dialogs.
- gui_menu_draw_menu — Hooks to modify the appearance of menus.
- gui_menu_draw_menu_item — Hooks to modify the appearance of menus.
- gui_mg_color — The color used for displaying greyed-out dialog objects.
- gui_mouse_b — Hook functions used by the GUI routines to access the mouse state.
- gui_mouse_focus — Tells if the input focus follows the mouse pointer.
- gui_mouse_x — Hook functions used by the GUI routines to access the mouse state.
- gui_mouse_y — Hook functions used by the GUI routines to access the mouse state.
- gui_mouse_z — Hook functions used by the GUI routines to access the mouse state.
- gui_set_screen — Changes the bitmap surface GUI routines draw to.
- gui_shadow_box_proc — Hooks to customise the look and feel of Allegro dialogs.
- gui_strlen — Returns the length of a string in pixels.
- gui_text_list_proc — Hooks to customise the look and feel of Allegro dialogs.
- gui_textout_ex — Draws a text string onto the screen with keyboard shortcut underbars.

# h

- hline — Draws a horizontal line onto the bitmap.
- hook_config_section — Hooks a configuration file section with custom handlers.
- hsv_to_rgb — Converts color values between the HSV and RGB color spaces.

# i

- i_love_bill — Tells if Allegro has to used fixed rate timers.
- identity_matrix — Global containing the identity matrix.
- identity_matrix_f — Global containing the identity matrix.
- identity_quat — Global variable containing the identity quaternion.
- init_dialog — Low level initialisation of a dialog.
- init_menu — Low level initialisation of a menu.
- initialise_joystick — Deprecated version of install_joystick().
- install_allegro — Initialise the Allegro library.
- install_int — Installs a user timer handler.
- install_int_ex — Adds or modifies a timer.
- install_joystick — Initialises the joystick.
- install_keyboard — Installs the Allegro keyboard interrupt handler.
- install_keyboard_hooks — Installs custom keyboard hooks.
- install_mouse — Installs the Allegro mouse handler.
- install_param_int — Installs a timer routine with a customizable parameter.
- install_param_int_ex — Adds or modifies a timer with a customizable parameter.
- install_sound — Initialises the sound module.
- install_sound_input — Initialises the sound recorder module.
- install_timer — Installs the Allegro timer interrupt handler.
- is_color_font — Returns TRUE if a font is a color font.
- is_compatible_font — Check if two fonts are of the same type.
- is_inside_bitmap — Tells if a point is inside a bitmap.
- is_linear_bitmap — Tells if a bitmap is linear.
- is_memory_bitmap — Tells if a bitmap is a memory bitmap.
- is_mono_font — Returns TRUE if a font is a monochrome font.
- is_planar_bitmap — Tells if a bitmap is a planar screen bitmap.
- is_relative_filename — Returns TRUE if the filename is relative.
- is_same_bitmap — Tells if two bitmaps describe the same drawing surface.
- is_screen_bitmap — Tells if a bitmap is the screen bitmap or sub bitmap.
- is_sub_bitmap — Tells if a bitmap is a sub bitmap.
- is_system_bitmap — Tells if a bitmap is a system bitmap or sub bitmap.
- is_trans_font — Returns TRUE if a font uses transparency.
- is_video_bitmap — Tells if a bitmap is a screen bitmap, video memory or sub bitmap.
- is_windowed_mode — Tells if you are running in windowed mode.
- itofix — Converts an integer to fixed point.

# j

- joy — Global array of joystick state information.

# k

- key — Array of flags indicating key state.
- key_led_flag — Flag to prevent the keyboard LEDs from being updated.
- key_shifts — Bitmask containing the current state of modifier keys.
- keyboard_callback — User specified keyboard callback handler.
- keyboard_lowlevel_callback — User specified low level keyboard event handler.
- keyboard_needs_poll — Tells if the keyboard needs polling.
- keyboard_ucallback — User specified unicode keyboard callback handler.
- keypressed — Tells if there are keypresses waiting in the input buffer.

# l

- line — Draws a line onto the bitmap.
- list_config_entries — Lists the names of all entries in a config section
- list_config_sections — Lists the names of all sections available in the current configuration.
- load_bios_font — Loads a 8x8 or 8x16 BIOS format font.
- load_bitmap — Loads any supported bitmap from a file.
- load_bitmap_font — Grabs a font from a bitmap file.
- load_bmp — Loads a BMP bitmap from a file.
- load_bmp_pf — Packfile version of load_bmp.
- load_dat_font — Loads a FONT from an Allegro datafile.
- load_datafile — Loads a datafile into memory.
- load_datafile_callback — Loads a datafile into memory, calling a hook per object.
- load_datafile_object — Loads a specific object from a datafile.
- load_datafile_object_indexed — Loads a single object from a datafile index.
- load_font — Loads a font from a file.
- load_grx_font — Loads a GRX format font.
- load_grx_or_bios_font — Loads either a BIOS or GRX format font.
- load_ibk — Reads in a .IBK patch definition file for the Adlib driver.
- load_joystick_data — Loads joystick calibration data.
- load_lbm — Loads an LBM bitmap from a file.
- load_midi — Loads a MIDI file.
- load_midi_patches — Forces the MIDI driver to load a set of patches.
- load_pcx — Loads a PCX bitmap from a file.
- load_pcx_pf — Packfile version of load_pcx.
- load_sample — Loads a sample from a file.
- load_tga — Loads a TGA bitmap from a file.
- load_tga_pf — Packfile version of load_tga.
- load_txt_font — Loads a font script.
- load_voc — Loads a sample from a Creative Labs VOC file.
- load_voc_pf — Packfile version of load_voc.
- load_wav — Loads a sample from a RIFF WAV file.
- load_wav_pf — Packfile version of load_wav.
- lock_bitmap — Locks the memory used by a bitmap.
- lock_midi — Locks all the memory used by a MIDI file.
- lock_sample — Locks all the memory used by a sample.
- lzss_read — Decompresses data using LZSS.
- lzss_write — Compresses data using LZSS.

# m

- make_absolute_filename — Makes an absolute filename from a path and relative filename.
- make_relative_filename — Tries to make a relative filename from absolute path and filename.
- make_trans_font — Makes a font use transparency.
- makeacol — Converts RGBA colors into display dependent pixel formats.
- makeacol32 — Converts an RGBA color into a 32-bit display pixel format.
- makeacol_depth — Converts RGBA colors into display dependent pixel formats.
- makecol — Converts an RGB value into the current pixel format.
- makecol15 — Converts an RGB value into a display dependent pixel format.
- makecol15_dither — Calculates a dithered 15 or 16-bit RGB value.
- makecol16 — Converts an RGB value into a display dependent pixel format.
- makecol16_dither — Calculates a dithered 15 or 16-bit RGB value.
- makecol24 — Converts an RGB value into a display dependent pixel format.
- makecol32 — Converts an RGB value into a display dependent pixel format.
- makecol8 — Converts an RGB value into a display dependent pixel format.
- makecol_depth — Converts an RGB value into the specified pixel format.
- masked_blit — Copies a rectangle skipping pixels with the mask color.
- masked_stretch_blit — Scales a rectangular area skipping pixels with the mask color.
- matrix_mul — Multiplies two matrices.
- matrix_mul_f — Multiplies two matrices.
- matrix_to_quat — Constructs a quaternion from a rotation matrix.
- merge_fonts — Merges two fonts into one font.
- midi_loop_end — Loop start and end points, set by play_looped_midi().
- midi_loop_start — Loop start and end points, set by play_looped_midi().
- midi_meta_callback — Hook functions allowing you to intercept MIDI player events.
- midi_msg_callback — Hook functions allowing you to intercept MIDI player events.
- midi_out — Streams a block of MIDI commands into the player.
- midi_pause — Pauses the MIDI player.
- midi_pos — Stores the current position in the MIDI file.
- midi_recorder — Hook notifying you when new MIDI data becomes available.
- midi_resume — Resumes playback of a paused MIDI file.
- midi_seek — Seeks to the given midi_pos in the current MIDI file.
- midi_sysex_callback — Hook functions allowing you to intercept MIDI player events.
- midi_time — The current position in the MIDI file, in seconds.
- mouse_b — Global variable with the mouse position/button state.
- mouse_callback — User specified mouse callback.
- mouse_needs_poll — Tells if the mouse driver requires polling.
- mouse_pos — Global variable with the mouse position/button state.
- mouse_sprite — Global variable with the mouse sprite and focus point.
- mouse_w — Global variable with the mouse position/button state.
- mouse_x — Global variable with the mouse position/button state.
- mouse_x_focus — Global variable with the mouse sprite and focus point.
- mouse_y — Global variable with the mouse position/button state.
- mouse_y_focus — Global variable with the mouse sprite and focus point.
- mouse_z — Global variable with the mouse position/button state.

# n

- need_uconvert — Tells if a string requires encoding conversion.
- next_fli_frame — Reads the next frame of the current animation file.
- normalize_vector — Converts the vector to a unit vector.
- normalize_vector_f — Converts the vector to a unit vector.
- num_joysticks — Global variable saying how many joysticks there are.

# o

- object_message — Sends a message to an object and returns the answer.
- offer_focus — Offers the input focus to a particular object.
- open_fli — Makes a FLI file open and ready for playing.
- open_memory_fli — Makes a FLI file open and ready for playing.
- os_multitasking — Indicates if the OS is multitasking.
- os_revision — Version of the OS currently running.
- os_type — Stores the detected type of the OS.
- os_version — Version of the OS currently running.
- override_config_data — Specifies a block of data containing config overrides.
- override_config_file — Specifies a file containing config overrides.

# p

- pack_fclose — Closes a stream previously opened.
- pack_fclose_chunk — Closes a previously opened sub-chunk.
- pack_feof — Returns nonzero as soon as you reach the end of the file.
- pack_ferror — Tells if an error occurred during an operation on the stream.
- pack_fgets — Reads a line from the stream.
- pack_fopen — Opens a file according to mode.
- pack_fopen_chunk — Opens a sub-chunk of a file.
- pack_fopen_vtable
- pack_fputs — Writes a string to the stream.
- pack_fread — Reads n bytes from the stream.
- pack_fseek — Seeks inside a stream.
- pack_fwrite — Writes n bytes to the stream.
- pack_getc — Returns the next character from a stream.
- pack_igetl — Like pack_getc(), but using 32-bit Intel byte ordering words.
- pack_igetw — Like pack_getc(), but using 16-bit Intel byte ordering words.
- pack_iputl — Like pack_putc(), but using 32-bit Intel byte ordering words.
- pack_iputw — Like pack_putc(), but using 16-bit Intel byte ordering words.
- pack_mgetl — Like pack_getc(), but using 32-bit Motorola byte ordering words.
- pack_mgetw — Like pack_getc(), but using 16-bit Motorola byte ordering words.
- pack_mputl — Like pack_putc(), but using 32-bit Motorola byte ordering words.
- pack_mputw — Like pack_putc(), but using 16-bit Motorola byte ordering words.
- pack_putc — Puts a character in the stream.
- pack_ungetc — Moves one single character back to the input buffer.
- packfile_password — Sets the global I/O encryption password.
- palette_color — Maps palette indexes into the current pixel format colors.
- persp_project — Projects a 3d point into 2d screen space.
- persp_project_f — Projects a 3d point into 2d screen space.
- pivot_scaled_sprite — Rotates and stretches a sprite around a specified point.
- pivot_scaled_sprite_v_flip — Rotates, stretches and flips a sprite around a specified point.
- pivot_sprite — Rotates a sprite around a specified point.
- pivot_sprite_v_flip — Rotates and flips a sprite around a specified point.
- play_audio_stream — Creates a new audio stream and starts playing it.
- play_fli — Plays a FLI or FLC animation from disk.
- play_looped_midi — Starts playing a MIDI file with a user-defined loop position.
- play_memory_fli — Plays a FLI or FLC animation from memory.
- play_midi — Starts playing the specified MIDI file.
- play_sample — Plays a sample.
- poll_joystick — Polls the joystick.
- poll_keyboard — Polls the keyboard.
- poll_mouse — Polls the mouse.
- poll_scroll — Checks the status of a scroll request with triple buffering.
- polygon — Draws a filled polygon.
- polygon3d — Draws a 3d polygon onto the specified bitmap.
- polygon3d_f — Draws a 3d polygon onto the specified bitmap.
- polygon_z_normal — Finds the Z component of the normal vector to three vertices.
- polygon_z_normal_f — Finds the Z component of the normal vector to three vertices.
- pop_config_state — Pops a previously pushed configuration state.
- popup_dialog — do_dialog() used for popup dialogs.
- position_dialog — Moves an array of dialog objects to the specified position.
- position_mouse — Moves the mouse to the specified screen position.
- position_mouse_w — Sets the horizontal mouse wheel position.
- position_mouse_z — Sets the mouse wheel position global variable.
- push_config_state — Pushes the current configuration state.
- put_backslash — Puts a path separator at the end of a path if needed.
- putpixel — Writes a pixel into a bitmap.

# q

- qnx_get_window — Retrieves a handle to the window used by Allegro.
- qscale_matrix — Optimised routine for scaling an already generated matrix.
- qscale_matrix_f — Optimised routine for scaling an already generated matrix.
- qtranslate_matrix — Optimised routine for translating an already generated matrix.
- qtranslate_matrix_f — Optimised routine for translating an already generated matrix.
- quad3d — Draws a 3d quad onto the specified bitmap.
- quad3d_f — Draws a 3d quad onto the specified bitmap.
- quat_interpolate — Constructs a quaternion representing a rotation between from and to.
- quat_mul — Multiplies two quaternions.
- quat_slerp — Version of quat_interpolate() allowing control over the rotation.
- quat_to_matrix — Constructs a rotation matrix from a quaternion.

# r

- radtofix_r — Constant to convert radians to fixed point angles.
- read_sound_input — Retrieves the last recorded audio buffer.
- readkey — Returns the next character from the keyboard buffer.
- reallocate_voice — Switches the sample of an already-allocated voice.
- rect — Draws an outline rectangle.
- rectfill — Draws a solid filled rectangle.
- register_assert_handler — Registers a custom handler for assert failures.
- register_bitmap_file_type — Registers custom bitmap loading/saving functions.
- register_datafile_object — Registers load/destroy functions for custom object types.
- register_font_file_type — Register a new font loading function.
- register_sample_file_type — Registers custom loading/saving sample routines.
- register_trace_handler — Registers a custom handler for trace output.
- register_uformat — Installs handler functions for a new text encoding format.
- release_bitmap — Releases a previously locked bitmap.
- release_screen — Shortcut of release_bitmap(screen);
- release_voice — Releases a sound card voice.
- reload_config_texts — Reloads translated strings returned by get_config_text().
- remove_display_switch_callback — Removes a switching notification callback.
- remove_int — Removes a timers.
- remove_joystick — Removes the joystick handler.
- remove_keyboard — Removes the Allegro keyboard handler.
- remove_mouse — Removes the mouse handler.
- remove_param_int — Removes a timer with a customizable parameter.
- remove_sound — Cleans up after you are finished with the sound routines.
- remove_sound_input — Cleans up after you are finished with the sound input routines.
- remove_timer — Removes the Allegro time handler.
- render_scene — Renders all the queued scene polygons.
- replace_extension — Replaces filename+extension with a new extension tail.
- replace_filename — Replaces path+filename with a new filename tail.
- request_refresh_rate — Requests a specific refresh rate during graphic mode switch.
- request_scroll — Queues a hardware scroll request with triple buffering.
- request_video_bitmap — Triple buffering page flip request.
- reserve_voices — Reserve a number of voices for the digital and MIDI drivers.
- reset_fli_variables — Resets the bitmap and palette dirty global variables.
- rest — Waits a specified number of milliseconds or yields CPU.
- rest_callback — Like rest(), but calls the callback during the wait.
- retrace_count — Retrace count simulator.
- rgb_map — Look up table to speed up reducing RGB values to palette colors.
- rgb_to_hsv — Converts color values between the HSV and RGB color spaces.
- rotate_scaled_sprite — Rotates and stretches a sprite.
- rotate_scaled_sprite_v_flip — Rotates, stretches and flips a sprite.
- rotate_sprite — Rotates a sprite.
- rotate_sprite_v_flip — Rotates and flips a sprite.

# s

- save_bitmap — Saves a bitmap into any supported file format.
- save_bmp — Saves a bitmap into a BMP file.
- save_bmp_pf — Packfile version of save_bmp.
- save_joystick_data — Saves joystick calibration data.
- save_pcx — Saves a bitmap into a PCX file.
- save_pcx_pf — Packfile version of save_pcx.
- save_sample — Writes a sample into a file.
- save_tga — Saves a bitmap into a TGA file.
- save_tga_pf — Packfile version of save_tga.
- scancode_to_ascii — Converts a scancode to an ASCII character.
- scancode_to_name — Converts a scancode to a key name.
- scare_mouse — Helper for hiding the mouse pointer before drawing.
- scare_mouse_area — Helper for hiding the mouse cursor before drawing in an area.
- scene_gap — Number controlling the scene z-sorting algorithm behaviour.
- scene_polygon3d — Puts a polygon in the scene rendering list.
- scene_polygon3d_f — Puts a polygon in the scene rendering list.
- screen — Global pointer to the screen hardware video memory.
- scroll_screen — Requests a hardware scroll request.
- select_mouse_cursor — Tells Allegro to select software or hardware cursor drawing.
- select_palette — Sets the internal palette for color conversion.
- set_add_blender — Enables an additive blender mode.
- set_allegro_resource_path — Sets a specific resource search path.
- set_alpha_blender — Enables a special alpha-channel blending mode.
- set_blender_mode — Specifies a custom set of truecolor blender routines.
- set_blender_mode_ex — An even more complex version of set_blender_mode().
- set_burn_blender — Enables a burn blender mode.
- set_clip_rect — Sets the clipping rectangle of a bitmap.
- set_clip_state — Turns on or off the clipping of a bitmap.
- set_close_button_callback — Handles the user clicking on the close button of the window.
- set_color — Sets the specified palette entry to the specified RGB triplet.
- set_color_blender — Enables a color blender mode.
- set_color_conversion — Tells Allegro how to convert images during loading time.
- set_color_depth — Sets the global pixel color depth.
- set_config_data — Sets a block of configuration data.
- set_config_file — Sets the configuration file.
- set_config_float — Writes a float in the configuration file.
- set_config_hex — Writes a hexadecimal integer in the configuration file.
- set_config_id — Writes a driver ID in the configuration file.
- set_config_int — Writes an integer in the configuration file.
- set_config_string — Writes a string in the configuration file.
- set_dialog_color — Sets the colors of an array of dialog objects.
- set_difference_blender — Enables a difference blender mode.
- set_display_switch_callback — Installs a switching notification callback.
- set_display_switch_mode — Tells Allegro how the program handles background switching.
- set_dissolve_blender — Enables a dissolve blender mode.
- set_dodge_blender — Enables a dodge blender mode.
- set_filename_encoding — Sets the encoding to use for filenames.
- set_gdi_color_format — Tells Allegro to use the GDI color layout for truecolor images.
- set_gfx_mode — Sets a graphic video mode.
- set_hardware_volume — Alters the hardware sound output volume.
- set_hue_blender — Enables a hue blender mode.
- set_invert_blender — Enables an invert blender mode.
- set_keyboard_rate — Sets the keyboard repeat rate.
- set_leds — Sets the state of the keyboard LED indicators.
- set_luminance_blender — Enables a luminance blender mode.
- set_mixer_quality — Sets the resampling quality of the mixer.
- set_mouse_cursor_bitmap — Changes the image Allegro uses for mouse cursors.
- set_mouse_range — Sets the area of the screen restricting mouse movement.
- set_mouse_speed — Sets the mouse speed.
- set_mouse_sprite — Sets the mouse sprite.
- set_mouse_sprite_focus — Sets the mouse sprite focus.
- set_multiply_blender — Enables a multiply blender mode.
- set_palette — Sets the entire palette of 256 colors.
- set_palette_range — Sets a specific range of the palette.
- set_palette_to_hdc — Selects and realizes a palette on the specified device context.
- set_projection_viewport — Sets the viewport used to scale the output of persp_project().
- set_saturation_blender — Enables a saturation blender mode.
- set_screen_blender — Enables a screen blender mode.
- set_sound_input_source — Selects the audio input source.
- set_trans_blender — Enables a truecolor blender.
- set_ucodepage — Sets 8-bit to Unicode conversion tables.
- set_uformat — Set the global current text encoding format.
- set_volume — Alters the global sound output volume.
- set_volume_per_voice — Sets the volume of a voice.
- set_window_title — Sets the window title of the Allegro program.
- set_write_alpha_blender — Enables the special alpha-channel editing mode.
- set_zbuffer — Makes the given Z-buffer the active one.
- show_mouse — Tells Allegro to display a mouse pointer on the screen.
- show_os_cursor — Low level function to display the operating system cursor.
- show_video_bitmap — Flips the hardware screen to use the specified page.
- shutdown_dialog — Destroys a dialog player returned by init_dialog().
- shutdown_menu — Destroys a menu player object returned by init_menu().
- simulate_keypress — Stuffs a key into the keyboard buffer.
- simulate_ukeypress — Stuffs an unicode key into the keyboard buffer.
- solid_mode — Shortcut for selecting solid drawing mode.
- spline — Draws a Bezier spline using four control points.
- start_sound_input — Starts recording in the specified format.
- stop_audio_stream — Destroys an audio stream when it is no longer required.
- stop_midi — Stops whatever music is currently playing.
- stop_sample — Stops a sample from playing.
- stop_sound_input — Stops audio recording.
- stretch_blit — Scales a rectangular area from one bitmap to another.
- stretch_blit_from_hdc — Blits from a Windows device context to an Allegro memory bitmap.
- stretch_blit_to_hdc — Blits an Allegro memory bitmap to a Windows device context.
- stretch_sprite — Stretches a sprite to the destination bitmap.

# t

- text_height — Returns the height of a font in pixels.
- text_length — Returns the length of a string in pixels.
- textout_centre_ex — Writes a centered string on a bitmap.
- textout_ex — Writes a string on a bitmap.
- textout_justify_ex — Draws justified text within a region.
- textout_right_ex — Writes a right aligned string on a bitmap.
- textprintf_centre_ex — Formatted centered output of a string.
- textprintf_ex — Formatted output of a string.
- textprintf_justify_ex — Formatted justified output of a string.
- textprintf_right_ex — Formatted right aligned output of a string.
- three_finger_flag — Flag to deactivate the emergency exit key combination.
- transpose_font — Transposes all characters in a font.
- triangle — Draws a filled triangle.
- triangle3d — Draws a 3d triangle onto the specified bitmap.
- triangle3d_f — Draws a 3d triangle onto the specified bitmap.

# u

- uatof — Converts a string into a double.
- uconvert — High level string encoding conversion wrapper.
- uconvert_ascii — Converts string from ASCII into the current format.
- uconvert_size — Number of bytes needed to store a string after conversion.
- uconvert_toascii — Converts strings from the current format into ASCII.
- ucwidth — Low level helper function for testing Unicode text data.
- ugetat — Finds out the value of a character in a string.
- ugetc — Low level helper function for reading Unicode text data.
- ugetx — Low level helper function for reading Unicode text data.
- ugetxc — Low level helper function for reading Unicode text data.
- uinsert — Inserts a character in a string.
- uisdigit — Tells if a character is a digit.
- uisok — Low level helper function for testing Unicode text data.
- uisspace — Tells if a character is whitespace.
- unload_datafile — Frees all the objects in a datafile.
- unload_datafile_object — Frees an object previously loaded by load_datafile_object().
- unscare_mouse — Undoes the effect of scare_mouse() or scare_mouse_area().
- unselect_palette — Restores the palette before last call to select_palette().
- uoffset — Finds the offset of a character in a string.
- update_dialog — Low level function to update a dialog player.
- update_menu — Low level function to update a menu player.
- ureadkey — Returns the next unicode character from the keyboard buffer.
- uremove — Removes a character from a string.
- usetat — Replaces a character in a string.
- usetc — Low level helper function for writing Unicode text data.
- usprintf — Writes formatted data into a buffer.
- ustrcat — Concatenates a string to another one.
- ustrchr — Finds the first occurrence of a character in a string.
- ustrcmp — Compares two strings.
- ustrcpy — Copies a string into another one.
- ustrdup — Duplicates a string.
- ustrerror — Returns a string describing errno.
- ustricmp — Compares two strings ignoring case.
- ustrlen — Tells the number of characters in a string.
- ustrlwr — Replaces all letters with lower case.
- ustrncat — Concatenates a string to another one, specifying size.
- ustrncmp — Compares up to n letters of two strings.
- ustrncpy — Copies a string into another one, specifying size.
- ustrnicmp — Compares up to n letters of two strings ignoring case.
- ustrpbrk — Finds the first character that matches any in a set.
- ustrrchr — Finds the last occurrence of a character in a string.
- ustrsize — Size of the string in bytes without null terminator.
- ustrsizez — Size of the string in bytes including null terminator.
- ustrstr — Finds the first occurrence of a string in another one.
- ustrtod — Converts a string into a floating point number.
- ustrtok — Retrieves tokens from a string.
- ustrtok_r — Reentrant function to retrieve tokens from a string.
- ustrtol — Converts a string into an integer.
- ustrupr — Replaces all letters with upper case.
- ustrzcat — Concatenates a string to another one, specifying size.
- ustrzcpy — Copies a string into another one, specifying size.
- ustrzncat — Concatenates a string to another one, specifying size.
- ustrzncpy — Copies a string into another one, specifying size.
- uszprintf — Writes formatted data into a buffer, specifying size.
- utolower — Converts a letter to lower case.
- utoupper — Converts a letter to upper case.
- uvsprintf — Writes formatted data into a buffer, using variable arguments.
- uvszprintf — Writes formatted data into a buffer, using size and variable arguments.
- uwidth — Low level helper function for testing Unicode text data.
- uwidth_max — Number of bytes a character can occupy.

# v

- vector_length — Calculates the length of a vector.
- vector_length_f — Calculates the length of a vector.
- vline — Draws a vertical line onto the bitmap.
- voice_check — Checks whether a voice is currently allocated.
- voice_get_frequency — Returns the current pitch of the voice.
- voice_get_pan — Returns the current pan position.
- voice_get_position — Returns the current position of a voice.
- voice_get_volume — Returns the current volume of the voice.
- voice_ramp_volume — Starts a volume ramp for a voice.
- voice_set_echo — Sets the echo parameters for a voice.
- voice_set_frequency — Sets the pitch of the voice.
- voice_set_pan — Sets the pan position.
- voice_set_playmode — Adjusts the loop status of the specified voice.
- voice_set_position — Sets the position of a voice.
- voice_set_priority — Sets the priority of a voice.
- voice_set_tremolo — Sets the tremolo parameters for a voice.
- voice_set_vibrato — Sets the vibrato parameters for a voice.
- voice_set_volume — Sets the volume of the voice.
- voice_start — Activates a voice.
- voice_stop — Stops a voice.
- voice_stop_frequency_sweep — Interrupts a frequency sweep operation.
- voice_stop_pan_sweep — Interrupts a pan sweep operation.
- voice_stop_volumeramp — Interrupts a volume ramp operation.
- voice_sweep_frequency — Starts a frequency sweep for a voice.
- voice_sweep_pan — Starts a pan sweep for a voice.
- vsync — Waits for a vertical retrace to begin.

# w

- win_get_dc — Retrieves a handle to the device context.
- win_get_window — Retrieves a handle to the window used by Allegro.
- win_release_dc — Releases a handle to the device context.
- win_set_window — Registers an user-created window to be used by Allegro.
- win_set_wnd_create_proc — Registers a custom procedure to be used by Allegro for creating its window.

# x

- xor_mode — Shortcut for toggling xor drawing mode on and off.
- xwin_set_window_name — Specify the window name and group (or class).

Back to contents