doom3-gpl
Doom 3 GPL source release
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Macros | Functions
al.h File Reference
#include "altypes.h"

Go to the source code of this file.

Macros

#define ALAPI
 OpenAL cross platform audio library Copyright (C) 1999-2000 by authors. More...
 
#define ALAPIENTRY   __cdecl
 
#define AL_CALLBACK
 
#define OPENAL
 

Functions

ALAPI ALvoid ALAPIENTRY alEnable (ALenum capability)
 OpenAL Maintenance Functions Initialization and exiting. More...
 
ALAPI ALvoid ALAPIENTRY alDisable (ALenum capability)
 
ALAPI ALboolean ALAPIENTRY alIsEnabled (ALenum capability)
 
ALAPI ALvoid ALAPIENTRY alHint (ALenum target, ALenum mode)
 Application preferences for driver performance choices. More...
 
ALAPI ALboolean ALAPIENTRY alGetBoolean (ALenum param)
 State retrieval. More...
 
ALAPI ALint ALAPIENTRY alGetInteger (ALenum param)
 
ALAPI ALfloat ALAPIENTRY alGetFloat (ALenum param)
 
ALAPI ALdouble ALAPIENTRY alGetDouble (ALenum param)
 
ALAPI ALvoid ALAPIENTRY alGetBooleanv (ALenum param, ALboolean *data)
 
ALAPI ALvoid ALAPIENTRY alGetIntegerv (ALenum param, ALint *data)
 
ALAPI ALvoid ALAPIENTRY alGetFloatv (ALenum param, ALfloat *data)
 
ALAPI ALvoid ALAPIENTRY alGetDoublev (ALenum param, ALdouble *data)
 
ALAPI ALubyte *ALAPIENTRY alGetString (ALenum param)
 
ALAPI ALenum ALAPIENTRY alGetError (ALvoid)
 Error support. More...
 
ALAPI ALboolean ALAPIENTRY alIsExtensionPresent (ALubyte *fname)
 Extension support. More...
 
ALAPI ALvoid *ALAPIENTRY alGetProcAddress (ALubyte *fname)
 Extension support. More...
 
ALAPI ALenum ALAPIENTRY alGetEnumValue (ALubyte *ename)
 Extension support. More...
 
ALAPI ALvoid ALAPIENTRY alListeneri (ALenum param, ALint value)
 LISTENER Listener is the sample position for a given context. More...
 
ALAPI ALvoid ALAPIENTRY alListenerf (ALenum param, ALfloat value)
 Listener Gain: default 1.0f. More...
 
ALAPI ALvoid ALAPIENTRY alListener3f (ALenum param, ALfloat v1, ALfloat v2, ALfloat v3)
 Listener Position. More...
 
ALAPI ALvoid ALAPIENTRY alListenerfv (ALenum param, ALfloat *values)
 Listener Position: ALfloat[3] Listener Velocity: ALfloat[3] Listener Orientation: ALfloat[6] (forward and up vector). More...
 
ALAPI ALvoid ALAPIENTRY alGetListeneri (ALenum param, ALint *value)
 
ALAPI ALvoid ALAPIENTRY alGetListenerf (ALenum param, ALfloat *value)
 
ALAPI ALvoid ALAPIENTRY alGetListener3f (ALenum param, ALfloat *v1, ALfloat *v2, ALfloat *v3)
 
ALAPI ALvoid ALAPIENTRY alGetListenerfv (ALenum param, ALfloat *values)
 
ALAPI ALvoid ALAPIENTRY alGenSources (ALsizei n, ALuint *sources)
 SOURCE Source objects are by default localized. More...
 
ALAPI ALvoid ALAPIENTRY alDeleteSources (ALsizei n, ALuint *sources)
 Delete Source objects. More...
 
ALAPI ALboolean ALAPIENTRY alIsSource (ALuint id)
 Verify a handle is a valid Source. More...
 
ALAPI ALvoid ALAPIENTRY alSourcei (ALuint source, ALenum param, ALint value)
 Set an integer parameter for a Source object. More...
 
ALAPI ALvoid ALAPIENTRY alSourcef (ALuint source, ALenum param, ALfloat value)
 
ALAPI ALvoid ALAPIENTRY alSource3f (ALuint source, ALenum param, ALfloat v1, ALfloat v2, ALfloat v3)
 
