Top Description Fields Constructors Methods
org.lwjgl.openal

public Class SOFTHRTF

extends Object
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*
Native bindings to the SOFT_HRTF extension.

This extension allows an application to request and determine the status of HRTF mixing. HRTF, or Head-Related Transfer Function, is a method of mixing 3D audio for "true" 3D panning, typically using filters designed to simulate how sound is affected by a listener's head as the sound waves travel between the ears.

As a 3D sound API, OpenAL's design allows implementations to transparently render audio using HRTF. However, the OpenAL API currently has no concept of HRTF so there's no way to query if it's being used, and no way for an application to request it on behalf of the user. This aims to fix that.

Field Summary

Modifier and TypeField and Description
public static final int
ALC_DONT_CARE_SOFT

Accepted as part of the attrList parameter of CreateContext and ResetDeviceSOFT, for the HRTF_SOFT attribute.

public static final int
ALC_HRTF_DENIED_SOFT

Possible results from a HRTF_STATUS_SOFT query.

public static final int
ALC_HRTF_DISABLED_SOFT

Possible results from a HRTF_STATUS_SOFT query.

public static final int
ALC_HRTF_ENABLED_SOFT

Possible results from a HRTF_STATUS_SOFT query.

public static final int
ALC_HRTF_HEADPHONES_DETECTED_SOFT

Possible results from a HRTF_STATUS_SOFT query.

public static final int
ALC_HRTF_ID_SOFT

Accepted as part of the attrList parameter of CreateContext and ResetDeviceSOFT.

public static final int
ALC_HRTF_REQUIRED_SOFT

Possible results from a HRTF_STATUS_SOFT query.

public static final int
ALC_HRTF_SOFT

Accepted as part of the attrList parameter of CreateContext and ResetDeviceSOFT, and as the paramName parameter of GetIntegerv.

public static final int
ALC_HRTF_SPECIFIER_SOFT

Accepted as the paramName parameter of GetString and GetStringiSOFT.

public static final int
ALC_HRTF_STATUS_SOFT

Accepted as the paramName parameter of GetIntegerv.

public static final int
ALC_HRTF_UNSUPPORTED_FORMAT_SOFT

Possible results from a HRTF_STATUS_SOFT query.

public static final int
ALC_NUM_HRTF_SPECIFIERS_SOFT

Accepted as the paramName parameter of GetIntegerv.

Constructor Summary

AccessConstructor and Description
protected
SOFTHRTF()

Method Summary

Modifier and TypeMethod and Description
public static String
alcGetStringiSOFT(long
he same one that previously queried the number of HRTF specifiers
device, int
the parameter to query. Must be:
HRTF_SPECIFIER_SOFT
paramName, int
an index between 0 (inclusive) and the previously-queried HRTF count (exclusive)
index)

Returns a human-readable string for an HRTF.

public static boolean

Returns:

on success the function returns TRUE, and on failure the function returns FALSE. Note that a return of TRUE does not indicate any attributes were honored, just that the device was successfully reset. If you need to know what the attributes are after a reset, query the device using GetIntegerv with the relevant attributes.
alcResetDeviceSOFT(long
a handle to a valid playback device as returned by OpenDevice, otherwise the call fails and an INVALID_DEVICE error is generated
device, IntBuffer
the same as what could be passed to CreateContext. The AL is allowed to ignore attributes and attribute value combinations the device cannot support, for example if the device doesn't support the requested FREQUENCY value, another value it does support may be set.
attrList)

Resets a device after it is opened for playback, to attempt changing the playback properties.

public static boolean
alcResetDeviceSOFT(long device, int[] attrList)

Array version of: ResetDeviceSOFT

public static long
nalcGetStringiSOFT(long device, int paramName, int index)

Unsafe version of: GetStringiSOFT

public static boolean
nalcResetDeviceSOFT(long device, long attrList)

Unsafe version of: ResetDeviceSOFT

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ALC_DONT_CARE_SOFTback to summary
public static final int ALC_DONT_CARE_SOFT

Accepted as part of the attrList parameter of CreateContext and ResetDeviceSOFT, for the HRTF_SOFT attribute.

ALC_HRTF_DENIED_SOFTback to summary
public static final int ALC_HRTF_DENIED_SOFT

