Dragengine.Audio.SynthesizerDefinition.SDEffect Class Reference

Definition of synthesizer effect. More...

Inheritance diagram for Dragengine.Audio.SynthesizerDefinition.SDEffect:

Public Member Functions
void	addTargetLink (SDSourceTargetLink targetLink)
	Add target link. More...
SynthesizerEffect	buildEffect (Synthesizer synthesizer)
	Build engine synthesizer effect using the stored definition. More...
void	debug (Console console)
void	forEachTarget (Block ablock)
	Visit targets with a block. More...
float	getStrength ()
	Strength of effect. More...
SDSourceTargetLink	getTargetLinkAt (int index)
	Target link at index. More...
int	getTargetLinkCount ()
	Number of target links. More...
SDEffect	new ()
	Create synthesizer effect definition. More...
void	setEnabled (bool enabled)
	Set if effect is enabled. More...
void	setStrength (float strength)
	Set strength of effect. More...

Protected Member Functions
String	debugCommon (String type)

Detailed Description

Definition of synthesizer effect.

Once defined a effect can be added to an synthesizer using the stored definition. This is the base effect class with the properties shared amongst all effect types.

Member Function Documentation

addTargetLink()

void Dragengine.Audio.SynthesizerDefinition.SDEffect.addTargetLink

(

SDSourceTargetLink

targetLink

)

Add target link.

buildEffect()

SynthesizerEffect Dragengine.Audio.SynthesizerDefinition.SDEffect.buildEffect

(

Synthesizer

synthesizer

)

Build engine synthesizer effect using the stored definition.

Reimplemented in Dragengine.Audio.SynthesizerDefinition.SDEffectStretch.

debug()

void Dragengine.Audio.SynthesizerDefinition.SDEffect.debug

(

Console

console

)

Reimplemented in Dragengine.Audio.SynthesizerDefinition.SDEffectStretch.

debugCommon()

String Dragengine.Audio.SynthesizerDefinition.SDEffect.debugCommon ( String  type )

protected

forEachTarget()

void Dragengine.Audio.SynthesizerDefinition.SDEffect.forEachTarget

(

Block

ablock

)

Visit targets with a block.

getStrength()

float Dragengine.Audio.SynthesizerDefinition.SDEffect.getStrength

(

)

Strength of effect.

getTargetLinkAt()

SDSourceTargetLink Dragengine.Audio.SynthesizerDefinition.SDEffect.getTargetLinkAt

(

int

index

)

Target link at index.

getTargetLinkCount()

int Dragengine.Audio.SynthesizerDefinition.SDEffect.getTargetLinkCount

(

)

Number of target links.

new()

SDEffect Dragengine.Audio.SynthesizerDefinition.SDEffect.new

(

)

Create synthesizer effect definition.

Reimplemented in Dragengine.Audio.SynthesizerDefinition.SDEffectStretch.

setEnabled()

void Dragengine.Audio.SynthesizerDefinition.SDEffect.setEnabled

(

bool

enabled

)

Set if effect is enabled.

setStrength()

void Dragengine.Audio.SynthesizerDefinition.SDEffect.setStrength

(

float

strength

)

Set strength of effect.

---

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

• SDEffect.ds