ALAPI ALvoid ALAPIENTRY alSourcefv (ALuint source, ALenum param, ALfloat *values)
 
ALAPI ALvoid ALAPIENTRY alGetSourcei (ALuint source, ALenum param, ALint *value)
 Get an integer parameter for a Source object. More...
 
ALAPI ALvoid ALAPIENTRY alGetSourcef (ALuint source, ALenum param, ALfloat *value)
 
ALAPI ALvoid ALAPIENTRY alGetSource3f (ALuint source, ALenum param, ALfloat *v1, ALfloat *v2, ALfloat *v3)
 
ALAPI ALvoid ALAPIENTRY alGetSourcefv (ALuint source, ALenum param, ALfloat *values)
 
ALAPI ALvoid ALAPIENTRY alSourcePlayv (ALsizei n, ALuint *sources)
 
ALAPI ALvoid ALAPIENTRY alSourcePausev (ALsizei n, ALuint *sources)
 
ALAPI ALvoid ALAPIENTRY alSourceStopv (ALsizei n, ALuint *sources)
 
ALAPI ALvoid ALAPIENTRY alSourceRewindv (ALsizei n, ALuint *sources)
 
ALAPI ALvoid ALAPIENTRY alSourcePlay (ALuint source)
 Activate a source, start replay. More...
 
ALAPI ALvoid ALAPIENTRY alSourcePause (ALuint source)
 Pause a source, temporarily remove it from the mixer list. More...
 
ALAPI ALvoid ALAPIENTRY alSourceStop (ALuint source)
 Stop a source, temporarily remove it from the mixer list, and reset its internal state to pre-Play. More...
 
ALAPI ALvoid ALAPIENTRY alSourceRewind (ALuint source)
 Rewinds a source, temporarily remove it from the mixer list, and reset its internal state to pre-Play. More...
 
ALAPI ALvoid ALAPIENTRY alGenBuffers (ALsizei n, ALuint *buffers)
 BUFFER Buffer objects are storage space for sample data. More...
 
ALAPI ALvoid ALAPIENTRY alDeleteBuffers (ALsizei n, ALuint *buffers)
 
ALAPI ALboolean ALAPIENTRY alIsBuffer (ALuint buffer)
 
ALAPI ALvoid ALAPIENTRY alBufferData (ALuint buffer, ALenum format, ALvoid *data, ALsizei size, ALsizei freq)
 Specify the data to be filled into a buffer. More...
 
ALAPI ALvoid ALAPIENTRY alGetBufferi (ALuint buffer, ALenum param, ALint *value)
 
ALAPI ALvoid ALAPIENTRY alGetBufferf (ALuint buffer, ALenum param, ALfloat *value)
 
ALAPI ALvoid ALAPIENTRY alSourceQueueBuffers (ALuint source, ALsizei n, ALuint *buffers)
 Queue stuff. More...
 
ALAPI ALvoid ALAPIENTRY alSourceUnqueueBuffers (ALuint source, ALsizei n, ALuint *buffers)
 
ALAPI ALvoid ALAPIENTRY alDistanceModel (ALenum value)
 Knobs and dials. More...
 
ALAPI ALvoid ALAPIENTRY alDopplerFactor (ALfloat value)
 
ALAPI ALvoid ALAPIENTRY alDopplerVelocity (ALfloat value)
 

Macro Definition Documentation

#define AL_CALLBACK

Definition at line 45 of file al.h.

#define ALAPI

OpenAL cross platform audio library Copyright (C) 1999-2000 by authors.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details.

You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Or go to http://www.gnu.org/copyleft/lgpl.html

Definition at line 43 of file al.h.

#define ALAPIENTRY   __cdecl

Definition at line 44 of file al.h.

#define OPENAL

Definition at line 48 of file al.h.

Function Documentation

ALAPI ALvoid ALAPIENTRY alBufferData ( ALuint  buffer,
ALenum  format,
ALvoid data,
ALsizei  size,
ALsizei  freq 
)

Specify the data to be filled into a buffer.

Definition at line 81 of file stubs.cpp.

ALAPI ALvoid ALAPIENTRY alDeleteBuffers ( ALsizei  n,
ALuint buffers 
)

Definition at line 87 of file stubs.cpp.

ALAPI ALvoid ALAPIENTRY alDeleteSources ( ALsizei  n,
ALuint sources 
)

