Unit alWin

Use DirectSound device n (zero-based) with direct mixing.

See also

al_detect_digi_driver

Detects whether the specified digital sound device is available.

al_install_sound

Initialises the sound module.

al_install_sound_input

Use DirectSound device n (zero-based) with Allegro mixing.

See also

al_detect_digi_driver

Detects whether the specified digital sound device is available.

al_install_sound

Initialises the sound module.

al_install_sound_input

High or low quality WaveOut device.

Parameters

HighQuality

Tells if use high (True) or low (False) quality.

See also

al_detect_digi_driver

Detects whether the specified digital sound device is available.

al_install_sound

Initialises the sound module.

al_install_sound_input

Use win32 device n (zero-based)

See also

al_detect_midi_driver

Detects whether the specified MIDI sound device is available.

al_install_sound

Initialises the sound module.

al_install_sound_input

Retrieves a handle to the window used by Allegro. Note that Allegro uses an underlying window even though you don't set any graphics mode, unless you have installed the neutral system driver (AL_SYSTEM_NONE).

Registers an user-created window to be used by Allegro. This function is meant to be called before initialising the library with al_init or installing the autodetected system driver (AL_SYSTEM_AUTODETECT). It lets you attach Allegro to any already existing window and prevents the library from creating its own, thus leaving you total control over the window; in particular, you are responsible for processing the events as usual (Allegro will automatically monitor a few of them, but will not filter out any of them). You can then use every component of the library (graphics, mouse, keyboard, sound, timers and so on), bearing in mind that some Allegro functions are blocking (e.g. al_readkey) if the key buffer is empty) and thus must be carefully manipulated by the window thread.

However you can also call it after the library has been initialised, provided that no graphics mode is set. In this case the keyboard, mouse, joystick, sound and sound recording modules will be restarted.

Passing Nil instructs Allegro to switch back to its built-in window if an user-created window was registered, or to request a new handle from Windows for its built-in window if this was already in use.

Registers an user-defined procedure to be used by Allegro for creating its window. This function must be called before initializing the library with al_init or installing the autodetected system driver (AL_SYSTEM_AUTODETECT). It lets you customize Allegro's window but only by its creation: unlike with al_win_set_window, you have no control over the window once it has been created (in particular, you are not responsible for processing the events). The registered function will be passed a window procedure (WNDPROC object) that it must make the procedure of the new window of and it must return a handle to the new window. You can then use the full-featured library in the regular way.

Set a user callback to be called on window events. This callback function takes the same parameters as a normal window callback procedure plus an additional pointer to an integer. This pointer should be filled with a return value that must be set if the callback has completely processed the window event. If the callback has completely processed the window event, it should return 0 and fill retval with a proper value (the default is zero), otherwise it should return a non-zero value, and event processing will continue in Allegro's default window callback procedure.

Retrieves a handle to the device context of a DirectX video or system bitmap.

See also

al_win_release_dc

Releases a handle to the device context of the bitmap that was previously retrieved with al_win_get_dc.

Releases a handle to the device context of the bitmap that was previously retrieved with al_win_get_dc.

See also

al_win_get_dc

Retrieves a handle to the device context of a DirectX video or system bitmap.

Tells Allegro to use the GDI color layout for truecolor images. This is optional, but it will make the conversions work faster. If you are going to call this, you should do it right after initialising Allegro and before creating any graphics.

Selects and realizes an Allegro palette on the specified device context.

Converts an Allegro palette to a Windows palette and returns a handle to it. You should call DeleteObject when you no longer need it.

See also

al_convert_hpalette_to_palette

Converts a Windows palette to an Allegro palette.

Converts a Windows palette to an Allegro palette.

See also

al_convert_palette_to_hpalette

Converts an Allegro palette to a Windows palette and returns a handle to it.

Converts an Allegro memory bitmap to a Windows DDB and returns a handle to it. This bitmap uses its own memory, so you can destroy the original bitmap without affecting the converted one. You should call DeleteObject when you no longer need this bitmap.

See also

al_convert_hbitmap_to_bitmap

Creates an Allegro memory bitmap from a Windows DDB.

Creates an Allegro memory bitmap from a Windows DDB.

See also

al_convert_bitmap_to_hbitmap

Converts an Allegro memory bitmap to a Windows DDB and returns a handle to it.

Draws an entire Allegro bitmap to a Windows device context, using the same parameters as the al_draw_sprite procedure.

See also

al_blit_to_hdc

Blits an Allegro memory bitmap to a Windows device context, using the same parameters as the al_blit procedure.

al_stretch_blit_to_hdc

Blits an Allegro memory bitmap to a Windows device context, using the same parameters as the procedure.

al_draw_sprite

Draws a copy of the sprite bitmap onto the destination bitmap at the specified position.

Blits an Allegro memory bitmap to a Windows device context, using the same parameters as the al_blit procedure.

See also

al_draw_to_hdc

Draws an entire Allegro bitmap to a Windows device context, using the same parameters as the al_draw_sprite procedure.

al_stretch_blit_to_hdc

Blits an Allegro memory bitmap to a Windows device context, using the same parameters as the procedure.

al_blit_from_hdc

Blits from a Windows device context to an Allegro memory bitmap, using the same parameters as the al_blit procedure.

