Class LowPassFilter

java.lang.Object

com.blackrook.gloop.openal.OALObject

com.blackrook.gloop.openal.OALFilter

com.blackrook.gloop.openal.filter.LowPassFilter

public class LowPassFilter
extends OALFilter

Low-pass filter object for low-pass filtering.

Author:

Matthew Tropiano

Field Summary

Fields

Modifier and Type	Field	Description
protected float	gain	Low-pass gain.
protected float	gainHF	High-frequency low-pass gain.

Constructor Summary

Constructors

Constructor	Description
LowPassFilter(OALContext context)

Method Summary

Modifier and Type	Method	Description
float	getGain()
float	getHFGain()
void	setGain(float gain)	Sets this filter's gain.
void	setHFGain(float gain)	Sets this filter's high-frequency gain.

Methods inherited from class OALFilter

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

gain

protected float gain

Low-pass gain.

gainHF

protected float gainHF

High-frequency low-pass gain.

Constructor Details

LowPassFilter

public LowPassFilter(OALContext context)

Method Details

getGain

public float getGain()

Returns:

this filter's gain.

setGain

public void setGain(float gain)

Sets this filter's gain.

Parameters:

gain - the gain value (0.0 to 1.0).

getHFGain

public float getHFGain()

Returns:

this filter's high-frequency gain.

setHFGain

public void setHFGain(float gain)

Sets this filter's high-frequency gain.

Parameters:

gain - the gain value (0.0 to 1.0).