


install_allegro(3)        Allegro manual       install_allegro(3)


NNAAMMEE
       install_allegro - Initialise the Allegro library.

SSYYNNOOPPSSIISS
       ##iinncclluuddee <<aalllleeggrroo..hh>>


       iinntt     iinnssttaallll__aalllleeggrroo((iinntt     ssyysstteemm__iidd,,    iinntt    **eerrrrnnoo__ppttrr,,    iinntt
       ((**aatteexxiitt__ppttrr))(())));;

DDEESSCCRRIIPPTTIIOONN
       Initialises the Allegro library. You must call  either  this  or  alle-
       gro_init() before doing anything other than using the Unicode routines.
       If you want to use a text mode other than UTF-8, you can  set  it  with
       set_uformat()  before  you  call  this. The other functions that can be
       called before this one will be marked explicitly in the  documentation,
       like set_config_file().

       The  available  system ID codes will vary from one platform to another,
       but you will almost always want  to  pass  SYSTEM_AUTODETECT.  Alterna-
       tively,  SYSTEM_NONE  installs  a stripped down version of Allegro that
       won't even try to touch your hardware or do anything platform specific:
       this  can  be  useful  for situations where you only want to manipulate
       memory bitmaps, such as the text mode datafile tools or the Windows GDI
       interfacing functions.

       The  `errno_ptr'  and `atexit_ptr' parameters should point to the errno
       variable and atexit function from your libc: these are required because
       when  Allegro is linked as a DLL, it doesn't have direct access to your
       local libc data. `atexit_ptr' may be NULL, in which  case  it  is  your
       responsibility to call allegro_exit() manually. Example:

          install_allegro(SYSTEM_AUTODETECT, &errno, atexit);

RREETTUURRNN VVAALLUUEE
       This  function returns zero on success and non-zero on failure (e.g. no
       system driver could be used). Note: in  previous  versions  of  Allegro
       this function would abort on error.


SSEEEE AALLSSOO
       aalllleeggrroo__iinniitt(3), aalllleeggrroo__eexxiitt(3), sseett__uuffoorrmmaatt(3), sseett__ccoonnffiigg__ffiillee(3)















Allegro                   version 4.2.3                         1


