Table of Contents

Interface IDistortionModuleHandle

Namespace
SunSharp.Modules
Assembly
SunSharp.dll

This module adds various types of distortion to the sound.

public interface IDistortionModuleHandle : ITypedModuleHandle, IGenericSynthModuleHandle
Inherited Members

Methods

GetBitDepth(ValueScalingMode)

Original name: 3 'Bit depth'

int GetBitDepth(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetDistortionType()

Original name: 1 'Type'

DistortionType GetDistortionType()

Returns

DistortionType

GetFreq(ValueScalingMode)

Value range: displayed: 0 to 44100, real: 0 to 44100 Original name: 4 'Freq'

int GetFreq(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetNoise(ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 5 'Noise'

int GetNoise(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetPower(ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 2 'Power'

int GetPower(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetVolume(ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 0 'Volume'

int GetVolume(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

MakeBitDepthEvent(int)

This is a helper method to automatically handle turning target controller values into column values.

For this controller the input value is taken as is, only clamped to column value range.

PatternEvent MakeBitDepthEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeDistortionTypeEvent(DistortionType)

This is a helper method to automatically handle turning target controller values into column values.

For this controller the input value is taken as is, only clamped to column value range.

PatternEvent MakeDistortionTypeEvent(DistortionType value)

Parameters

value DistortionType

Returns

PatternEvent

MakeFreqEvent(int)

This is a helper method to automatically handle turning target controller values into column values.

For this controller the input value is mapped from displayed range (0 to 44100) to column range (0 to 0x8000). Out of range values are clamped.

PatternEvent MakeFreqEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeNoiseEvent(int)

This is a helper method to automatically handle turning target controller values into column values.

For this controller the input value is mapped from displayed range (0 to 256) to column range (0 to 0x8000). Out of range values are clamped.

PatternEvent MakeNoiseEvent(int value)

Parameters

value int

Returns

PatternEvent

MakePowerEvent(int)

This is a helper method to automatically handle turning target controller values into column values.

For this controller the input value is mapped from displayed range (0 to 256) to column range (0 to 0x8000). Out of range values are clamped.

PatternEvent MakePowerEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeVolumeEvent(int)

This is a helper method to automatically handle turning target controller values into column values.

For this controller the input value is mapped from displayed range (0 to 256) to column range (0 to 0x8000). Out of range values are clamped.

PatternEvent MakeVolumeEvent(int value)

Parameters

value int

Returns

PatternEvent

SetBitDepth(int, ValueScalingMode)

Original name: 3 'Bit depth' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

void SetBitDepth(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int
valueScalingMode ValueScalingMode

SetDistortionType(DistortionType)

Original name: 1 'Type' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

void SetDistortionType(DistortionType value)

Parameters

value DistortionType

SetFreq(int, ValueScalingMode)

Value range: displayed: 0 to 44100, real: 0 to 44100 Original name: 4 'Freq' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

void SetFreq(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int
valueScalingMode ValueScalingMode

SetNoise(int, ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 5 'Noise' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

void SetNoise(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int
valueScalingMode ValueScalingMode

SetPower(int, ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 2 'Power' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

void SetPower(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int
valueScalingMode ValueScalingMode

SetVolume(int, ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 0 'Volume' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

void SetVolume(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int
valueScalingMode ValueScalingMode