Source

pygame / doc / src / openal_constants.rst

Full commit

:mod:`pygame2.openal.constants` -- Constants for OpenAL

This module contains the constants used throughout the :mod:`pygame2.openal` module.

OpenAL constants separate into two different types, general constants, which are prefixed with AL_ and context/device specific constants, which are prefixed with ALC_.

Format Constants

Those constants are used by the :meth:`pygame2.openal.Buffers.buffer_data`, and :meth:`pygame2.openal.CaptureDevice.get_samples` methods.

Buffer Constants

Those constants are used by the :meth:`pygame2.openal.Buffers.set_prop` and :meth:`pygame2.openal.Buffers.get_prop` methods.

Source Constants

Those constants are used by the :meth:`pygame2.openal.Sources.set_prop` and :meth:`pygame2.openal.Sources.get_prop` methods.

Source Type Constants

The following constants indicate the type of the source.

Source State Constants

The following constants indicate the state of the source.

Listener Constants

Those constants are used by the :meth:`pygame2.openal.Listener.set_prop` and :meth:`pygame2.openal.Listener.get_prop` methods.

Distance Model Constants

Those constance are used by the :attr:`pygame2.openal.Context.distance_model` property.

Doppler Shift Constants

The following constants are used for doppler effects using :attr:`pygame2.openal.Context.doppler_factor` and :attr:`pygame2.openal.Context.speed_of_sound`. They are used for compatibility reasons and interoperability with other code, but usually not needed within the :mod:`pygame2.openal` module.

Context and Device Constants

The following constants are used in conjunction with OpenAL Contexts and Devices.

Error Constants

The following constants indicate OpenAL errors. They are usually mapped against :exc:`pygame2.Error` instances with a matching description. They are only used for compatibility reasons and interoperability with other code, but usually not needed within the :mod:`pygame2.openal` module.

Miscellaneous Constants

TODO