Class FrequencyShiftEffect

java.lang.Object

com.blackrook.gloop.openal.OALObject

com.blackrook.gloop.openal.OALEffect

com.blackrook.gloop.openal.effect.FrequencyShiftEffect

public class FrequencyShiftEffect
extends OALEffect

Frequency shift effects for sources.

Author:

Matthew Tropiano

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FrequencyShiftEffect.Direction	Shift direction enumeration.

Field Summary

Fields

Modifier and Type	Field	Description
protected float	frequency	Frequency shifter frequency.
protected FrequencyShiftEffect.Direction	leftDir	Frequency shifter left direction.
protected FrequencyShiftEffect.Direction	rightDir	Frequency shifter right direction.

Constructor Summary

Constructors

Constructor	Description
FrequencyShiftEffect(OALContext context)

Method Summary

Modifier and Type	Method	Description
final float	getFrequency()
final FrequencyShiftEffect.Direction	getLeftDirection()
final FrequencyShiftEffect.Direction	getRightDirection()
final void	setFrequency(float frequency)	Set frequency shifter frequency (0.0 to 24000.0).
final void	setLeftDirection(FrequencyShiftEffect.Direction leftDir)	Set frequency shifter left direction.
final void	setRightDirection(FrequencyShiftEffect.Direction rightDir)	Set frequency shifter right direction.

Methods inherited from class OALEffect

allocate, free

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

Field Details

frequency

protected float frequency

Frequency shifter frequency.

leftDir

protected FrequencyShiftEffect.Direction leftDir

Frequency shifter left direction.

rightDir

protected FrequencyShiftEffect.Direction rightDir

Frequency shifter right direction.

Constructor Details

FrequencyShiftEffect

public FrequencyShiftEffect(OALContext context)

Method Details

getFrequency

public final float getFrequency()

Returns:

the current frequency shifter frequency.

setFrequency

public final void setFrequency(float frequency)

Set frequency shifter frequency (0.0 to 24000.0).

Parameters:

frequency - the new value.

getLeftDirection

public final FrequencyShiftEffect.Direction getLeftDirection()

Returns:

the current frequency shifter left direction.

setLeftDirection

public final void setLeftDirection(FrequencyShiftEffect.Direction leftDir)

Set frequency shifter left direction.

Parameters:

leftDir - the direction type.

getRightDirection

public final FrequencyShiftEffect.Direction getRightDirection()

Returns:

the current frequency shifter right direction.

setRightDirection

public final void setRightDirection(FrequencyShiftEffect.Direction rightDir)

Set frequency shifter right direction.

Parameters:

rightDir - the direction type.