org.jouvieje.fmodex.structures
Class FMOD_DSP_STATE

java.lang.Object
  org.jouvieje.fmodex.utils.Pointer
      org.jouvieje.fmodex.structures.FMOD_DSP_STATE

public class FMOD_DSP_STATE

extends Pointer

Constructor Summary

FMOD_DSP_STATE()
Create an object that holds a null FMOD_DSP_STATE.

Method Summary

static FMOD_DSP_STATE	allocate() Allocate a new FMOD_DSP_STATE.
static FMOD_DSP_STATE	asFMOD_DSP_STATE(Pointer pointer) Create a view of the Pointer object as a FMOD_DSP_STATE object.
DSP	getInstance() [r] Handle to the DSP hand the user created.
Pointer	getPluginData() [w] Plugin writer created data the output author wants to attach to this object.
short	getSpeakerMask() [w] Specifies which speakers the DSP effect is active on
void	release()
void	setPluginData(Pointer pluginData) [w] Plugin writer created data the output author wants to attach to this object.
void	setSpeakerMask(short speakerMask) [w] Specifies which speakers the DSP effect is active on

Methods inherited from class org.jouvieje.fmodex.utils.Pointer

asByteBuffer, asDouble, asFloat, asInt, asLong, asPointer, asString, asString, equals, isNull, shareMemory

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FMOD_DSP_STATE

public FMOD_DSP_STATE()

Create an object that holds a null FMOD_DSP_STATE.
The call isNull() on the object created will returns true.

  FMOD_DSP_STATE obj = new FMOD_DSP_STATE();
  (obj == null) <=> false
  obj.isNull() <=> true
 

To creates a new FMOD_DSP_STATE, use the static "constructor" :

  FMOD_DSP_STATE obj = FMOD_DSP_STATE.allocate();

See Also:

allocate()

Method Detail

asFMOD_DSP_STATE

public static FMOD_DSP_STATE asFMOD_DSP_STATE(Pointer pointer)

Create a view of the Pointer object as a FMOD_DSP_STATE object.
This view is valid only if the memory holded by the Pointer holds a FMOD_DSP_STATE object.

allocate

public static FMOD_DSP_STATE allocate()

Allocate a new FMOD_DSP_STATE.
The call isNull() on the object created will return false.

  FMOD_DSP_STATE obj = FMOD_DSP_STATE.allocate();
  (obj == null) <=> obj.isNull() <=> false
 

release

public void release()

getInstance

public DSP getInstance()

[r] Handle to the DSP hand the user created. Not to be modified. C++ users cast to FMOD::DSP to use.

getPluginData

public Pointer getPluginData()

[w] Plugin writer created data the output author wants to attach to this object.

setPluginData

public void setPluginData(Pointer pluginData)

[w] Plugin writer created data the output author wants to attach to this object.

getSpeakerMask

public short getSpeakerMask()

[w] Specifies which speakers the DSP effect is active on

setSpeakerMask

public void setSpeakerMask(short speakerMask)

[w] Specifies which speakers the DSP effect is active on