class FMOD::Core::DataDescription

Structure describing a data parameter for a DSP unit.

Constants

TYPE_3DATTRIBUTES

The data type for 3D attribute parameters. There should a maximum of one per DSP.

TYPE_3DATTRIBUTES_MULTI

The data type for multiple 3D attribute parameters. There should a maximum of one per DSP.

TYPE_FFT

The data type for FFT parameters. There should a maximum of one per DSP.

TYPE_OVERALLGAIN

The data type for overall-gain parameters. There should a maximum of one per DSP.

TYPE_SIDECHAIN

The data type for side-chain parameters. There should a maximum of one per DSP.

TYPE_USER

The default data type. All user data types should be 0 or above.

Public Class Methods

new(address = nil) click to toggle source

@param address [Pointer, Integer, String, nil] The address in memory

where the structure will be created from. If no address is given, new
memory will be allocated.
Calls superclass method
# File lib/fmod/core/data_description.rb, line 40
def initialize(address = nil)
  super(address, [TYPE_INT], [:data_type])
end

Public Instance Methods

data_type() click to toggle source

The type of data for this parameter. Use 0 or above for custom types or set to one of the following are possible values:

  • {TYPE_USER}

  • {TYPE_OVERALLGAIN}

  • {TYPE_3DATTRIBUTES}

  • {TYPE_SIDECHAIN}

  • {TYPE_FFT}

  • {TYPE_3DATTRIBUTES_MULTI}

# File lib/fmod/core/data_description.rb, line 53
def data_type
  self[:data_type]
end