doom3-gpl
Doom 3 GPL source release
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
al.h
Go to the documentation of this file.
1 #ifndef _AL_H_
2 #define _AL_H_
3 
23 #include "altypes.h"
24 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
29 #ifdef _WIN32
30  #ifdef _OPENAL32LIB
31  #define ALAPI __declspec(dllexport)
32  #else
33  #define ALAPI __declspec(dllimport)
34  #endif
35  #define ALAPIENTRY __cdecl
36  #define AL_CALLBACK
37 #else
38  #ifdef TARGET_OS_MAC
39  #if TARGET_OS_MAC
40  #pragma export on
41  #endif
42  #endif
43  #define ALAPI
44  #define ALAPIENTRY __cdecl
45  #define AL_CALLBACK
46 #endif
47 
48 #define OPENAL
49 
50 #ifndef AL_NO_PROTOTYPES
51 
61 ALAPI ALvoid ALAPIENTRY alEnable( ALenum capability );
62 ALAPI ALvoid ALAPIENTRY alDisable( ALenum capability );
63 ALAPI ALboolean ALAPIENTRY alIsEnabled( ALenum capability );
64 
66 ALAPI ALvoid ALAPIENTRY alHint( ALenum target, ALenum mode );
67 
69 ALAPI ALboolean ALAPIENTRY alGetBoolean( ALenum param );
70 ALAPI ALint ALAPIENTRY alGetInteger( ALenum param );
71 ALAPI ALfloat ALAPIENTRY alGetFloat( ALenum param );
72 ALAPI ALdouble ALAPIENTRY alGetDouble( ALenum param );
73 ALAPI ALvoid ALAPIENTRY alGetBooleanv( ALenum param, ALboolean* data );
74 ALAPI ALvoid ALAPIENTRY alGetIntegerv( ALenum param, ALint* data );
75 ALAPI ALvoid ALAPIENTRY alGetFloatv( ALenum param, ALfloat* data );
76 ALAPI ALvoid ALAPIENTRY alGetDoublev( ALenum param, ALdouble* data );
77 ALAPI ALubyte* ALAPIENTRY alGetString( ALenum param );
78 
83 ALAPI ALenum ALAPIENTRY alGetError( ALvoid );
84 
85 
91 ALAPI ALboolean ALAPIENTRY alIsExtensionPresent( ALubyte* fname );
92 
93 
99 ALAPI ALvoid* ALAPIENTRY alGetProcAddress( ALubyte* fname );
100 
101 
106 ALAPI ALenum ALAPIENTRY alGetEnumValue( ALubyte* ename );
107 
108 
109 
110 
126 ALAPI ALvoid ALAPIENTRY alListeneri( ALenum param, ALint value );
127 
128 
133 ALAPI ALvoid ALAPIENTRY alListenerf( ALenum param, ALfloat value );
134 
135 
141 ALAPI ALvoid ALAPIENTRY alListener3f( ALenum param, ALfloat v1, ALfloat v2, ALfloat v3 );
142 
143 
150 ALAPI ALvoid ALAPIENTRY alListenerfv( ALenum param, ALfloat* values );
151 
152 ALAPI ALvoid ALAPIENTRY alGetListeneri( ALenum param, ALint* value );
153 ALAPI ALvoid ALAPIENTRY alGetListenerf( ALenum param, ALfloat* value );
154 ALAPI ALvoid ALAPIENTRY alGetListener3f( ALenum param, ALfloat* v1, ALfloat* v2, ALfloat* v3 );
155 ALAPI ALvoid ALAPIENTRY alGetListenerfv( ALenum param, ALfloat* values );
156 
157 
170 ALAPI ALvoid ALAPIENTRY alGenSources( ALsizei n, ALuint* sources );
171 
173 ALAPI ALvoid ALAPIENTRY alDeleteSources( ALsizei n, ALuint* sources );
174 
176 ALAPI ALboolean ALAPIENTRY alIsSource( ALuint id );
177 
179 ALAPI ALvoid ALAPIENTRY alSourcei( ALuint source, ALenum param, ALint value );
180 ALAPI ALvoid ALAPIENTRY alSourcef( ALuint source, ALenum param, ALfloat value );
181 ALAPI ALvoid ALAPIENTRY alSource3f( ALuint source, ALenum param, ALfloat v1, ALfloat v2, ALfloat v3 );
182 ALAPI ALvoid ALAPIENTRY alSourcefv( ALuint source, ALenum param, ALfloat* values );
183 
185 ALAPI ALvoid ALAPIENTRY alGetSourcei( ALuint source, ALenum param, ALint* value );
186 ALAPI ALvoid ALAPIENTRY alGetSourcef( ALuint source, ALenum param, ALfloat* value );
187 ALAPI ALvoid ALAPIENTRY alGetSource3f( ALuint source, ALenum param, ALfloat* v1, ALfloat* v2, ALfloat* v3 );
188 ALAPI ALvoid ALAPIENTRY alGetSourcefv( ALuint source, ALenum param, ALfloat* values );
189 
190 ALAPI ALvoid ALAPIENTRY alSourcePlayv( ALsizei n, ALuint *sources );
191 ALAPI ALvoid ALAPIENTRY alSourcePausev( ALsizei n, ALuint *sources );
192 ALAPI ALvoid ALAPIENTRY alSourceStopv( ALsizei n, ALuint *sources );
193 ALAPI ALvoid ALAPIENTRY alSourceRewindv(ALsizei n,ALuint *sources);
194 
196 ALAPI ALvoid ALAPIENTRY alSourcePlay( ALuint source );
197 
202 ALAPI ALvoid ALAPIENTRY alSourcePause( ALuint source );
203 
211 ALAPI ALvoid ALAPIENTRY alSourceStop( ALuint source );
212 
218 ALAPI ALvoid ALAPIENTRY alSourceRewind( ALuint source );
219 
220 
221 
236 ALAPI ALvoid ALAPIENTRY alGenBuffers( ALsizei n, ALuint* buffers );
237 ALAPI ALvoid ALAPIENTRY alDeleteBuffers( ALsizei n, ALuint* buffers );
238 ALAPI ALboolean ALAPIENTRY alIsBuffer( ALuint buffer );
239 
243 ALAPI ALvoid ALAPIENTRY alBufferData( ALuint buffer,
244  ALenum format,
245  ALvoid* data,
246  ALsizei size,
247  ALsizei freq );
248 
249 
250 ALAPI ALvoid ALAPIENTRY alGetBufferi( ALuint buffer, ALenum param, ALint* value );
251 ALAPI ALvoid ALAPIENTRY alGetBufferf( ALuint buffer, ALenum param, ALfloat* value );
252 
253 
254 
255 
260 ALAPI ALvoid ALAPIENTRY alSourceQueueBuffers( ALuint source, ALsizei n, ALuint* buffers );
261 ALAPI ALvoid ALAPIENTRY alSourceUnqueueBuffers( ALuint source, ALsizei n, ALuint* buffers );
262 
266 ALAPI ALvoid ALAPIENTRY alDistanceModel( ALenum value );
267 ALAPI ALvoid ALAPIENTRY alDopplerFactor( ALfloat value );
268 ALAPI ALvoid ALAPIENTRY alDopplerVelocity( ALfloat value );
269 
270 #else /* AL_NO_PROTOTYPES */
271 
281 ALAPI ALvoid ALAPIENTRY (*alEnable)( ALenum capability );
282 ALAPI ALvoid ALAPIENTRY (*alDisable)( ALenum capability );
283 ALAPI ALboolean ALAPIENTRY (*alIsEnabled)( ALenum capability );
284 
286 ALAPI ALvoid ALAPIENTRY (*alHint)( ALenum target, ALenum mode );
287 
289 ALAPI ALboolean ALAPIENTRY (*alGetBoolean)( ALenum param );
290 ALAPI ALint ALAPIENTRY (*alGetInteger)( ALenum param );
291 ALAPI ALfloat ALAPIENTRY (*alGetFloat)( ALenum param );
292 ALAPI ALdouble ALAPIENTRY (*alGetDouble)( ALenum param );
293 ALAPI ALvoid ALAPIENTRY (*alGetBooleanv)( ALenum param, ALboolean* data );
294 ALAPI ALvoid ALAPIENTRY (*alGetIntegerv)( ALenum param, ALint* data );
295 ALAPI ALvoid ALAPIENTRY (*alGetFloatv)( ALenum param, ALfloat* data );
296 ALAPI ALvoid ALAPIENTRY (*alGetDoublev)( ALenum param, ALdouble* data );
297 ALAPI ALubyte* ALAPIENTRY (*alGetString)( ALenum param );
298 
303 ALAPI ALenum ALAPIENTRY (*alGetError)( ALvoid );
304 
305 
311 ALAPI ALboolean ALAPIENTRY (*alIsExtensionPresent)( ALubyte* fname );
312 
313 
319 ALAPI ALvoid* ALAPIENTRY (*alGetProcAddress)( ALubyte* fname );
320 
321 
326 ALAPI ALenum ALAPIENTRY (*alGetEnumValue)( ALubyte* ename );
327 
328 
329 
330 
346 ALAPI ALvoid ALAPIENTRY (*alListeneri)( ALenum param, ALint value );
347 
348 
353 ALAPI ALvoid ALAPIENTRY (*alListenerf)( ALenum param, ALfloat value );
354 
355 
361 ALAPI ALvoid ALAPIENTRY (*alListener3f)( ALenum param, ALfloat v1, ALfloat v2, ALfloat v3 );
362 
363 
370 ALAPI ALvoid ALAPIENTRY (*alListenerfv)( ALenum param, ALfloat* values );
371 
372 ALAPI ALvoid ALAPIENTRY (*alGetListeneri)( ALenum param, ALint* value );
373 ALAPI ALvoid ALAPIENTRY (*alGetListenerf)( ALenum param, ALfloat* value );
374 ALAPI ALvoid ALAPIENTRY (*alGetListener3f)( ALenum param, ALfloat* v1, ALfloat* v2, ALfloat* v3 );
375 ALAPI ALvoid ALAPIENTRY (*alGetListenerfv)( ALenum param, ALfloat* values );
376 
377 
390 ALAPI ALvoid ALAPIENTRY (*alGenSources)( ALsizei n, ALuint* sources );
391 
393 ALAPI ALvoid ALAPIENTRY (*alDeleteSources)( ALsizei n, ALuint* sources );
394 
396 ALAPI ALboolean ALAPIENTRY (*alIsSource)( ALuint id );
397 
399 ALAPI ALvoid ALAPIENTRY (*alSourcei)( ALuint source, ALenum param, ALint value );
400 ALAPI ALvoid ALAPIENTRY (*alSourcef)( ALuint source, ALenum param, ALfloat value );
401 ALAPI ALvoid ALAPIENTRY (*alSource3f)( ALuint source, ALenum param, ALfloat v1, ALfloat v2, ALfloat v3 );
402 ALAPI ALvoid ALAPIENTRY (*alSourcefv)( ALuint source, ALenum param, ALfloat* values );
403 
405 ALAPI ALvoid ALAPIENTRY (*alGetSourcei)( ALuint source, ALenum param, ALint* value );
406 ALAPI ALvoid ALAPIENTRY (*alGetSourcef)( ALuint source, ALenum param, ALfloat* value );
407 ALAPI ALvoid ALAPIENTRY (*alGetSourcefv)( ALuint source, ALenum param, ALfloat* values );
408 
409 ALAPI ALvoid ALAPIENTRY (*alSourcePlayv)( ALsizei n, ALuint *sources );
410 ALAPI ALvoid ALAPIENTRY (*alSourceStopv)( ALsizei n, ALuint *sources );
411 
413 ALAPI ALvoid ALAPIENTRY (*alSourcePlay)( ALuint source );
414 
419 ALAPI ALvoid ALAPIENTRY (*alSourcePause)( ALuint source );
420 
428 ALAPI ALvoid ALAPIENTRY (*alSourceStop)( ALuint source );
429 
430 
431 
446 ALAPI ALvoid ALAPIENTRY (*alGenBuffers)( ALsizei n, ALuint* buffers );
447 ALAPI ALvoid ALAPIENTRY (*alDeleteBuffers)( ALsizei n, ALuint* buffers );
448 ALAPI ALboolean ALAPIENTRY (*alIsBuffer)( ALuint buffer );
449 
453 ALAPI ALvoid ALAPIENTRY (*alBufferData)( ALuint buffer,
454  ALenum format,
455  ALvoid* data,
456  ALsizei size,
457  ALsizei freq );
458 
459 ALAPI ALvoid ALAPIENTRY (*alGetBufferi)( ALuint buffer, ALenum param, ALint* value );
460 ALAPI ALvoid ALAPIENTRY (*alGetBufferf)( ALuint buffer, ALenum param, ALfloat* value );
461 
462 
463 
464 
468 ALAPI ALvoid ALAPIENTRY (*alSourceQueueBuffers)( ALuint source, ALsizei n, ALuint* buffers );
469 ALAPI ALvoid ALAPIENTRY (*alSourceUnqueueBuffers)( ALuint source, ALsizei n, ALuint* buffers );
470 
474 ALAPI ALvoid ALAPIENTRY (*alDistanceModel)( ALenum value );
475 ALAPI ALvoid ALAPIENTRY (*alDopplerFactor)( ALfloat value );
476 ALAPI ALvoid ALAPIENTRY (*alDopplerVelocity)( ALfloat value );
477 
478 #endif /* AL_NO_PROTOTYPES */
479 
480 #ifdef TARGET_OS_MAC
481  #if TARGET_OS_MAC
482  #pragma export off
483  #endif
484 #endif
485 
486 #ifdef __cplusplus
487 }
488 #endif
489 
490 #endif
491 
alIsSource
ALAPI ALboolean ALAPIENTRY alIsSource(ALuint id)
Verify a handle is a valid Source.
Definition: stubs.cpp:35
alListenerfv
ALAPI ALvoid ALAPIENTRY alListenerfv(ALenum param, ALfloat *values)
Listener Position: ALfloat[3] Listener Velocity: ALfloat[3] Listener Orientation: ALfloat[6] (forward...
alDistanceModel
ALAPI ALvoid ALAPIENTRY alDistanceModel(ALenum value)
Knobs and dials.
alGetEnumValue
ALAPI ALenum ALAPIENTRY alGetEnumValue(ALubyte *ename)
Extension support.
values
GLboolean GLenum GLenum GLvoid * values
Definition: glext.h:2868
value
GLsizei const GLfloat * value
Definition: glext.h:3614
ALint
int ALint
OpenAL 32bit signed integer type.
Definition: altypes.h:48
alGetSourcefv
ALAPI ALvoid ALAPIENTRY alGetSourcefv(ALuint source, ALenum param, ALfloat *values)
alGetBoolean
ALAPI ALboolean ALAPIENTRY alGetBoolean(ALenum param)
State retrieval.
alGetError
ALAPI ALenum ALAPIENTRY alGetError(ALvoid)
Error support.
alGetDouble
ALAPI ALdouble ALAPIENTRY alGetDouble(ALenum param)
alGetDoublev
ALAPI ALvoid ALAPIENTRY alGetDoublev(ALenum param, ALdouble *data)
alDopplerVelocity
ALAPI ALvoid ALAPIENTRY alDopplerVelocity(ALfloat value)
alSourceStop
ALAPI ALvoid ALAPIENTRY alSourceStop(ALuint source)
Stop a source, temporarily remove it from the mixer list, and reset its internal state to pre-Play...
Definition: stubs.cpp:41
alGetIntegerv
ALAPI ALvoid ALAPIENTRY alGetIntegerv(ALenum param, ALint *data)
alIsEnabled
ALAPI ALboolean ALAPIENTRY alIsEnabled(ALenum capability)
format
GLenum GLsizei GLenum format
Definition: glext.h:2846
ALAPI
#define ALAPI
OpenAL cross platform audio library Copyright (C) 1999-2000 by authors.
Definition: al.h:43
ALAPIENTRY
#define ALAPIENTRY
Definition: al.h:44
alSourcePlayv
ALAPI ALvoid ALAPIENTRY alSourcePlayv(ALsizei n, ALuint *sources)
param
GLfloat param
Definition: glext.h:3038
n
GLenum GLsizei n
Definition: glext.h:3705
alGetBufferf
ALAPI ALvoid ALAPIENTRY alGetBufferf(ALuint buffer, ALenum param, ALfloat *value)
alGetListeneri
ALAPI ALvoid ALAPIENTRY alGetListeneri(ALenum param, ALint *value)
alGetBooleanv
ALAPI ALvoid ALAPIENTRY alGetBooleanv(ALenum param, ALboolean *data)
buffers
const GLuint * buffers
Definition: glext.h:3109
alIsExtensionPresent
ALAPI ALboolean ALAPIENTRY alIsExtensionPresent(ALubyte *fname)
Extension support.
Definition: stubs.cpp:89
alSourceRewind
ALAPI ALvoid ALAPIENTRY alSourceRewind(ALuint source)
Rewinds a source, temporarily remove it from the mixer list, and reset its internal state to pre-Play...
alGetListenerf
ALAPI ALvoid ALAPIENTRY alGetListenerf(ALenum param, ALfloat *value)
alBufferData
ALAPI ALvoid ALAPIENTRY alBufferData(ALuint buffer, ALenum format, ALvoid *data, ALsizei size, ALsizei freq)
Specify the data to be filled into a buffer.
Definition: stubs.cpp:81
ALubyte
unsigned char ALubyte
OpenAL 8bit unsigned byte.
Definition: altypes.h:36
alSource3f
ALAPI ALvoid ALAPIENTRY alSource3f(ALuint source, ALenum param, ALfloat v1, ALfloat v2, ALfloat v3)
Definition: stubs.cpp:126
alGetFloatv
ALAPI ALvoid ALAPIENTRY alGetFloatv(ALenum param, ALfloat *data)
alGenBuffers
ALAPI ALvoid ALAPIENTRY alGenBuffers(ALsizei n, ALuint *buffers)
BUFFER Buffer objects are storage space for sample data.
Definition: stubs.cpp:39
alListener3f
ALAPI ALvoid ALAPIENTRY alListener3f(ALenum param, ALfloat v1, ALfloat v2, ALfloat v3)
Listener Position.
ALfloat
float ALfloat
OpenAL 32bit floating point type.
Definition: altypes.h:51
alSourcePlay
ALAPI ALvoid ALAPIENTRY alSourcePlay(ALuint source)
Activate a source, start replay.
Definition: stubs.cpp:135
alSourcePause
ALAPI ALvoid ALAPIENTRY alSourcePause(ALuint source)
Pause a source, temporarily remove it from the mixer list.
ALuint
unsigned ALuint
OpenAL 32bit unsigned integer type.
Definition: altypes.h:45
source
GLsizei GLsizei GLcharARB * source
Definition: glext.h:3633
ALsizei
unsigned int ALsizei
OpenAL 32bit type.
Definition: altypes.h:57
v2
GLfloat GLfloat GLfloat v2
Definition: glext.h:3608
alGetSource3f
ALAPI ALvoid ALAPIENTRY alGetSource3f(ALuint source, ALenum param, ALfloat *v1, ALfloat *v2, ALfloat *v3)
ALboolean
char ALboolean
OpenAL cross platform audio library Copyright (C) 1999-2000 by authors.
Definition: altypes.h:30
alSourceUnqueueBuffers
ALAPI ALvoid ALAPIENTRY alSourceUnqueueBuffers(ALuint source, ALsizei n, ALuint *buffers)
Definition: stubs.cpp:133
alSourceRewindv
ALAPI ALvoid ALAPIENTRY alSourceRewindv(ALsizei n, ALuint *sources)
alSourceQueueBuffers
ALAPI ALvoid ALAPIENTRY alSourceQueueBuffers(ALuint source, ALsizei n, ALuint *buffers)
Queue stuff.
alSourcei
ALAPI ALvoid ALAPIENTRY alSourcei(ALuint source, ALenum param, ALint value)
Set an integer parameter for a Source object.
Definition: stubs.cpp:116
alDeleteBuffers
ALAPI ALvoid ALAPIENTRY alDeleteBuffers(ALsizei n, ALuint *buffers)
Definition: stubs.cpp:87
alEnable
ALAPI ALvoid ALAPIENTRY alEnable(ALenum capability)
OpenAL Maintenance Functions Initialization and exiting.
alSourceStopv
ALAPI ALvoid ALAPIENTRY alSourceStopv(ALsizei n, ALuint *sources)
data
GLsizei GLsizei GLenum GLenum const GLvoid * data
Definition: glext.h:2853
buffer
GLuint buffer
Definition: glext.h:3108
alGetSourcei
ALAPI ALvoid ALAPIENTRY alGetSourcei(ALuint source, ALenum param, ALint *value)
Get an integer parameter for a Source object.
Definition: stubs.cpp:43
alGetSourcef
ALAPI ALvoid ALAPIENTRY alGetSourcef(ALuint source, ALenum param, ALfloat *value)
alHint
ALAPI ALvoid ALAPIENTRY alHint(ALenum target, ALenum mode)
Application preferences for driver performance choices.
mode
GLint mode
Definition: glext.h:4165
alDeleteSources
ALAPI ALvoid ALAPIENTRY alDeleteSources(ALsizei n, ALuint *sources)
Delete Source objects.
alGetListener3f
ALAPI ALvoid ALAPIENTRY alGetListener3f(ALenum param, ALfloat *v1, ALfloat *v2, ALfloat *v3)
alSourcePausev
ALAPI ALvoid ALAPIENTRY alSourcePausev(ALsizei n, ALuint *sources)
v1
GLfloat GLfloat v1
Definition: glext.h:3607
ALdouble
double ALdouble
OpenAL 64bit double point type.
Definition: altypes.h:54
alSourcefv
ALAPI ALvoid ALAPIENTRY alSourcefv(ALuint source, ALenum param, ALfloat *values)
alListenerf
ALAPI ALvoid ALAPIENTRY alListenerf(ALenum param, ALfloat value)
Listener Gain: default 1.0f.
Definition: stubs.cpp:118
v3
GLfloat GLfloat GLfloat GLfloat v3
Definition: glext.h:3609
ALvoid
void ALvoid
OpenAL void type.
Definition: altypes.h:60
id
GLuint id
Definition: glext.h:3103
alDopplerFactor
ALAPI ALvoid ALAPIENTRY alDopplerFactor(ALfloat value)
alGenSources
ALAPI ALvoid ALAPIENTRY alGenSources(ALsizei n, ALuint *sources)
SOURCE Source objects are by default localized.
Definition: stubs.cpp:129
size
GLsizeiptr size
Definition: glext.h:3112
alIsBuffer
ALAPI ALboolean ALAPIENTRY alIsBuffer(ALuint buffer)
Definition: stubs.cpp:122
alListeneri
ALAPI ALvoid ALAPIENTRY alListeneri(ALenum param, ALint value)
LISTENER Listener is the sample position for a given context.
ALenum
int ALenum
OpenAL enumerations.
Definition: altypes.h:63
alGetBufferi
ALAPI ALvoid ALAPIENTRY alGetBufferi(ALuint buffer, ALenum param, ALint *value)
alGetProcAddress
ALAPI ALvoid *ALAPIENTRY alGetProcAddress(ALubyte *fname)
Extension support.
alGetString
ALAPI ALubyte *ALAPIENTRY alGetString(ALenum param)
alGetInteger
ALAPI ALint ALAPIENTRY alGetInteger(ALenum param)
Definition: stubs.cpp:45
alGetFloat
ALAPI ALfloat ALAPIENTRY alGetFloat(ALenum param)
alSourcef
ALAPI ALvoid ALAPIENTRY alSourcef(ALuint source, ALenum param, ALfloat value)
Definition: stubs.cpp:131
alGetListenerfv
ALAPI ALvoid ALAPIENTRY alGetListenerfv(ALenum param, ALfloat *values)
alDisable
ALAPI ALvoid ALAPIENTRY alDisable(ALenum capability)
This page is maintained by Wladimir van der Laan. Generated on Mon Nov 17 2014 12:23:24 for doom3-gpl by doxygen 1.8.6.