Class: FMOD::Core::DataDescription

Inherits:
Structure
  • Object
show all
Defined in:
lib/fmod/core/data_description.rb

Overview

Structure describing a data parameter for a DSP unit.

Constant Summary collapse

TYPE_USER =

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

0
TYPE_OVERALLGAIN =

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

1
TYPE_3DATTRIBUTES =

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

2
TYPE_SIDECHAIN =

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

3
TYPE_FFT =

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

4
TYPE_3DATTRIBUTES_MULTI =

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

5

Instance Method Summary collapse

Methods inherited from Structure

#inspect, #names, #values

Constructor Details

#initialize(address = nil) ⇒ DataDescription

Returns a new instance of DataDescription.

Parameters:

  • address (Pointer, Integer, String, nil) (defaults to: nil) —

    The address in memory where the structure will be created from. If no address is given, new memory will be allocated.



40
41
42
 
# File 'lib/fmod/core/data_description.rb', line 40

def initialize(address = nil)
  super(address, [TYPE_INT], [:data_type])
end

Instance Method Details

#data_type ⇒ Object

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



53
54
55
 
# File 'lib/fmod/core/data_description.rb', line 53

def data_type
  self[:data_type]
end