al_blit

Copies a rectangular area of the source bitmap to the destination bitmap.

Blits an Allegro memory bitmap to a Windows device context, using the same parameters as the procedure.

See also

al_stretch_blit

Like al_blit, except it can scale images (so the source and destination rectangles don't need to be the same size) and requires the source and destination bitmaps to be of the same color depth.

al_draw_to_hdc

Draws an entire Allegro bitmap to a Windows device context, using the same parameters as the al_draw_sprite procedure.

al_blit_to_hdc

Blits an Allegro memory bitmap to a Windows device context, using the same parameters as the al_blit procedure.

al_stretch_blit_from_hdc

Blits from a Windows device context to an Allegro memory bitmap, using the same parameters as the al_stretch_blit procedure.

al_stretch_blit

Like al_blit, except it can scale images (so the source and destination rectangles don't need to be the same size) and requires the source and destination bitmaps to be of the same color depth.

Blits from a Windows device context to an Allegro memory bitmap, using the same parameters as the al_blit procedure.

See also

al_stretch_blit_from_hdc

Blits from a Windows device context to an Allegro memory bitmap, using the same parameters as the al_stretch_blit procedure.

al_blit_to_hdc

Blits an Allegro memory bitmap to a Windows device context, using the same parameters as the al_blit procedure.

al_blit

Copies a rectangular area of the source bitmap to the destination bitmap.

Blits from a Windows device context to an Allegro memory bitmap, using the same parameters as the al_stretch_blit procedure. It uses the current Allegro palette and does conversion to this palette, regardless of the current DC palette. So if you are blitting from 8-bit mode, you should first set the DC palette with the al_set_palette_to_hdc procedure.

See also

al_blit_from_hdc

Blits from a Windows device context to an Allegro memory bitmap, using the same parameters as the al_blit procedure.

al_stretch_blit_to_hdc

Blits an Allegro memory bitmap to a Windows device context, using the same parameters as the procedure.

al_stretch_blit

Like al_blit, except it can scale images (so the source and destination rectangles don't need to be the same size) and requires the source and destination bitmaps to be of the same color depth.

See al_win_set_wnd_create_proc.

See al_win_set_msg_pre_proc.

DirectX system driver.

See also

al_install

Initialises the Allegro library.

Alias for AL_GFX_DIRECTX_ACCEL.

The regular fullscreen DirectX driver, running with hardware acceleration enabled.

See also

al_set_gfx_mode

Switches into graphics mode.

Simplified fullscreen DirectX driver that doesn't support any hardware acceleration, video or system bitmaps, etc.

See also

al_set_gfx_mode

Switches into graphics mode.

DirectX fullscreen driver that only uses software drawing, rather than any hardware accelerated features.

See also

al_set_gfx_mode

Switches into graphics mode.

The regular windowed DirectX driver, running in color conversion mode when the color depth doesn't match that of the Windows desktop. Color conversion is much slower than direct drawing and is not supported between 15-bit and 16-bit color depths. This limitation is needed to work around that of al_desktop_color_depth and allows to select the direct drawing mode in a reliable way on desktops reported as 16-bit.

Note that, mainly for performance reasons, this driver requires the width of the screen to be a multiple of 4. This driver is capable of displaying a hardware cursor, but there are size restrictions. Typically, the cursor image cannot be more than 32x32 pixels.

See also

al_set_gfx_mode

Switches into graphics mode.

he DirectX overlay driver. It uses special hardware features to run your program in a windowed mode: it doesn't work on all hardware, but performance is excellent on cards that are capable of it. It requires the color depth to be the same as that of the Windows desktop. In light of the limitation of al_desktop_color_depth, the reliable way of setting the overlay driver on desktops reported as 16-bit is:

  IF al_desktop_color_depth = 16 THEN
  BEGIN
    al_set_color_depth (16);
    IF NOT al_set_gfx_mode (AL_GFX_DIRECTX_OVL, 640, 480, 0, 0) THEN
    BEGIN
      al_set_color_depth (15);
      IF NOT al_set_gfx_mode (AL_GFX_DIRECTX_OVL, 640, 480, 0, 0) THEN
      // DirectX overlay driver not supported, so raise an error.
	RAISE Exception.Create ('640x480 overlay driver not supported.');
    END;
  // Ok, the 640x480 overlay driver is running.
  END;

See also

al_set_gfx_mode

Switches into graphics mode.

The windowed GDI driver. It is extremely slow, but is guaranteed to work on all hardware, so it can be useful for situations where you want to run in a window and don't care about performance. Note that this driver features a hardware mouse cursor emulation in order to speed up basic mouse operations (like GUI operations).

See also

al_set_gfx_mode

Switches into graphics mode.

Use win32 MIDI mapper.

See also

al_detect_midi_driver

Detects whether the specified MIDI sound device is available.

al_install_sound

Initialises the sound module.

al_install_sound_input

Use DirectInput to access the joystick.

See also

al_install_joystick

Installs Allegro's joystick handler, and calibrates the centre position values.

Use the regular Win32 interface rather than DirectInput to access the joystick.

See also

al_install_joystick

Installs Allegro's joystick handler, and calibrates the centre position values.