Possible results from a HRTF_STATUS_SOFT query.

ALC_HRTF_DISABLED_SOFTback to summary
public static final int ALC_HRTF_DISABLED_SOFT

Possible results from a HRTF_STATUS_SOFT query.

ALC_HRTF_ENABLED_SOFTback to summary
public static final int ALC_HRTF_ENABLED_SOFT

Possible results from a HRTF_STATUS_SOFT query.

ALC_HRTF_HEADPHONES_DETECTED_SOFTback to summary
public static final int ALC_HRTF_HEADPHONES_DETECTED_SOFT

Possible results from a HRTF_STATUS_SOFT query.

ALC_HRTF_ID_SOFTback to summary
public static final int ALC_HRTF_ID_SOFT

Accepted as part of the attrList parameter of CreateContext and ResetDeviceSOFT.

ALC_HRTF_REQUIRED_SOFTback to summary
public static final int ALC_HRTF_REQUIRED_SOFT

Possible results from a HRTF_STATUS_SOFT query.

ALC_HRTF_SOFTback to summary
public static final int ALC_HRTF_SOFT

Accepted as part of the attrList parameter of CreateContext and ResetDeviceSOFT, and as the paramName parameter of GetIntegerv.

ALC_HRTF_SPECIFIER_SOFTback to summary
public static final int ALC_HRTF_SPECIFIER_SOFT

Accepted as the paramName parameter of GetString and GetStringiSOFT.

ALC_HRTF_STATUS_SOFTback to summary
public static final int ALC_HRTF_STATUS_SOFT

Accepted as the paramName parameter of GetIntegerv.

ALC_HRTF_UNSUPPORTED_FORMAT_SOFTback to summary
public static final int ALC_HRTF_UNSUPPORTED_FORMAT_SOFT

Possible results from a HRTF_STATUS_SOFT query.

ALC_NUM_HRTF_SPECIFIERS_SOFTback to summary
public static final int ALC_NUM_HRTF_SPECIFIERS_SOFT

Accepted as the paramName parameter of GetIntegerv.

Constructor Detail

SOFTHRTFback to summary
protected SOFTHRTF()

Method Detail

alcGetStringiSOFTback to summary
public static String alcGetStringiSOFT(long device, int paramName, int index)

Returns a human-readable string for an HRTF.

The returned string will be an implementation-defined UTF-8 encoded specifier for the given HRTF index, designed for display to the user. The returned strings are valid until the next enumeration point or the device is closed.

Parameters
device:long

he same one that previously queried the number of HRTF specifiers

paramName:int

the parameter to query. Must be:

HRTF_SPECIFIER_SOFT
index:int

an index between 0 (inclusive) and the previously-queried HRTF count (exclusive)

Annotations
@Nullable
@NativeType:ALCchar const *
alcResetDeviceSOFTback to summary
public static boolean alcResetDeviceSOFT(long device, IntBuffer attrList)

Resets a device after it is opened for playback, to attempt changing the playback properties.

Parameters
device:long

a handle to a valid playback device as returned by OpenDevice, otherwise the call fails and an INVALID_DEVICE error is generated

attrList:IntBuffer

the same as what could be passed to CreateContext. The AL is allowed to ignore attributes and attribute value combinations the device cannot support, for example if the device doesn't support the requested FREQUENCY value, another value it does support may be set.

Returns:boolean

on success the function returns TRUE, and on failure the function returns FALSE. Note that a return of TRUE does not indicate any attributes were honored, just that the device was successfully reset. If you need to know what the attributes are after a reset, query the device using GetIntegerv with the relevant attributes.

Annotations
@NativeType:ALCboolean
alcResetDeviceSOFTback to summary
public static boolean alcResetDeviceSOFT(long device, int[] attrList)

Array version of: ResetDeviceSOFT

Annotations
@NativeType:ALCboolean
nalcGetStringiSOFTback to summary
public static long nalcGetStringiSOFT(long device, int paramName, int index)

Unsafe version of: GetStringiSOFT

nalcResetDeviceSOFTback to summary
public static boolean nalcResetDeviceSOFT(long device, long attrList)

Unsafe version of: ResetDeviceSOFT