pygame2.openal.constants – Constants for OpenAL
This module contains the constants used throughout the
pygame2.openal module.
Buffer Constants
Those constants are used by the pygame2.openal.Buffers.set_prop()
and pygame2.openal.Buffers.get_prop() methods.
-
pygame2.openal.constants.AL_FREQUENCY
- The frequency of the buffer (and its data) in Hz. The provided value
must be an integer.
-
pygame2.openal.constants.AL_BITS
- The bit depth of the buffer. The provided value must be an integer.
-
pygame2.openal.constants.AL_CHANNELS
- The number of channels for the buffered data. The provided value
must be an integer greater than 0.
-
pygame2.openal.constants.AL_SIZE
- The size of the buffered data in bytes.
-
pygame2.openal.constants.AL_DATA
- The original location the buffered data came from. This is generally
useless, as the original data location was probably freed after the
data was buffered.
Source Constants
Those constants are used by the pygame2.openal.Sources.set_prop()
and pygame2.openal.Sources.get_prop() methods.
-
pygame2.openal.constants.AL_PITCH
- The pitch multiplier. The provided value must be a positive floating
point value.
-
pygame2.openal.constants.AL_GAIN
- The source gain. The provided value should be a positive floating
point value.
-
pygame2.openal.constants.AL_MAX_DISTANCE
- Used with the Inverse Clamped Distance Model to set the distance
where there will no longer be any attenuation of the source. The
provided value must be an integer or floating point value.
-
pygame2.openal.constants.AL_ROLLOFF_FACTOR
- The rolloff ratge for the source. The provided value should be an
integer or floating point value.
-
pygame2.openal.constants.AL_REFERENCE_DISTANCE
- The distance under which the volume for the source would normally
drop by half. The provided value should be an integer or floating
point value.
-
pygame2.openal.constants.AL_MIN_GAIN
- The minimum source gain. The provided value must be a postive
floating point value.
-
pygame2.openal.constants.AL_MAX_GAIN
- The maximum source gain. The provided value must be a postive
floating point value.
-
pygame2.openal.constants.AL_CONE_OUTER_GAIN
- The gain when outside the oriented cone. The provided value must be a
postive floating point value.
-
pygame2.openal.constants.AL_CONE_INNER_ANGLE
- The gain when inside the oriented cone. The provided value must be a
postive floating point value.
-
pygame2.openal.constants.AL_CONE_OUTER_ANGLE
- The outer angle of the sound cone in degrees. The provided value must
be a integer or floating point value.
-
pygame2.openal.constants.AL_POSITION
- The X, Y, Z position of the source. The provided value must be a
triplet of floating point values.
-
pygame2.openal.constants.AL_VELOCITY
- The X, Y, Z velocity of the source. The provided value must be a
triplet of floating point values.
-
pygame2.openal.constants.AL_DIRECTION
- The X, Y, Z direction of the source. The provided value must be a
triplet of integer or floating point values.
-
pygame2.openal.constants.AL_SOURCE_RELATIVE
- Determines if the positions of the source are relative to the
listener. The provided value must be an integer.
-
pygame2.openal.constants.AL_SOURCE_TYPE
The type of the source. This will be a value of
- AL_UNDETERMINED
- AL_STATIC
- AL_STREAMING
-
pygame2.openal.constants.AL_LOOPING
- Turns looping on (AL_TRUE) or off (AL_FALSE).
-
pygame2.openal.constants.AL_BUFFER
- The ID of the attached buffer
-
pygame2.openal.constants.AL_SOURCE_STATE
The state of the source. This will be a value of
- AL_STOPPED
- AL_PLAYING
- AL_PAUSED
-
pygame2.openal.constants.AL_BUFFERS_QUEUED
- The number of buffers queued on this source.
-
pygame2.openal.constants.AL_BUFFERS_PROCESSED
- The number of buffers in the queue that have been processed.
-
pygame2.openal.constants.AL_SEC_OFFSET
- The source playback position, in seconds.
-
pygame2.openal.constants.AL_SAMPLE_OFFSET
- The source playback position, in samples.
-
pygame2.openal.constants.AL_BYTE_OFFSET
- The source playback position, in bytes.
Listener Constants
Those constants are used by the pygame2.openal.Listener.set_prop()
and pygame2.openal.Listener.get_prop() methods.
-
pygame2.openal.constants.AL_GAIN
- The master gain. The provided value should be a positive floating
point value.
-
pygame2.openal.constants.AL_POSITION
- The X, Y, Z position of the listener. The provided value must be a
triplet of floating point values.
-
pygame2.openal.constants.AL_VELOCITY
- The X, Y, Z velocity of the listener. The provided value must be a
triplet of floating point values.
-
pygame2.openal.constants.AL_ORIENTATION
- The orientation of the listener, expressed as “at” and “up” vectors
(6 elements) of floating point values.
Distance Model Constants
Those constance are used by the
pygame2.openal.Context.distance_model property.
-
pygame2.openal.constants.AL_INVERSE_DISTANCE
- TODO
-
pygame2.openal.constants.AL_INVERSE_DISTANCE_CLAMPED
- TODO
-
pygame2.openal.constants.AL_LINEAR_DISTANCE
- TODO
-
pygame2.openal.constants.AL_LINEAR_DISTANCE_CLAMPED
- TODO
-
pygame2.openal.constants.AL_EXPONENT_DISTANCE
- TODO
-
pygame2.openal.constants.AL_EXPONENT_DISTANCE_CLAMPED
- TODO
-
pygame2.openal.constants.AL_NONE
- TODO
Todo
Complete the constant descriptions.