JOAL v2.6.0-rc-20250706
JOAL, OpenAL® API Binding for Java™ (public API).
com.jogamp.openal.ALFactory Class Reference

This class provides factory methods for generating AL and ALC objects. More...

Collaboration diagram for com.jogamp.openal.ALFactory:

Static Public Member Functions

static boolean getPreferSystemOpenAL () throws ALException
 If the system property joal.SystemOpenAL is set. More...
 
static AL getAL () throws ALException
 Get the default AL object. More...
 
static ALC getALC () throws ALException
 Get the default ALC object. More...
 
static ALExt getALExt () throws ALException
 Get the default ALExt object. More...
 

Static Public Attributes

static final boolean DEBUG = Debug.debug("Factory")
 
static final boolean PREFER_SYSTEM_OPENAL
 If true, prefer System-OpenAL, otherwise bundled Soft-OpenAL (default). More...
 

Detailed Description

This class provides factory methods for generating AL and ALC objects.

Select preferred OpenAL native library type via system properties, i.e. System-OpenAL or bundled Soft-OpenAL.
If the preferred choice fails, implementation falls back to the other.

 -Djoal.openal.lib=auto     Prefer System-OpenAL over bundled Soft-OpenAL for OSX. Prefer bundled Soft-OpenAL over System-OpenAL for all others. This is the default.
 -Djoal.openal.lib=system   Prefer System-OpenAL over bundled Soft-OpenAL for all.
 -Djoal.openal.lib=soft     Prefer bundled Soft-OpenAL over System-OpenAL for all.

Note: You may use the 'jnlp.' prefix, allowing using above property names w/ Applets and WebStart, e.g. 'jnlp.joal.openal.lib=system'.

Author
Athomas Goldberg, Kenneth Russell, et.al.

Definition at line 62 of file ALFactory.java.

Member Function Documentation

◆ getAL()

static AL com.jogamp.openal.ALFactory.getAL ( ) throws ALException
static

Get the default AL object.

This object is used to access most of the OpenAL functionality.

Returns
the AL object

Definition at line 122 of file ALFactory.java.

Here is the caller graph for this function:

◆ getALC()

static ALC com.jogamp.openal.ALFactory.getALC ( ) throws ALException
static

Get the default ALC object.

This object is used to access most of the OpenAL context functionality.

Returns
the ALC object

Definition at line 136 of file ALFactory.java.

Here is the caller graph for this function:

◆ getALExt()

static ALExt com.jogamp.openal.ALFactory.getALExt ( ) throws ALException
static

Get the default ALExt object.

This object is used to access most of the OpenAL extension functionality.

Returns
the ALExt object

Definition at line 150 of file ALFactory.java.

Here is the caller graph for this function:

◆ getPreferSystemOpenAL()

static boolean com.jogamp.openal.ALFactory.getPreferSystemOpenAL ( ) throws ALException
static

If the system property joal.SystemOpenAL is set.

Returns
Exceptions
ALException

Definition at line 111 of file ALFactory.java.

Member Data Documentation

◆ DEBUG

final boolean com.jogamp.openal.ALFactory.DEBUG = Debug.debug("Factory")
static

Definition at line 63 of file ALFactory.java.

◆ PREFER_SYSTEM_OPENAL

final boolean com.jogamp.openal.ALFactory.PREFER_SYSTEM_OPENAL
static

If true, prefer System-OpenAL, otherwise bundled Soft-OpenAL (default).

Definition at line 65 of file ALFactory.java.


The documentation for this class was generated from the following file: