System

al_get_appname

AL_CONST char *al_get_appname(void)

Returns the global application name string.

al_get_orgname

AL_CONST char *al_get_orgname(void)

Returns the global organization name string.

al_get_standard_path

ALLEGRO_PATH *al_get_standard_path(int id)

Gets a system path, depending on the id parameter:

iddescription
ALLEGRO_PROGRAM_PATHDirectory with the executed program.
ALLEGRO_TEMP_PATHPath to the directory for temporary files.
ALLEGRO_SYSTEM_DATA_PATHData path for system-wide installation.
ALLEGRO_USER_DATA_PATHData path for per-user installation.
ALLEGRO_USER_HOME_PATHPath to the user's home directory.
ALLEGRO_USER_SETTINGS_PATHPath to per-user settings directory.
ALLEGRO_SYSTEM_SETTINGS_PATHPath to system-wide settings directory.
ALLEGRO_EXENAME_PATHThe full path to the executable.

Returns NULL on failure.

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.

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.

al_set_appname

void al_set_appname(AL_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.

al_set_orgname

void al_set_orgname(AL_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.

al_system_driver

ALLEGRO_SYSTEM *al_system_driver(void)

Returns the currently active_sysdrv system driver.

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().

Last updated: 2009-06-07 09:43:08 UTC