org.jouvieje.fmodex.structures
Class FMOD_DSP_PARAMETERDESC

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

public class FMOD_DSP_PARAMETERDESC

extends Pointer

Constructor Summary

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

Method Summary

static FMOD_DSP_PARAMETERDESC	allocate() Allocate a new FMOD_DSP_PARAMETERDESC.
static FMOD_DSP_PARAMETERDESC[]	allocate(int length) Allocate and initialize a new FMOD_DSP_PARAMETERDESC[].
static FMOD_DSP_PARAMETERDESC	asFMOD_DSP_PARAMETERDESC(Pointer pointer) Create a view of the Pointer object as a FMOD_DSP_PARAMETERDESC object.
float	getDefaultVal() [w] Default value of parameter.
java.lang.String	getDescription() [w] Description of the parameter to be displayed as a help item / tooltip for this parameter.
java.lang.String	getLabel() [w] Short string to be put next to value to denote the unit type (ie "hz").
float	getMax() [w] Maximum value of the parameter (ie 22050.0).
float	getMin() [w] Minimum value of the parameter (ie 100.0).
java.lang.String	getName() [w] Name of the parameter to be displayed (ie "Cutoff frequency").
void	release()
void	setDefaultVal(float defaultVal) [w] Default value of parameter.
void	setDescription(java.lang.String description) [w] Description of the parameter to be displayed as a help item / tooltip for this parameter.
void	setLabel(java.lang.String label) [w] Short string to be put next to value to denote the unit type (ie "hz").
void	setMax(float max) [w] Maximum value of the parameter (ie 22050.0).
void	setMin(float min) [w] Minimum value of the parameter (ie 100.0).
void	setName(java.lang.String name) [w] Name of the parameter to be displayed (ie "Cutoff frequency").

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_PARAMETERDESC

public FMOD_DSP_PARAMETERDESC()

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

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

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

  FMOD_DSP_PARAMETERDESC obj = FMOD_DSP_PARAMETERDESC.allocate();

See Also:

allocate()

Method Detail

asFMOD_DSP_PARAMETERDESC

public static FMOD_DSP_PARAMETERDESC asFMOD_DSP_PARAMETERDESC(Pointer pointer)

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

allocate

public static FMOD_DSP_PARAMETERDESC[] allocate(int length)

Allocate and initialize a new FMOD_DSP_PARAMETERDESC[].

Parameters:

length - length of the array returned.

allocate

public static FMOD_DSP_PARAMETERDESC allocate()

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

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

release

public void release()

getMin

public float getMin()

[w] Minimum value of the parameter (ie 100.0).

setMin

public void setMin(float min)

[w] Minimum value of the parameter (ie 100.0).

getMax

public float getMax()

[w] Maximum value of the parameter (ie 22050.0).

setMax

public void setMax(float max)

[w] Maximum value of the parameter (ie 22050.0).

getDefaultVal

public float getDefaultVal()

[w] Default value of parameter.

setDefaultVal

public void setDefaultVal(float defaultVal)

[w] Default value of parameter.

getName

public java.lang.String getName()

[w] Name of the parameter to be displayed (ie "Cutoff frequency").

setName

public void setName(java.lang.String name)

[w] Name of the parameter to be displayed (ie "Cutoff frequency").

getLabel

public java.lang.String getLabel()

[w] Short string to be put next to value to denote the unit type (ie "hz").

setLabel

public void setLabel(java.lang.String label)

[w] Short string to be put next to value to denote the unit type (ie "hz").

getDescription

public java.lang.String getDescription()

[w] Description of the parameter to be displayed as a help item / tooltip for this parameter.

setDescription

public void setDescription(java.lang.String description)

[w] Description of the parameter to be displayed as a help item / tooltip for this parameter.