Class OALEffect

java.lang.Object

com.blackrook.gloop.openal.OALObject

com.blackrook.gloop.openal.OALEffect

Direct Known Subclasses:

AutowahEffect, ChorusEffect, CompressorEffect, DistortionEffect, EchoEffect, EqualizerEffect, FlangerEffect, FrequencyShiftEffect, PitchShiftEffect, ReverbEffect, RingModulatorEffect, VocalMorpherEffect

public abstract class OALEffect
extends OALObject

Effect object for OpenAL sources.

Author:

Matthew Tropiano

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OALEffect(OALContext context, int alEffectType)

Method Summary

Modifier and Type	Method	Description
protected final int	allocate()	Allocates a new type of this object in OpenAL.
protected final void	free()	Destroys this object (deallocates it on OpenAL).

Methods inherited from class OALObject

clearError, destroy, equals, equals, errorCheck, getName, hashCode, requestContext, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OALEffect

protected OALEffect(OALContext context,
 int alEffectType)

Method Details

allocate

protected final int allocate()

Description copied from class: OALObject

Allocates a new type of this object in OpenAL. Called by OALObject constructor.

Specified by:

allocate in class OALObject

Returns:

the ALId of this new object.

free

protected final void free()

Description copied from class: OALObject

Destroys this object (deallocates it on OpenAL). This is called by destroy().

Specified by:

free in class OALObject