Package org.lwjgl.openal

Class AL


  • public final class AL
extends java.lang.Object
    This class must be used before any OpenAL function is called. It has the following responsibilities:
    • Creates instances of ALCapabilities classes. An ALCapabilities instance contains flags for functionality that is available in an OpenAL context. Internally, it also contains function pointers that are only valid in that specific OpenAL context.
    • Maintains thread-local and global state for ALCapabilities instances, corresponding to OpenAL contexts that are current in those threads and the entire process, respectively.

    ALCapabilities creation

    Instances of ALCapabilities can be created with the AL.createCapabilities(org.lwjgl.openal.ALCCapabilities) method. An OpenAL context must be current in the current thread or process before it is called. Calling this method is expensive, so ALCapabilities instances should be cached in user code.

    Thread-local state

    Before a function for a given OpenAL context can be called, the corresponding ALCapabilities instance must be made current in the current thread or process. The user is also responsible for clearing the current ALCapabilities instance when the context is destroyed or made current in another thread.

    Note that OpenAL contexts are made current process-wide by default. Current thread-local contexts are only available if the ALC_EXT_thread_local_context extension is supported by the OpenAL implementation. OpenAL Soft, the implementation that LWJGL ships with, supports this extension.

    See Also:
    ALC

    • Method Detail

      • setCurrentProcess

        public static void setCurrentProcess(ALCapabilities caps)
        Sets the specified ALCapabilities for the current process-wide OpenAL context.

        If the current thread had a context current (see AL.setCurrentThread(org.lwjgl.openal.ALCapabilities)), those ALCapabilities cleared. Any OpenAL functions called in the current thread, or any threads that have no context current, will use the specified ALCapabilities.

        Parameters:
        caps - the ALCapabilities to make current, or null

      • setCurrentThread

        public static void setCurrentThread(ALCapabilities caps)
        Sets the specified ALCapabilities for the current OpenAL context in the current thread.

        Any OpenAL functions called in the current thread will use the specified ALCapabilities.

        Parameters:
        caps - the ALCapabilities to make current, or null

      • getCurrentCapabilities

        public static ALCapabilities getCurrentCapabilities()
        Returns the ALCapabilities for the OpenAL context that is current in the current thread or process. If no OpenAL context is current in the current thread or process, null is returned.

      • getCapabilities

        public static ALCapabilities getCapabilities()
        Returns the ALCapabilities for the OpenAL context that is current in the current thread or process.
        Throws:
        java.lang.IllegalStateException - if no OpenAL context is current in the current thread or process

      • createCapabilities

        public static ALCapabilities createCapabilities(ALCCapabilities alcCaps)
        Creates a new ALCapabilities instance for the OpenAL context that is current in the current thread or process.
        Parameters:
        alcCaps - the ALCCapabilities of the device associated with the current context
        Returns:
        the ALCapabilities instance