Image I/O addon

These functions are declared in the following header file. Link with allegro_image.

 #include <allegro5/allegro_image.h>

Some of the format handlers define configuration options for specifying things like compression level or gamma handling. Refer to al_get_system_config for their documentation.

al_init_image_addon

bool al_init_image_addon(void)

Source Code

Initializes the image addon. This registers bitmap format handlers for al_load_bitmap, al_load_bitmap_f, al_save_bitmap, al_save_bitmap_f.

The following types are built into the Allegro image addon and guaranteed to be available: BMP, DDS, PCX, TGA. Every platform also supports JPEG and PNG via external dependencies.

Other formats may be available depending on the operating system and installed libraries, but are not guaranteed and should not be assumed to be universally available.

The DDS format is only supported to load from, and only if the DDS file contains textures compressed in the DXT1, DXT3 and DXT5 formats. Note that when loading a DDS file, the created bitmap will always be a video bitmap and will have the pixel format matching the format in the file.

Examples:

al_is_image_addon_initialized

bool al_is_image_addon_initialized(void)

Source Code

Returns true if the image addon is initialized, otherwise returns false.

Since: 5.2.6

al_shutdown_image_addon

void al_shutdown_image_addon(void)

Source Code

Shut down the image addon. This is done automatically at program exit, but can be called any time the user wishes as well.

al_get_allegro_image_version

uint32_t al_get_allegro_image_version(void)

Source Code

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

Allegro version 5.2.10 (20231119) - Last updated: 2024-03-10 06:21:14 UTC