Lighweight Java Game Library 2.9.3 · org.lwjgl.openal.EFXUtil

Modifier and Type	Field and Description
private static final int	EFFECT Constant for testSupportGeneric to check an effect.
private static final int	FILTER Constant for testSupportGeneric to check a filter.

Access	Constructor and Description
private	EFXUtil() Utility class, hidden contructor.

Method Summary

Modifier and Type	Method and Description
public static boolean	Returns: True if it is supported, false if not. isEffectSupported(final int Type of effect whose support is to be tested, e.g. AL_EFFECT_REVERB. effectType) Tests OpenAL to see whether the given effect type is supported.
public static boolean	Returns: True if ALC_EXT_EFX is supported, false if not. isEfxSupported() Checks if OpenAL implementation is loaded and supports ALC_EXT_EFX.
public static boolean	Returns: True if it is supported, false if not. isFilterSupported(final int Type of filter whose support is to be tested, e.g. AL_FILTER_LOWPASS. filterType) Tests OpenAL to see whether the given filter type is supported.
private static boolean	Returns: True if object supports typeValue, false else. testSupportGeneric(final int Type of object to test. Must be either EFXUtil.EFFECT or EFXUtil.FILTER. objectType, final int OpenAL type the object should be tested for support, e.g. AL_FILTER_LOWPASS or AL_EFFECT_REVERB. typeValue) Generic test function to see if an EFX object supports a given kind of type.

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

EFFECT	back to summary
private static final int EFFECT Constant for testSupportGeneric to check an effect.

FILTER	back to summary
private static final int FILTER Constant for testSupportGeneric to check a filter.

EFXUtil	back to summary
private EFXUtil() Utility class, hidden contructor.

Method Detail

isEffectSupported	back to summary
public static boolean isEffectSupported(final int effectType) Tests OpenAL to see whether the given effect type is supported. This is done by creating an effect of the given type. If creation succeeds the effect is supported. Parameters effectType:int Type of effect whose support is to be tested, e.g. AL_EFFECT_REVERB. Returns:boolean True if it is supported, false if not. Exceptions OpenALException: If the request fails due to an AL_OUT_OF_MEMORY error or OpenAL has not been created yet. IllegalArgumentException: effectType is not a valid effect type.

isEffectSupported

back to summary

public static boolean isEffectSupported(final int effectType)

Tests OpenAL to see whether the given effect type is supported. This is done by creating an effect of the given type. If creation succeeds the effect is supported.

Parameters

effectType:int: Type of effect whose support is to be tested, e.g. AL_EFFECT_REVERB.

Returns:boolean

True if it is supported, false if not.

Exceptions

OpenALException:: If the request fails due to an AL_OUT_OF_MEMORY error or OpenAL has not been created yet.
IllegalArgumentException:: effectType is not a valid effect type.

isEfxSupported	back to summary
public static boolean isEfxSupported() Checks if OpenAL implementation is loaded and supports ALC_EXT_EFX. Returns:boolean True if ALC_EXT_EFX is supported, false if not. Exceptions OpenALException: If OpenAL has not been created yet.

isEfxSupported

back to summary

public static boolean isEfxSupported()

Checks if OpenAL implementation is loaded and supports ALC_EXT_EFX.

Returns:boolean

True if ALC_EXT_EFX is supported, false if not.

Exceptions

OpenALException:: If OpenAL has not been created yet.

isFilterSupported	back to summary
public static boolean isFilterSupported(final int filterType) Tests OpenAL to see whether the given filter type is supported. This is done by creating a filter of the given type. If creation succeeds the filter is supported. Parameters filterType:int Type of filter whose support is to be tested, e.g. AL_FILTER_LOWPASS. Returns:boolean True if it is supported, false if not. Exceptions OpenALException: If the request fails due to an AL_OUT_OF_MEMORY error or OpenAL has not been created yet. IllegalArgumentException: filterType is not a valid filter type.

isFilterSupported

back to summary

public static boolean isFilterSupported(final int filterType)

Tests OpenAL to see whether the given filter type is supported. This is done by creating a filter of the given type. If creation succeeds the filter is supported.

Parameters

filterType:int: Type of filter whose support is to be tested, e.g. AL_FILTER_LOWPASS.

Returns:boolean

True if it is supported, false if not.

Exceptions

OpenALException:: If the request fails due to an AL_OUT_OF_MEMORY error or OpenAL has not been created yet.
IllegalArgumentException:: filterType is not a valid filter type.

testSupportGeneric	back to summary
private static boolean testSupportGeneric(final int objectType, final int typeValue) Generic test function to see if an EFX object supports a given kind of type. Works for effects and filters. Parameters objectType:int Type of object to test. Must be either EFXUtil.EFFECT or EFXUtil.FILTER. typeValue:int OpenAL type the object should be tested for support, e.g. AL_FILTER_LOWPASS or AL_EFFECT_REVERB. Returns:boolean True if object supports typeValue, false else.

testSupportGeneric

back to summary

private static boolean testSupportGeneric(final int objectType, final int typeValue)

Generic test function to see if an EFX object supports a given kind of type. Works for effects and filters.

Parameters

objectType:int: Type of object to test. Must be either EFXUtil.EFFECT or EFXUtil.FILTER.
typeValue:int: OpenAL type the object should be tested for support, e.g. AL_FILTER_LOWPASS or AL_EFFECT_REVERB.

Returns:boolean

True if object supports typeValue, false else.

public final Class EFXUtil

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail