DI-Guy SDK Documentation  13.7
diguy_module_sound_openal.h
Go to the documentation of this file.
1 
2 /*********************************************************************
3  ** Copyright (c) 1992-2022 MAK Technologies, Inc.
4  ** All rights reserved.
5  *********************************************************************/
6 
7 /*********************************************************************
8  **
9  *t DI-Guy API, OpenAL Sound Module
10  **
11  *b Link against: libdiguy_module_sound_openal
12  **
13  **
14  *============================================================================
15  **
16  *b Regarding Ogg Vorbis software used in this library:
17  **
18  ** Copyright (c) 2002, Xiph.org Foundation
19  **
20  ** Redistribution and use in source and binary forms, with or without
21  ** modification, are permitted provided that the following conditions
22  ** are met:
23  **
24  ** - Redistributions of source code must retain the above copyright
25  ** notice, this list of conditions and the following disclaimer.
26  **
27  ** - Redistributions in binary form must reproduce the above copyright
28  ** notice, this list of conditions and the following disclaimer in the
29  ** documentation and/or other materials provided with the distribution.
30  **
31  ** - Neither the name of the Xiph.org Foundation nor the names of its
32  ** contributors may be used to endorse or promote products derived from
33  ** this software without specific prior written permission.
34  **
35  ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
36  ** ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
37  ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
38  ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
39  ** CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
40  ** EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
41  ** PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
42  ** PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
43  ** LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
44  ** NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
45  ** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46  **
47  *============================================================================
48  **
49  */
50 
51 #ifndef __diguy_module_sound_openal_H
52 #define __diguy_module_sound_openal_H
53 
54 #include <declspec_diguy.h>
55 
56 extern "C" {
57 
58 /*
59  * The definition of this struct is in bdiSoundInitOpenAL.h
60  */
61 struct bdiSoundInitOpenAL;
62 
63 /*****************************************************************************
64  **
65  *2 Functions
66  **
67  */
68 
69 /*l
70  *b Description:
71  **
72  ** This function tells DI-Guy that it should use the OpenAL API for
73  ** playing back sounds.
74  **
75  ** This function must be called before a scenario is created.
76  **
77  ** This function must be called after the main DI-Guy initialize call
78  ** (e.g., diguy_ogl_initialize()).
79  **
80  *b Returns:
81  **
82  ** 0 on success, -1 on failure
83  **
84  *b Example:
85  **
86  *e bdiSoundInitOpenAL init;
87  *e
88  *e diguy_ogl_initialize(NULL);
89  *e diguy_script_lua_initialize();
90  *e diguy_sound_openal_get_defaults(&init);
91  *e diguy_sound_openal_initialize(&init);
92  *e
93  *e diguyScenario* scenario = diguy_create_scenario();
94  */
95 BDI_DECLSPEC_diguy
96 int diguy_sound_openal_initialize(bdiSoundInitOpenAL* init);
97 
98 /*l
99  *b Description:
100  **
101  ** Fills out the init structure with default values. Selected entries can
102  ** then be changed before calling diguy_sound_openal_initialize().
103  **
104  *b Arguments:
105  **
106  *a init - pointer to type bdiSoundInitOpenAL
107  **
108  *b Returns:
109  **
110  ** 0 on success, -1 on failure
111  */
112 BDI_DECLSPEC_diguy
113 int diguy_sound_openal_get_defaults(bdiSoundInitOpenAL* init);
114 
115 /*l
116  *b Description:
117  **
118  ** This function tells DI-Guy to shut down the OpenAL DirectSound API for
119  ** playing back sounds.
120  **
121  *b Returns:
122  **
123  ** 0 on success, -1 on failure
124  **
125  */
126 BDI_DECLSPEC_diguy
127 int diguy_sound_openal_deinitialize();
128 
129 
130 } /* end extern "C" */
131 
132 
133 #endif /* __diguy_module_sound_openal_H */
134 
diguy_sound_openal_get_defaults
int diguy_sound_openal_get_defaults(bdiSoundInitOpenAL *init)
Fills out the init structure with default values.
bdiSoundInitOpenAL
Definition: bdiSoundInitOpenAL.h:16
declspec_diguy.h
diguy_sound_openal_deinitialize
int diguy_sound_openal_deinitialize()
This function tells DI-Guy to shut down the OpenAL DirectSound API for playing back sounds...
diguy_sound_openal_initialize
int diguy_sound_openal_initialize(bdiSoundInitOpenAL *init)
This function tells DI-Guy that it should use the OpenAL API for playing back sounds.