Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.SSWave Class Reference

Synthesizer source wave generator. More...

Inheritance diagram for Dragengine.Scenery.SSWave:
Dragengine.Scenery.SynthesizerSource

Public Member Functions

Constructors
SSWave new ()
 Create animator source. More...
 
Management
void setType (SSWaveType type)
 Set wave type. More...
 
void setMinFrequency (float frequency)
 Set minimum frequency in Hz. More...
 
void setMaxFrequency (float frequency)
 Set maximum frequency in Hz. More...
 
void targetAddLink (SSWaveTarget target, int link)
 Add link to target. More...
 
void targetRemoveAllLinks (SSWaveTarget target)
 Remove all links from target. More...
 
- Public Member Functions inherited from Dragengine.Scenery.SynthesizerSource
void setEnabled (bool enabled)
 Source is enabled. More...
 
void setMixMode (SynthesizerSourceMix mixMode)
 Set if source is enabled. More...
 
void setBlendFactor (float factor)
 Set mixing mode. More...
 
void setMinVolume (float volume)
 Set minimum volume relative to speaker volume in the range from 0 to 1. More...
 
void setMaxVolume (float volume)
 Set maximum volume relative to speaker volume in the range from 0 to 1. More...
 
void setMinPanning (float panning)
 Set minimum panning in the range from -1(left) to 1(right). More...
 
void setMaxPanning (float panning)
 Set maximum panning in the range from -1(left) to 1(right). More...
 
void addEffect (SynthesizerEffect effect)
 Add effect. More...
 
void removeAllEffects ()
 Remove all effects. More...
 

Additional Inherited Members

Constructors

Detailed Description

Synthesizer source wave generator.

This is a native class. It can not be subclassed.

Member Function Documentation

◆ new()

SSWave Dragengine.Scenery.SSWave.new ( )

Create animator source.

Reimplemented from Dragengine.Scenery.SynthesizerSource.

◆ setMaxFrequency()

void Dragengine.Scenery.SSWave.setMaxFrequency ( float  frequency)

Set maximum frequency in Hz.

◆ setMinFrequency()

void Dragengine.Scenery.SSWave.setMinFrequency ( float  frequency)

Set minimum frequency in Hz.

◆ setType()

void Dragengine.Scenery.SSWave.setType ( SSWaveType  type)

Set wave type.

◆ targetAddLink()

void Dragengine.Scenery.SSWave.targetAddLink ( SSWaveTarget  target,
int  link 
)

Add link to target.

Exceptions
EInvalidParamtarget is not a valid value.

◆ targetRemoveAllLinks()

void Dragengine.Scenery.SSWave.targetRemoveAllLinks ( SSWaveTarget  target)

Remove all links from target.

Exceptions
EInvalidParamtarget is not a valid value.

The documentation for this class was generated from the following file: