Package org.lwjgl.openal

Class ALC

java.lang.Object
org.lwjgl.openal.ALC
public final class ALC extends Object
This class must be used before any OpenAL function is called. It has the following responsibilities:
  • Loads the OpenAL native library into the JVM process.
  • Creates instances of ALCCapabilities classes. An ALCCapabilities instance contains flags for functionality that is available for an OpenAL device. Internally, it also contains function pointers that are only valid for that specific OpenAL device.

Library lifecycle

The OpenAL library is loaded automatically when this class is initialized. Set the Configuration.OPENAL_EXPLICIT_INIT option to override this behavior. Manual loading/unloading can be achieved with the create() and destroy() functions. The name of the library loaded can be overridden with the Configuration.OPENAL_LIBRARY_NAME option.

ALCCapabilities creation

Instances of ALCCapabilities can be created with the createCapabilities(long) method. Calling this method is expensive, so ALCCapabilities instances should be cached in user code.

See Also:

  • Method Details

    • create

      public static void create()
      Loads the OpenAL native library, using the default library name.

    • create

      public static void create(String libName)
      Loads the OpenAL native library, using the specified library name.
      Parameters:
      libName - the native library name

    • create

      public static void create(FunctionProviderLocal functionProvider)
      Initializes ALC with the specified FunctionProviderLocal. This method can be used to implement custom ALC library loading.
      Parameters:
      functionProvider - the provider of ALC function addresses

    • destroy

      public static void destroy()
      Unloads the OpenAL native library.

    • getFunctionProvider

      public static FunctionProviderLocal getFunctionProvider()
      Returns the FunctionProviderLocal for the OpenAL native library.

    • setCapabilities

      public static void setCapabilities(@Nullable ALCCapabilities caps)
      Sets the specified ALCCapabilities for the current thread.

      Any ALC functions called in the current thread will use the specified ALCCapabilities.

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

    • getCapabilities

      public static ALCCapabilities getCapabilities()
      Returns the ALCCapabilities for the current thread.
      Throws:
      IllegalStateException - if OpenAL has not been loaded.

    • createCapabilities

      public static ALCCapabilities createCapabilities(long device)
      Creates a new ALCCapabilities instance for the specified OpenAL device.

      This method calls setCapabilities(org.lwjgl.openal.ALCCapabilities) with the new instance before returning.

      Parameters:
      device - the ALCdevice for which to create the capabilities instance
      Returns:
      the ALCCapabilities instance

    • createCapabilities

      public static ALCCapabilities createCapabilities(long device, @Nullable IntFunction<PointerBuffer> bufferFactory)
      Creates a new ALCCapabilities instance for the specified OpenAL device.

      This method calls setCapabilities(org.lwjgl.openal.ALCCapabilities) with the new instance before returning.

      Parameters:
      device - the ALCdevice for which to create the capabilities instance
      bufferFactory - a function that allocates a PointerBuffer given a size. The buffer must be filled with zeroes. If null, LWJGL will allocate a GC-managed buffer internally.
      Returns:
      the ALCCapabilities instance