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 createCapabilities 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 and performs better when it is used.

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
private static final ThreadLocal<ALCapabilities>	capabilitiesTLS
private static AL.ICD	icd
private static ALCapabilities	processCaps

Constructor Summary

Access	Constructor and Description
private	AL()

Method Summary

Modifier and Type	Method and Description
private static ALCapabilities	checkCapabilities(ALCapabilities caps)
public static ALCapabilities	Returns: the ALCapabilities instance createCapabilities(ALCCapabilities the `ALCCapabilities` of the device associated with the current context alcCaps) Creates a new `ALCapabilities` instance for the OpenAL context that is current in the current thread or process.
public static ALCapabilities	Returns: the ALCapabilities instance createCapabilities(ALCCapabilities the `ALCCapabilities` of the device associated with the current context alcCaps, 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 `ALCapabilities` instance for the OpenAL context that is current in the current thread or process.
pack-priv static void	destroy()
public static ALCapabilities	getCapabilities() Returns the `ALCapabilities` for the OpenAL context that is current in the current thread or process.
pack-priv static ALCapabilities	getICD()
pack-priv static void	init()
public static void	setCurrentProcess(ALCapabilities the `ALCapabilities` to make current, or null caps) Sets the specified `ALCapabilities` for the current process-wide OpenAL context.
public static void	setCurrentThread(ALCapabilities the `ALCapabilities` to make current, or null caps) Sets the specified `ALCapabilities` for the current OpenAL context in 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<ALCapabilities> capabilitiesTLS

icd	back to summary
private static AL.ICD icd

processCaps	back to summary
private static ALCapabilities processCaps Annotations @Nullable

Constructor Detail

AL	back to summary
private AL()

Method Detail

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

createCapabilities back to summary

createCapabilities	back to summary
public static ALCapabilities createCapabilities(ALCCapabilities alcCaps) Creates a new `ALCapabilities` instance for the OpenAL context that is current in the current thread or process. This method calls `setCurrentProcess` (or `setCurrentThread` if applicable) with the new instance before returning. Parameters alcCaps:ALCCapabilities the `ALCCapabilities` of the device associated with the current context Returns:ALCapabilities the ALCapabilities instance

public static ALCapabilities createCapabilities(ALCCapabilities alcCaps)

Creates a new ALCapabilities instance for the OpenAL context that is current in the current thread or process.

This method calls setCurrentProcess (or setCurrentThread if applicable) with the new instance before returning.

Parameters

alcCaps:ALCCapabilities: the ALCCapabilities of the device associated with the current context

Returns:ALCapabilities

the ALCapabilities instance

createCapabilities back to summary

createCapabilities	back to summary
public static ALCapabilities createCapabilities(ALCCapabilities alcCaps, IntFunction<PointerBuffer> bufferFactory) Creates a new `ALCapabilities` instance for the OpenAL context that is current in the current thread or process. Parameters alcCaps:ALCCapabilities the `ALCCapabilities` of the device associated with the current context 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:ALCapabilities the ALCapabilities instance

public static ALCapabilities createCapabilities(ALCCapabilities alcCaps, IntFunction<PointerBuffer> bufferFactory)

Creates a new ALCapabilities instance for the OpenAL context that is current in the current thread or process.

Parameters

alcCaps:ALCCapabilities: the ALCCapabilities of the device associated with the current context
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:ALCapabilities

the ALCapabilities instance

destroy	back to summary
pack-priv static void destroy()

getCapabilities back to summary

getCapabilities	back to summary
public static ALCapabilities getCapabilities() Returns the `ALCapabilities` for the OpenAL context that is current in the current thread or process. Exceptions IllegalStateException: if no OpenAL context is current in the current thread or process

public static ALCapabilities getCapabilities()

Returns the ALCapabilities for the OpenAL context that is current in the current thread or process.

Exceptions

IllegalStateException:: if no OpenAL context is current in the current thread or process

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

init	back to summary
pack-priv static void init()

setCurrentProcess back to summary

setCurrentProcess	back to summary
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 `setCurrentThread`), those `ALCapabilities` are cleared. Any OpenAL functions called in the current thread, or any threads that have no context current, will use the specified `ALCapabilities`. Parameters caps:ALCapabilities the `ALCapabilities` to make current, or null

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 setCurrentThread), those ALCapabilities are cleared. Any OpenAL functions called in the current thread, or any threads that have no context current, will use the specified ALCapabilities.

Parameters

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

setCurrentThread back to summary

setCurrentThread	back to summary
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:ALCapabilities the `ALCapabilities` to make current, or null

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:ALCapabilities: the ALCapabilities to make current, or null

org.lwjgl.openal back to summary

private Interface AL.ICD

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

Function pointer provider.

Method Summary

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

Method Detail

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

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

org.lwjgl.openal back to summary

private Class AL.ICDStatic

Class Inheritance

extends Object
implements ICD

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

All Implemented Interfaces

org.lwjgl.openal.AL.ICD

Write-once ICD.

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

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
private static ALCapabilities	tempCaps

Constructor Summary

Access	Constructor and Description
private	ICDStatic()

Method Summary

Modifier and Type	Method and Description
public ALCapabilities	get() Implements org.lwjgl.openal.AL.ICD.get.
public void	set(ALCapabilities caps) Overrides default org.lwjgl.openal.AL.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 ALCapabilities tempCaps Annotations @Nullable

Constructor Detail

ICDStatic	back to summary
private ICDStatic()

Method Detail

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

get

back to summary

public ALCapabilities get()

Implements org.lwjgl.openal.AL.ICD.get.

Annotations

@Override

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

set

back to summary

public void set(ALCapabilities caps)

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

Annotations

@SuppressWarnings:AssignmentToStaticFieldFromInstanceMethod
@Override

org.lwjgl.openal back to summary

private final Class AL.ICDStatic.WriteOnce

Class Inheritance

extends Object

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

Field Summary

Modifier and Type	Field and Description
pack-priv static final ALCapabilities	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 ALCapabilities caps

Constructor Detail

WriteOnce	back to summary
private WriteOnce()

public final Class AL

ALCapabilities creation

Thread-local state

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface AL.ICD

Method Summary

Method Detail

private Class AL.ICDStatic

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class AL.ICDStatic.WriteOnce

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail