Package com.jme3.audio

Class HighPassFilter

java.lang.Object
com.jme3.util.NativeObject
com.jme3.audio.Filter
com.jme3.audio.HighPassFilter
All Implemented Interfaces:
Savable, JmeCloneable, Cloneable
public class HighPassFilter extends Filter
Represents an OpenAL EFX High-Pass Filter.

  • Field Details

    • volume

      protected float volume

    • lowFreqVolume

      protected float lowFreqVolume

  • Constructor Details

    • HighPassFilter

      public HighPassFilter()
      Constructs a high-pass filter with default settings. Required for jME deserialization

    • HighPassFilter

      protected HighPassFilter(int id)

    • HighPassFilter

      public HighPassFilter(float volume, float lowFreqVolume)

  • Method Details

    • getVolume

      public float getVolume()

    • setVolume

      public void setVolume(float volume)
      Sets the gain of the High-Pass filter.
      Parameters:
      volume - The gain value (0.0 to 1.0).

    • getLowFreqVolume

      public float getLowFreqVolume()

    • setLowFreqVolume

      public void setLowFreqVolume(float lowFreqVolume)
      Sets the gain at low frequencies for the High-Pass filter.
      Parameters:
      lowFreqVolume - The low-frequency gain value (0.0 to 1.0).

    • createDestructableClone

      public NativeObject createDestructableClone()
      Description copied from class: NativeObject
      Creates a shallow clone of this GL Object. The deleteObject method should be functional for this object.
      Specified by:
      createDestructableClone in class Filter
      Returns:
      a new instance

    • getUniqueId

      public long getUniqueId()
      Retrieves a unique identifier for this filter. Used internally for native object management.
      Specified by:
      getUniqueId in class NativeObject
      Returns:
      a unique long identifier.

    • write

      public void write(JmeExporter ex) throws IOException
      Specified by:
      write in interface Savable
      Overrides:
      write in class Filter
      Throws:
      IOException

    • read

      public void read(JmeImporter im) throws IOException
      Specified by:
      read in interface Savable
      Overrides:
      read in class Filter
      Throws:
      IOException