Delete Source objects.

ALAPI ALvoid ALAPIENTRY alDisable ( ALenum  capability)
ALAPI ALvoid ALAPIENTRY alDistanceModel ( ALenum  value)

Knobs and dials.

ALAPI ALvoid ALAPIENTRY alDopplerFactor ( ALfloat  value)
ALAPI ALvoid ALAPIENTRY alDopplerVelocity ( ALfloat  value)
ALAPI ALvoid ALAPIENTRY alEnable ( ALenum  capability)

OpenAL Maintenance Functions Initialization and exiting.

State Management and Query. Error Handling. Extension Support.State management.

ALAPI ALvoid ALAPIENTRY alGenBuffers ( ALsizei  n,
ALuint buffers 
)

BUFFER Buffer objects are storage space for sample data.

Buffers are referred to by Sources. There can be more than one Source using the same Buffer data. If Buffers have to be duplicated on a per-Source basis, the driver has to take care of allocation, copying, and deallocation as well as propagating buffer data changes.Buffer object generation.

Definition at line 39 of file stubs.cpp.

ALAPI ALvoid ALAPIENTRY alGenSources ( ALsizei  n,
ALuint sources 
)

SOURCE Source objects are by default localized.

Sources take the PCM data provided in the specified Buffer, apply Source-specific modifications, and then submit them to be mixed according to spatial arrangement etc.Create Source objects.

Definition at line 129 of file stubs.cpp.

ALAPI ALboolean ALAPIENTRY alGetBoolean ( ALenum  param)

State retrieval.

ALAPI ALvoid ALAPIENTRY alGetBooleanv ( ALenum  param,
ALboolean data 
)
ALAPI ALvoid ALAPIENTRY alGetBufferf ( ALuint  buffer,
ALenum  param,
ALfloat value 
)
ALAPI ALvoid ALAPIENTRY alGetBufferi ( ALuint  buffer,
ALenum  param,
ALint value 
)
ALAPI ALdouble ALAPIENTRY alGetDouble ( ALenum  param)
ALAPI ALvoid ALAPIENTRY alGetDoublev ( ALenum  param,
ALdouble data 
)
ALAPI ALenum ALAPIENTRY alGetEnumValue ( ALubyte ename)

Extension support.

Obtain the integer value of an enumeration (usually an extension) with the name ename.

ALAPI ALenum ALAPIENTRY alGetError ( ALvoid  )

Error support.

Obtain the most recent error generated in the AL state machine.

ALAPI ALfloat ALAPIENTRY alGetFloat ( ALenum  param)
ALAPI ALvoid ALAPIENTRY alGetFloatv ( ALenum  param,
ALfloat data 
)
ALAPI ALint ALAPIENTRY alGetInteger ( ALenum  param)

Definition at line 45 of file stubs.cpp.

ALAPI ALvoid ALAPIENTRY alGetIntegerv ( ALenum  param,
ALint data 
)
ALAPI ALvoid ALAPIENTRY alGetListener3f ( ALenum  param,
ALfloat v1,
ALfloat v2,
ALfloat v3 
)
ALAPI ALvoid ALAPIENTRY alGetListenerf ( ALenum  param,
ALfloat value 
)
ALAPI ALvoid ALAPIENTRY alGetListenerfv ( ALenum  param,
ALfloat values 
)
ALAPI ALvoid ALAPIENTRY alGetListeneri ( ALenum  param,
ALint value 
)
ALAPI ALvoid* ALAPIENTRY alGetProcAddress ( ALubyte fname)

Extension support.

Obtain the address of a function (usually an extension) with the name fname. All addresses are context-independent.

ALAPI ALvoid ALAPIENTRY alGetSource3f ( ALuint  source,
ALenum  param,
ALfloat v1,
ALfloat v2,
ALfloat v3 
)
ALAPI ALvoid ALAPIENTRY alGetSourcef ( ALuint  source,
ALenum  param,
ALfloat value 
)
ALAPI ALvoid ALAPIENTRY alGetSourcefv ( ALuint  source,
ALenum  param,
ALfloat values 
)
ALAPI ALvoid ALAPIENTRY alGetSourcei ( ALuint  source,
ALenum  param,
ALint value 
)

Get an integer parameter for a Source object.

Definition at line 43 of file stubs.cpp.

ALAPI ALubyte* ALAPIENTRY alGetString ( ALenum  param)
ALAPI ALvoid ALAPIENTRY alHint ( ALenum  target,
ALenum  mode 
)

Application preferences for driver performance choices.

ALAPI ALboolean ALAPIENTRY alIsBuffer ( ALuint  buffer)

Definition at line 122 of file stubs.cpp.

ALAPI ALboolean ALAPIENTRY alIsEnabled ( ALenum  capability)
ALAPI ALboolean ALAPIENTRY alIsExtensionPresent ( ALubyte fname)

Extension support.

Obtain the address of a function (usually an extension) with the name fname. All addresses are context-independent.

Definition at line 89 of file stubs.cpp.

ALAPI ALboolean ALAPIENTRY alIsSource ( ALuint  id)

Verify a handle is a valid Source.

Definition at line 35 of file stubs.cpp.

ALAPI ALvoid ALAPIENTRY alListener3f ( ALenum  param,
ALfloat  v1,
ALfloat  v2,
ALfloat  v3 
)

Listener Position.

Listener Velocity.

ALAPI ALvoid ALAPIENTRY alListenerf ( ALenum  param,
ALfloat  value 
)

Listener Gain: default 1.0f.

Definition at line 118 of file stubs.cpp.

ALAPI ALvoid ALAPIENTRY alListenerfv ( ALenum  param,
ALfloat values 
)

Listener Position: ALfloat[3] Listener Velocity: ALfloat[3] Listener Orientation: ALfloat[6] (forward and up vector).

ALAPI ALvoid ALAPIENTRY alListeneri ( ALenum  param,
ALint  value 
)

LISTENER Listener is the sample position for a given context.

The multi-channel (usually stereo) output stream generated by the mixer is parametrized by this Listener object: its position and velocity relative to Sources, within occluder and reflector geometry.

Listener Environment: default 0.

ALAPI ALvoid ALAPIENTRY alSource3f ( ALuint  source,
ALenum  param,
ALfloat  v1,
ALfloat  v2,
ALfloat  v3 
)

Definition at line 126 of file stubs.cpp.

ALAPI ALvoid ALAPIENTRY alSourcef ( ALuint  source,
ALenum  param,
ALfloat  value 
)

Definition at line 131 of file stubs.cpp.

ALAPI ALvoid ALAPIENTRY alSourcefv ( ALuint  source,
ALenum  param,
ALfloat values 
)
ALAPI ALvoid ALAPIENTRY alSourcei ( ALuint  source,
ALenum  param,
ALint  value 
)

Set an integer parameter for a Source object.

Definition at line 116 of file stubs.cpp.

ALAPI ALvoid ALAPIENTRY alSourcePause ( ALuint  source)

Pause a source, temporarily remove it from the mixer list.

ALAPI ALvoid ALAPIENTRY alSourcePausev ( ALsizei  n,
ALuint sources 
)
ALAPI ALvoid ALAPIENTRY alSourcePlay ( ALuint  source)

Activate a source, start replay.

Definition at line 135 of file stubs.cpp.

ALAPI ALvoid ALAPIENTRY alSourcePlayv ( ALsizei  n,
ALuint sources 
)
ALAPI ALvoid ALAPIENTRY alSourceQueueBuffers ( ALuint  source,
ALsizei  n,
ALuint buffers 
)

Queue stuff.

ALAPI ALvoid ALAPIENTRY alSourceRewind ( ALuint  source)

Rewinds a source, temporarily remove it from the mixer list, and reset its internal state to pre-Play.

ALAPI ALvoid ALAPIENTRY alSourceRewindv ( ALsizei  n,
ALuint sources 
)
ALAPI ALvoid ALAPIENTRY alSourceStop ( ALuint  source)

Stop a source, temporarily remove it from the mixer list, and reset its internal state to pre-Play.

To remove a Source completely, it has to be deleted following Stop, or before Play.

Definition at line 41 of file stubs.cpp.

ALAPI ALvoid ALAPIENTRY alSourceStopv ( ALsizei  n,
ALuint sources 
)
ALAPI ALvoid ALAPIENTRY alSourceUnqueueBuffers ( ALuint  source,
ALsizei  n,
ALuint buffers 
)

Definition at line 133 of file stubs.cpp.