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 method. Calling this method is expensive, so ALCCapabilities instances should be cached in user code.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static interface	ALC.ICD Function pointer provider.
private static class	ALC.ICDStatic Write-once `ICD`.
private static class	ALC.SharedLibraryAL

Field Summary

Modifier and Type	Field and Description
private static final ThreadLocal<ALCCapabilities>	capabilitiesTLS
private static FunctionProviderLocal	functionProvider
private static ALC.ICD	icd
private static ALCCapabilities	router

Constructor Summary

Access	Constructor and Description
private	ALC()

Method Summary

Modifier and Type	Method and Description
pack-priv static <T> T	check(T t)
private static ALCCapabilities	checkCapabilities(ALCCapabilities caps)
public static void	create() Loads the OpenAL native library, using the default library name.
public static void	create(String the native library name libName) Loads the OpenAL native library, using the specified library name.
public static void	create(FunctionProviderLocal the provider of ALC function addresses functionProvider) Initializes ALC with the specified `FunctionProviderLocal`.
public static ALCCapabilities	Returns: the `ALCCapabilities` instance createCapabilities(long the `ALCdevice` for which to create the capabilities instance device) Creates a new `ALCCapabilities` instance for the specified OpenAL device.
public static ALCCapabilities	Returns: the `ALCCapabilities` instance createCapabilities(long the `ALCdevice` for which to create the capabilities instance device, IntFunction<PointerBuffer> 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. bufferFactory) Creates a new `ALCCapabilities` instance for the specified OpenAL device.
public static void	destroy() Unloads the OpenAL native library.
public static ALCCapabilities	getCapabilities() Returns the `ALCCapabilities` for the current thread.
public static FunctionProviderLocal	getFunctionProvider() Returns the `FunctionProviderLocal` for the OpenAL native library.
pack-priv static ALCCapabilities	getICD()
public static void	setCapabilities(ALCCapabilities the `ALCCapabilities` to make current, or null caps) Sets the specified `ALCCapabilities` for the current thread.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

capabilitiesTLS	back to summary
private static final ThreadLocal<ALCCapabilities> capabilitiesTLS

functionProvider	back to summary
private static FunctionProviderLocal functionProvider Annotations @Nullable

icd	back to summary
private static ALC.ICD icd Annotations @Nullable

router	back to summary
private static ALCCapabilities router Annotations @Nullable

Constructor Detail

ALC	back to summary
private ALC()

Method Detail

check	back to summary
pack-priv static <T> T check(T t)

checkCapabilities	back to summary
private static ALCCapabilities checkCapabilities(ALCCapabilities caps)

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

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

create

back to summary

public static void create(String libName)

Loads the OpenAL native library, using the specified library name.

Parameters

libName:String: the native library name

create back to summary

create	back to summary
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:FunctionProviderLocal the provider of ALC function addresses

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:FunctionProviderLocal: the provider of ALC function addresses

createCapabilities back to summary

createCapabilities	back to summary
public static ALCCapabilities createCapabilities(long device) Creates a new `ALCCapabilities` instance for the specified OpenAL device. This method calls `setCapabilities` with the new instance before returning. Parameters device:long the `ALCdevice` for which to create the capabilities instance Returns:ALCCapabilities the `ALCCapabilities` instance

public static ALCCapabilities createCapabilities(long device)

Creates a new ALCCapabilities instance for the specified OpenAL device.

This method calls setCapabilities with the new instance before returning.

Parameters

device:long: the ALCdevice for which to create the capabilities instance

Returns:ALCCapabilities

the ALCCapabilities instance

createCapabilities back to summary

createCapabilities	back to summary
public static ALCCapabilities createCapabilities(long device, IntFunction<PointerBuffer> bufferFactory) Creates a new `ALCCapabilities` instance for the specified OpenAL device. This method calls `setCapabilities` with the new instance before returning. Parameters device:long the `ALCdevice` for which to create the capabilities instance bufferFactory:IntFunction<PointerBuffer> 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:ALCCapabilities the `ALCCapabilities` instance

