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

Go to the source code of this file.

Macros

#define AL_INVALID   (-1)
 
#define AL_NONE   0
 
#define AL_FALSE   0
 
#define AL_TRUE   1
 
#define AL_SOURCE_TYPE   0x200
 Indicate the type of AL_SOURCE. More...
 
#define AL_SOURCE_ABSOLUTE   0x201
 Indicate source has absolute coordinates. More...
 
#define AL_SOURCE_RELATIVE   0x202
 Indicate Source has listener relative coordinates. More...
 
#define AL_CONE_INNER_ANGLE   0x1001
 Directional source, inner cone angle, in degrees. More...
 
#define AL_CONE_OUTER_ANGLE   0x1002
 Directional source, outer cone angle, in degrees. More...
 
#define AL_PITCH   0x1003
 Specify the pitch to be applied, either at source, or on mixer results, at listener. More...
 
#define AL_POSITION   0x1004
 Specify the current location in three dimensional space. More...
 
#define AL_DIRECTION   0x1005
 Specify the current direction as forward vector. More...
 
#define AL_VELOCITY   0x1006
 Specify the current velocity in three dimensional space. More...
 
#define AL_LOOPING   0x1007
 Indicate whether source has to loop infinite. More...
 
#define AL_BUFFER   0x1009
 Indicate the buffer to provide sound samples. More...
 
#define AL_GAIN   0x100A
 Indicate the gain (volume amplification) applied. More...
 
#define AL_MIN_GAIN   0x100D
 Indicate minimum source attenuation. More...
 
#define AL_MAX_GAIN   0x100E
 Indicate maximum source attenuation. More...
 
#define AL_ORIENTATION   0x100F
 Specify the current orientation. More...
 
#define AL_REFERENCE_DISTANCE   0x1020
 
#define AL_ROLLOFF_FACTOR   0x1021
 Indicate the rolloff factor for the source. More...
 
#define AL_CONE_OUTER_GAIN   0x1022
 Indicate the gain (volume amplification) applied. More...
 
#define AL_MAX_DISTANCE   0x1023
 Specify the maximum distance. More...
 
#define AL_CHANNEL_MASK   0x3000
 Specify the channel mask. More...
 
#define AL_SOURCE_STATE   0x1010
 Source state information. More...
 
#define AL_INITIAL   0x1011
 
#define AL_PLAYING   0x1012
 
#define AL_PAUSED   0x1013
 
#define AL_STOPPED   0x1014
 
#define AL_BUFFERS_QUEUED   0x1015
 Buffer Queue params. More...
 
#define AL_BUFFERS_PROCESSED   0x1016
 
#define AL_FORMAT_MONO8   0x1100
 Sound buffers: format specifier. More...
 
#define AL_FORMAT_MONO16   0x1101
 
#define AL_FORMAT_STEREO8   0x1102
 
#define AL_FORMAT_STEREO16   0x1103
 
#define AL_FREQUENCY   0x2001
 Sound buffers: frequency, in units of Hertz [Hz]. More...
 
#define AL_BITS   0x2002
 
#define AL_CHANNELS   0x2003
 
#define AL_SIZE   0x2004
 
#define AL_DATA   0x2005
 
#define AL_UNUSED   0x2010
 Buffer state. More...
 
#define AL_PENDING   0x2011
 
#define AL_PROCESSED   0x2012
 
#define AL_NO_ERROR   AL_FALSE
 Errors: No Error. More...
 
#define AL_INVALID_NAME   0xA001
 Illegal name passed as an argument to an AL call. More...
 
#define AL_INVALID_ENUM   0xA002
 Illegal enum passed as an argument to an AL call. More...
 
#define AL_INVALID_VALUE   0xA003
 Illegal value passed as an argument to an AL call. More...
 
#define AL_INVALID_OPERATION   0xA004
 A function was called at inappropriate time, or in an inappropriate way, causing an illegal state. More...
 
#define AL_OUT_OF_MEMORY   0xA005
 A function could not be completed, because there is not enough memory available. More...
 
#define AL_VENDOR   0xB001
 Context strings: Vendor Name. More...
 
#define AL_VERSION   0xB002
 
#define AL_RENDERER   0xB003
 
#define AL_EXTENSIONS   0xB004
 
#define AL_DOPPLER_FACTOR   0xC000
 Global tweakage. More...
 
#define AL_DOPPLER_VELOCITY   0xC001
 Doppler velocity. More...
 
#define AL_DISTANCE_MODEL   0xD000
 Distance model. More...
 
#define AL_INVERSE_DISTANCE   0xD001
 Distance models. More...
 
#define AL_INVERSE_DISTANCE_CLAMPED   0xD002
 

Typedefs

typedef char ALboolean = NULL
 OpenAL cross platform audio library Copyright (C) 1999-2000 by authors. More...
 
typedef char ALbyte
 OpenAL 8bit signed byte. More...
 
typedef unsigned char ALubyte
 OpenAL 8bit unsigned byte. More...
 
typedef short ALshort
 OpenAL 16bit signed short integer type. More...
 
typedef unsigned short ALushort
 OpenAL 16bit unsigned short integer type. More...
 
typedef unsigned ALuint
 OpenAL 32bit unsigned integer type. More...
 
typedef int ALint
 OpenAL 32bit signed integer type. More...
 
typedef float ALfloat = NULL
 OpenAL 32bit floating point type. More...
 
typedef double ALdouble
 OpenAL 64bit double point type. More...
 
typedef unsigned int ALsizei = NULL
 OpenAL 32bit type. More...
 
typedef void ALvoid = NULL
 OpenAL void type. More...
 
typedef int ALenum = NULL
 OpenAL enumerations. More...
 

Macro Definition Documentation

#define AL_BITS   0x2002

Definition at line 250 of file altypes.h.

#define AL_BUFFER   0x1009

Indicate the buffer to provide sound samples.

Type: ALuint. Range: any valid Buffer id.

Definition at line 142 of file altypes.h.

#define AL_BUFFERS_PROCESSED   0x1016

Definition at line 235 of file altypes.h.

#define AL_BUFFERS_QUEUED   0x1015

Buffer Queue params.

Definition at line 234 of file altypes.h.

#define AL_CHANNEL_MASK   0x3000

Specify the channel mask.

(Creative) Type: ALuint Range: [0 - 255]

Definition at line 220 of file altypes.h.

#define AL_CHANNELS   0x2003

Definition at line 251 of file altypes.h.

#define AL_CONE_INNER_ANGLE   0x1001

Directional source, inner cone angle, in degrees.

Range: [0-360] Default: 360

Definition at line 94 of file altypes.h.

#define AL_CONE_OUTER_ANGLE   0x1002

Directional source, outer cone angle, in degrees.

Range: [0-360] Default: 360

Definition at line 101 of file altypes.h.

#define AL_CONE_OUTER_GAIN   0x1022

Indicate the gain (volume amplification) applied.

Type: ALfloat. Range: ]0.0- ] A value of 1.0 means un-attenuated/unchanged. Each division by 2 equals an attenuation of -6dB. Each multiplicaton with 2 equals an amplification of +6dB. A value of 0.0 is meaningless with respect to a logarithmic scale; it is interpreted as zero volume - the channel is effectively disabled.

Definition at line 206 of file altypes.h.

#define AL_DATA   0x2005

Definition at line 253 of file altypes.h.

#define AL_DIRECTION   0x1005

Specify the current direction as forward vector.

Definition at line 124 of file altypes.h.

#define AL_DISTANCE_MODEL   0xD000

Distance model.

Default AL_INVERSE_DISTANCE_CLAMPED

Definition at line 317 of file altypes.h.

#define AL_DOPPLER_FACTOR   0xC000

Global tweakage.

Doppler scale. Default 1.0

Definition at line 307 of file altypes.h.

#define AL_DOPPLER_VELOCITY   0xC001

Doppler velocity.

Default 1.0

Definition at line 312 of file altypes.h.

#define AL_EXTENSIONS   0xB004

Definition at line 300 of file altypes.h.

#define AL_FALSE   0

Definition at line 72 of file altypes.h.

#define AL_FORMAT_MONO16   0x1101

Definition at line 239 of file altypes.h.

#define AL_FORMAT_MONO8   0x1100

Sound buffers: format specifier.

Definition at line 238 of file altypes.h.

#define AL_FORMAT_STEREO16   0x1103

Definition at line 241 of file altypes.h.

#define AL_FORMAT_STEREO8   0x1102

Definition at line 240 of file altypes.h.

#define AL_FREQUENCY   0x2001

Sound buffers: frequency, in units of Hertz [Hz].

This is the number of samples per second. Half of the sample frequency marks the maximum significant frequency component.

Definition at line 249 of file altypes.h.

#define AL_GAIN   0x100A

Indicate the gain (volume amplification) applied.

Type: ALfloat. Range: ]0.0- ] A value of 1.0 means un-attenuated/unchanged. Each division by 2 equals an attenuation of -6dB. Each multiplicaton with 2 equals an amplification of +6dB. A value of 0.0 is meaningless with respect to a logarithmic scale; it is interpreted as zero volume - the channel is effectively disabled.

Definition at line 155 of file altypes.h.

#define AL_INITIAL   0x1011

Definition at line 226 of file altypes.h.

#define AL_INVALID   (-1)

Definition at line 66 of file altypes.h.

#define AL_INVALID_ENUM   0xA002

Illegal enum passed as an argument to an AL call.

Definition at line 275 of file altypes.h.

#define AL_INVALID_NAME   0xA001

Illegal name passed as an argument to an AL call.

Definition at line 270 of file altypes.h.

#define AL_INVALID_OPERATION   0xA004

A function was called at inappropriate time, or in an inappropriate way, causing an illegal state.

This can be an incompatible ALenum, object ID, and/or function.

Definition at line 288 of file altypes.h.

#define AL_INVALID_VALUE   0xA003

Illegal value passed as an argument to an AL call.

Applies to parameter values, but not to enumerations.

Definition at line 280 of file altypes.h.

#define AL_INVERSE_DISTANCE   0xD001

Distance models.

Definition at line 321 of file altypes.h.

#define AL_INVERSE_DISTANCE_CLAMPED   0xD002

Definition at line 322 of file altypes.h.

#define AL_LOOPING   0x1007

Indicate whether source has to loop infinite.

Type: ALboolean Range: [AL_TRUE, AL_FALSE] Default: AL_FALSE

Definition at line 135 of file altypes.h.

#define AL_MAX_DISTANCE   0x1023

Specify the maximum distance.

Type: ALfloat Range: [0.0 - ]

Definition at line 213 of file altypes.h.

#define AL_MAX_GAIN   0x100E

Indicate maximum source attenuation.

Type: ALfloat Range: [0.0 - 1.0]

Definition at line 169 of file altypes.h.

#define AL_MIN_GAIN   0x100D

Indicate minimum source attenuation.

Type: ALfloat Range: [0.0 - 1.0]

Definition at line 162 of file altypes.h.

#define AL_NO_ERROR   AL_FALSE

Errors: No Error.

Definition at line 265 of file altypes.h.

#define AL_NONE   0

Definition at line 69 of file altypes.h.

#define AL_ORIENTATION   0x100F

Specify the current orientation.

Type: ALfv6 (at/up) Range: N/A

Definition at line 176 of file altypes.h.

#define AL_OUT_OF_MEMORY   0xA005

A function could not be completed, because there is not enough memory available.

Definition at line 294 of file altypes.h.

#define AL_PAUSED   0x1013

Definition at line 228 of file altypes.h.

#define AL_PENDING   0x2011

Definition at line 261 of file altypes.h.

#define AL_PITCH   0x1003

Specify the pitch to be applied, either at source, or on mixer results, at listener.

Range: [0.5-2.0] Default: 1.0

Definition at line 109 of file altypes.h.

#define AL_PLAYING   0x1012

Definition at line 227 of file altypes.h.

#define AL_POSITION   0x1004

Specify the current location in three dimensional space.

OpenAL, like OpenGL, uses a right handed coordinate system, where in a frontal default view X (thumb) points right, Y points up (index finger), and Z points towards the viewer/camera (middle finger). To switch from a left handed coordinate system, flip the sign on the Z coordinate. Listener position is always in the world coordinate system.

Definition at line 121 of file altypes.h.

#define AL_PROCESSED   0x2012

Definition at line 262 of file altypes.h.

#define AL_REFERENCE_DISTANCE   0x1020

Definition at line 185 of file altypes.h.

#define AL_RENDERER   0xB003

Definition at line 299 of file altypes.h.

#define AL_ROLLOFF_FACTOR   0x1021

Indicate the rolloff factor for the source.

Type: ALfloat Range: [0.0 - ] Default: 1.0

Definition at line 193 of file altypes.h.

#define AL_SIZE   0x2004

Definition at line 252 of file altypes.h.

#define AL_SOURCE_ABSOLUTE   0x201

Indicate source has absolute coordinates.

Definition at line 84 of file altypes.h.

#define AL_SOURCE_RELATIVE   0x202

Indicate Source has listener relative coordinates.

Definition at line 87 of file altypes.h.

#define AL_SOURCE_STATE   0x1010

Source state information.

Definition at line 225 of file altypes.h.

#define AL_SOURCE_TYPE   0x200

Indicate the type of AL_SOURCE.

Sources can be spatialized

Definition at line 81 of file altypes.h.

#define AL_STOPPED   0x1014

Definition at line 229 of file altypes.h.

#define AL_TRUE   1

Definition at line 75 of file altypes.h.

#define AL_UNUSED   0x2010

Buffer state.

Not supported for public use (yet).

Definition at line 260 of file altypes.h.

#define AL_VELOCITY   0x1006

Specify the current velocity in three dimensional space.

Definition at line 127 of file altypes.h.

#define AL_VENDOR   0xB001

Context strings: Vendor Name.

Definition at line 297 of file altypes.h.

#define AL_VERSION   0xB002

Definition at line 298 of file altypes.h.

Typedef Documentation

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.htmlOpenAL boolean type.

Definition at line 30 of file altypes.h.

typedef char ALbyte

OpenAL 8bit signed byte.

Definition at line 33 of file altypes.h.

typedef double ALdouble

OpenAL 64bit double point type.

Definition at line 54 of file altypes.h.

OpenAL enumerations.

Definition at line 63 of file altypes.h.

OpenAL 32bit floating point type.

Definition at line 51 of file altypes.h.

typedef int ALint

OpenAL 32bit signed integer type.

Definition at line 48 of file altypes.h.

typedef short ALshort

OpenAL 16bit signed short integer type.

Definition at line 39 of file altypes.h.

OpenAL 32bit type.

Definition at line 57 of file altypes.h.

typedef unsigned char ALubyte

OpenAL 8bit unsigned byte.

Definition at line 36 of file altypes.h.

typedef unsigned ALuint

OpenAL 32bit unsigned integer type.

Definition at line 45 of file altypes.h.

typedef unsigned short ALushort

OpenAL 16bit unsigned short integer type.

Definition at line 42 of file altypes.h.

OpenAL void type.

Definition at line 60 of file altypes.h.