FMOD_DSP_PARAMETER_DESC

FMOD Studio API

previous page next page

Firelight Technologies FMOD Studio API

FMOD_DSP_PARAMETER_DESC

Base Structure for DSP parameter descriptions.

C/C++ Syntax

typedef struct {
  FMOD_DSP_PARAMETER_TYPE type;
  char name[16];
  char label[16];
  const char *description;
  FMOD_DSP_PARAMETER_DESC_FLOAT floatdesc;
  FMOD_DSP_PARAMETER_DESC_INT intdesc;
  FMOD_DSP_PARAMETER_DESC_BOOL booldesc;
  FMOD_DSP_PARAMETER_DESC_DATA datadesc;
} FMOD_DSP_PARAMETER_DESC;

JavaScript Syntax

struct FMOD_DSP_PARAMETER_DESC
{
  type,
  name,
  label,
  description,
};

Members

type

[w] Type of this parameter.

name

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

label

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

description

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

floatdesc

[w] Struct containing information about the parameter in floating point format. Use when type is FMOD_DSP_PARAMETER_TYPE_FLOAT.

intdesc

[w] Struct containing information about the parameter in integer format. Use when type is FMOD_DSP_PARAMETER_TYPE_INT.

booldesc

[w] Struct containing information about the parameter in boolean format. Use when type is FMOD_DSP_PARAMETER_TYPE_BOOL.

datadesc

[w] Struct containing information about the parameter in data format. Use when type is FMOD_DSP_PARAMETER_TYPE_DATA.

Remarks

Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.
Members marked with [w] mean the variable can be written to. The user can set the value.

JavaScript only :

Not all fields are currently supported or may not work as expected at this time. To initialize an new instance in javascript use "FMOD.DSP_PARAMETER_DESC()", no 'new' keyword is required.

See Also




Version 1.10.03 Built on Feb 1, 2018


previous page start next page