public static ALCCapabilities createCapabilities(long device, IntFunction<PointerBuffer> bufferFactory)

Creates a new ALCCapabilities instance for the specified OpenAL device.

This method calls setCapabilities with the new instance before returning.

Parameters

device:long: the ALCdevice for which to create the capabilities instance
bufferFactory:IntFunction<PointerBuffer>: 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:ALCCapabilities

the ALCCapabilities instance

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

getCapabilities back to summary

getCapabilities	back to summary
public static ALCCapabilities getCapabilities() Returns the `ALCCapabilities` for the current thread. Exceptions IllegalStateException: if OpenAL has not been loaded.

public static ALCCapabilities getCapabilities()

Returns the ALCCapabilities for the current thread.

Exceptions

IllegalStateException:: if OpenAL has not been loaded.

getFunctionProvider	back to summary
public static FunctionProviderLocal getFunctionProvider() Returns the `FunctionProviderLocal` for the OpenAL native library.

getICD	back to summary
pack-priv static ALCCapabilities getICD()

setCapabilities back to summary

setCapabilities	back to summary
public static void setCapabilities(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:ALCCapabilities the `ALCCapabilities` to make current, or null

public static void setCapabilities(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:ALCCapabilities: the ALCCapabilities to make current, or null

org.lwjgl.openal back to summary

private Interface ALC.ICD

Known Direct Implementers: org.lwjgl.openal.ALC.ICDStatic

Function pointer provider.

Method Summary

Modifier and Type	Method and Description
public ALCCapabilities	get()
public default void	set(ALCCapabilities caps)

Method Detail

get	back to summary
public ALCCapabilities get() Annotations @Nullable

set	back to summary
public default void set(ALCCapabilities caps)

org.lwjgl.openal back to summary

private Class ALC.ICDStatic

Class Inheritance

extends Object
implements ICD

java.lang.Object
org.lwjgl.openal.ALC.ICDStatic

All Implemented Interfaces

org.lwjgl.openal.ALC.ICD

Write-once ICD.

This is the default implementation that skips the thread/process lookup. When a new ALCCapabilities is set, we compare it to the write-once capabilities. If different function pointers are found, we fall back to the expensive lookup.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ALC.ICDStatic.WriteOnce

Field Summary

Modifier and Type	Field and Description
private static ALCCapabilities	tempCaps

Constructor Summary

Access	Constructor and Description
private	ICDStatic()

Method Summary

Modifier and Type	Method and Description
public ALCCapabilities	get() Implements org.lwjgl.openal.ALC.ICD.get.
public void	set(ALCCapabilities caps) Overrides default org.lwjgl.openal.ALC.ICD.set.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

tempCaps	back to summary
private static ALCCapabilities tempCaps Annotations @Nullable

Constructor Detail

ICDStatic	back to summary
private ICDStatic()

Method Detail

get	back to summary
public ALCCapabilities get() Implements org.lwjgl.openal.ALC.ICD.get. Annotations @Override

get

back to summary

public ALCCapabilities get()

Implements org.lwjgl.openal.ALC.ICD.get.

Annotations

@Override

set	back to summary
public void set(ALCCapabilities caps) Overrides default org.lwjgl.openal.ALC.ICD.set. Annotations @SuppressWarnings:AssignmentToStaticFieldFromInstanceMethod @Override

set

back to summary

public void set(ALCCapabilities caps)

Overrides default org.lwjgl.openal.ALC.ICD.set.

Annotations

@SuppressWarnings:AssignmentToStaticFieldFromInstanceMethod
@Override

org.lwjgl.openal back to summary

private final Class ALC.ICDStatic.WriteOnce

Class Inheritance

extends Object

java.lang.Object
org.lwjgl.openal.ALC.ICDStatic.WriteOnce

Field Summary

Modifier and Type	Field and Description
pack-priv static final ALCCapabilities	caps

Constructor Summary

Access	Constructor and Description
private	WriteOnce()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

caps	back to summary
pack-priv static final ALCCapabilities caps

Constructor Detail

WriteOnce	back to summary
private WriteOnce()

org.lwjgl.openal back to summary

private Class ALC.SharedLibraryAL

Class Inheritance

extends Delegate
implements FunctionProviderLocal

java.lang.Object
org.lwjgl.system.SharedLibrary.Delegate
org.lwjgl.openal.ALC.SharedLibraryAL

All Implemented Interfaces

org.lwjgl.system.FunctionProviderLocal, org.lwjgl.system.FunctionProvider

Field Summary

Modifier and Type	Field and Description
private final long	alcGetProcAddress

Inherited from org.lwjgl.system.SharedLibrary.Delegate:: library

Constructor Summary

Access	Constructor and Description
protected	SharedLibraryAL(SharedLibrary library)

Method Summary

Modifier and Type	Method and Description
public long	getFunctionAddress(ByteBuffer the encoded name of the function to query functionName) Implements org.lwjgl.system.FunctionProvider.getFunctionAddress. Returns the function address of the specified function.
public long	getFunctionAddress(long the handle to a platform/device/context handle, ByteBuffer the encoded name of the function to query functionName) Implements org.lwjgl.system.FunctionProviderLocal.getFunctionAddress. Returns the function address of the specified function for the specified `handle`.

Inherited from org.lwjgl.system.SharedLibrary.Delegate:: address free getName getPath

Field Detail

alcGetProcAddress	back to summary
private final long alcGetProcAddress

Constructor Detail

SharedLibraryAL	back to summary
protected SharedLibraryAL(SharedLibrary library)

Method Detail

getFunctionAddress	back to summary
public long getFunctionAddress(ByteBuffer functionName) Implements org.lwjgl.system.FunctionProvider.getFunctionAddress. Doc from org.lwjgl.system.FunctionProvider.getFunctionAddress. Returns the function address of the specified function. If the function is not supported, returns 0L. Parameters functionName:ByteBuffer the encoded name of the function to query Returns:long the function address or 0L if the function is not supported Annotations @Override

getFunctionAddress

back to summary

public long getFunctionAddress(ByteBuffer functionName)

Implements org.lwjgl.system.FunctionProvider.getFunctionAddress.

Doc from org.lwjgl.system.FunctionProvider.getFunctionAddress.

Returns the function address of the specified function. If the function is not supported, returns 0L.

Parameters

functionName:ByteBuffer: the encoded name of the function to query

Returns:long

the function address or 0L if the function is not supported

Annotations

@Override

getFunctionAddress back to summary

getFunctionAddress	back to summary
public long getFunctionAddress(long handle, ByteBuffer functionName) Implements org.lwjgl.system.FunctionProviderLocal.getFunctionAddress. Doc from org.lwjgl.system.FunctionProviderLocal.getFunctionAddress. Returns the function address of the specified function for the specified `handle`. If the function is not supported, returns 0L. Parameters handle:long the handle to a platform/device/context functionName:ByteBuffer the encoded name of the function to query Returns:long the function address or 0L if the function is not supported Annotations @Override

public long getFunctionAddress(long handle, ByteBuffer functionName)

Implements org.lwjgl.system.FunctionProviderLocal.getFunctionAddress.

Doc from org.lwjgl.system.FunctionProviderLocal.getFunctionAddress.

Returns the function address of the specified function for the specified handle. If the function is not supported, returns 0L.

Parameters

handle:long: the handle to a platform/device/context
functionName:ByteBuffer: the encoded name of the function to query

Returns:long

the function address or 0L if the function is not supported

Annotations

@Override

public final Class ALC

Library lifecycle

ALCCapabilities creation

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface ALC.ICD

Method Summary

Method Detail

private Class ALC.ICDStatic

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ALC.ICDStatic.WriteOnce

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private Class ALC.SharedLibraryAL

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail