DI-Guy API Version 12.5.1

This file was automatically generated from diguy_module_sound_openal.h. Do not edit this file directly; the changes will be lost.

Contents:

• Functions

Link against: libdiguy_module_sound_openal

Copyright (c) 2002, Xiph.org Foundation

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

- Neither the name of the Xiph.org Foundation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Prototype:

int diguy_sound_openal_initialize(bdiSoundInitOpenAL* init);

Description:

This function tells DI-Guy that it should use the OpenAL API for playing back sounds.

This function must be called before a scenario is created.

This function must be called after the main DI-Guy initialize call (e.g., diguy_ogl_initialize()).

Returns:

0 on success, -1 on failure

Example:

bdiSoundInitOpenAL init; diguy_ogl_initialize(NULL); diguy_script_perl_initialize(); diguy_sound_openal_get_defaults(&init); diguy_sound_openal_initialize(&init); diguyScenario* scenario = diguy_create_scenario();

Prototype:

int diguy_sound_openal_get_defaults(bdiSoundInitOpenAL* init);

Description:

Fills out the init structure with default values. Selected entries can then be changed before calling diguy_ogl_initialize().

Arguments:

init	pointer to type bdiGraphicsInitOgl

Returns:

0 on success, -1 on failure

Prototype:

int diguy_sound_openal_deinitialize();

Description:

This function tells DI-Guy to shut down the OpenAL DirectSound API for playing back sounds.

Returns:

0 on success, -1 on failure

Alphabetical Index

• diguy_sound_openal_deinitialize
• diguy_sound_openal_get_defaults
• diguy_sound_openal_initialize