System

al_install_system

bool al_install_system(int (*atexit_ptr)(void (*)(void)))

Initialize the Allegro system. If atexit_ptr is non-NULL, and if hasn't been done already, al_uninstall_system() will be registered as an atexit function.

Returns true if Allegro was successfully initialized by this function call (or already was initialized previously), false if Allegro cannot be used.

See also: al_init

al_init

#define al_init()    (al_install_system(atexit))

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

See also: al_install_system

al_uninstall_system

void al_uninstall_system(void)

Closes down the Allegro system.

Note: al_uninstall_system() can be called without a corresponding al_install_system call, e.g. from atexit().

al_get_allegro_version

uint32_t al_get_allegro_version(void)

Returns the (compiled) version of the Allegro library, packed into a single integer as groups of 8 bits in the form (major << 24) | (minor << 16) | (revision << 8) | release.

You can use code like this to extract them:

uint32_t version = al_get_allegro_version();
int major = version >> 24;
int minor = (version >> 16) & 255;
int revision = (version >> 8) & 255;
int release = version & 255;

The release number is 0 for an unofficial version and 1 or greater for an official release. For example "5.0.2[1]" would be the (first) official 5.0.2 release while "5.0.2[0]" would be a compile of a version from the "5.0.2" branch before the official release.

al_get_standard_path

ALLEGRO_PATH *al_get_standard_path(int id)

Gets a system path, depending on the id parameter:

Returns NULL on failure.

See also: al_set_appname, al_set_orgname

al_set_appname

void al_set_appname(const char *appname)

Sets the global application name.

The Application name is used by al_get_standard_path to build the full path to an application's files.

Should be called once at the start of a program, before al_init or al_install_system and never touched again.

See also: al_get_appname, al_set_orgname

al_set_orgname

void al_set_orgname(const char *orgname)

Sets the global organization name.

The Organization name is used by al_get_standard_path to build the full path to an application's files.

Should be called once at the start of a program, before al_init or al_install_system and never touched again.

See also: al_get_orgname, al_set_appname

al_get_appname

const char *al_get_appname(void)

Returns the global application name string.

See also: al_set_appname

al_get_orgname

const char *al_get_orgname(void)

Returns the global organization name string.

See also: al_set_orgname

al_get_system_driver

ALLEGRO_SYSTEM *al_get_system_driver(void)

Returns the currently active system driver, or NULL.

al_get_system_config

ALLEGRO_CONFIG *al_get_system_config(void)

Returns the configuration for the installed system, if any, or NULL otherwise. This is mainly used for configuring Allegro and its addons.