Enum Effect

Namespace

SunSharp

Assembly

SunSharp.dll

Represents various effects that can be applied to notes or tracks in the SunVox pattern.

public enum Effect : byte

Extension Methods

EffectExtensions.ChangesTempo(Effect)

EffectExtensions.IsDestructive(Effect)

EffectExtensions.IsEventDelay(Effect)

EffectExtensions.IsNonLinear(Effect)

Fields

Arpeggio = 8

Arpeggio. XX - second note increment; YY - third note increment.

BindMidiOut = 53

Bind MIDI OUT message XX (0x0 - Program Change; 0x1 - Channel Pressure; 0x2 - Pitch Bend Change) to controller YY (0x0 - OFF; 0x80 - MIDI controller 0x0; 0x81 - MIDI controller 0x1...). For the specified module only.

ChangeModuleFineTune = 21

Change the relative note and finetune of the module. XX - relative note (0x00 - ignore; 0x01 = -127 decimal; 0x80 = 0x0; 0xFF = 127 decimal); YY - finetune (0x00 - ignore; 0x01 = one semitone lower; 0x80 = 0x0; 0xFF = one semitone higher).

CopyTrackFromPattern = 60

Copy track XX from the pattern YY. For example, if XXYY = 0x0023, then the first track will be copied from the pattern named "23". Destructive effect - irreversibly changes the contents of the pattern.

CopyTrackToPattern = 59

Copy track XX to the pattern named YY. Destructive effect - irreversibly changes the contents of the pattern.

CutNote = 28

Cut note after YY ticks in the current line.

CyclicShiftTrackLines = 57

Cyclic shift of track XX down by YY lines. Destructive effect - irreversibly changes the contents of the pattern.

Delay0 = 64

Delays an event for 0x0/0x20 of line duration.

Delay1 = 65

Delays an event for 0x1/0x20 of line duration.

Delay10 = 74

Delays an event for 0xA/0x20 of line duration.

Delay11 = 75

Delays an event for 0xB/0x20 of line duration.

Delay12 = 76

Delays an event for 0xC/0x20 of line duration.

Delay13 = 77

Delays an event for 0xD/0x20 of line duration.

Delay14 = 78

Delays an event for 0xE/0x20 of line duration.

Delay15 = 79

Delays an event for 0xF/0x20 of line duration.

Delay16 = 80

Delays an event for 0x10/0x20 of line duration.

Delay17 = 81

Delays an event for 0x11/0x20 of line duration.

Delay18 = 82

Delays an event for 0x12/0x20 of line duration.

Delay19 = 83

Delays an event for 0x13/0x20 of line duration.

Delay2 = 66

Delays an event for 0x2/0x20 of line duration.

Delay20 = 84

Delays an event for 0x14/0x20 of line duration.

Delay21 = 85

Delays an event for 0x15/0x20 of line duration.

Delay22 = 86

Delays an event for 0x16/0x20 of line duration.

Delay23 = 87

Delays an event for 0x17/0x20 of line duration.

Delay24 = 88

Delays an event for 0x18/0x20 of line duration.

Delay25 = 89

Delays an event for 0x19/0x20 of line duration.

Delay26 = 90

Delays an event for 0x1A/0x20 of line duration.

Delay27 = 91

Delays an event for 0x1B/0x20 of line duration.

Delay28 = 92

Delays an event for 0x1C/0x20 of line duration.

Delay29 = 93

Delays an event for 0x1D/0x20 of line duration.

Delay3 = 67

Delays an event for 0x3/0x20 of line duration.

Delay30 = 94

Delays an event for 0x1E/0x20 of line duration.

Delay31 = 95

Delays an event for 0x1F/0x20 of line duration.

Delay4 = 68

Delays an event for 0x4/0x20 of line duration.

Delay5 = 69

Delays an event for 0x5/0x20 of line duration.

Delay6 = 70

Delays an event for 0x6/0x20 of line duration.

Delay7 = 71

Delays an event for 0x7/0x20 of line duration.

Delay8 = 72

Delays an event for 0x8/0x20 of line duration.

Delay9 = 73

Delays an event for 0x9/0x20 of line duration.

DelayNote = 29

Delay the start of note until tick YY in the current line.

DeleteEventOnTrackWithProbability = 56

Delete an event on track XX with a probability of YY (0x00 to 0xFF (100%)). Destructive effect - irreversibly changes the contents of the pattern.

FineSlideDown = 18

Fine slide down. XXYY specifies the amount.

FineSlideUp = 17

Fine slide up. XXYY specifies the amount.

FineVelocitySlide = 26

Fine velocity slide up/down. XX - up speed; YY - down speed. Applied once at the beginning of a line.

GeneratePolyrhythm = 58

Generate a new iteration of YY-line polyrhythm on track XX. Destructive effect - irreversibly changes the contents of the pattern.

Jump = 49

Jump to line XXYY (address) right after the end of the current line.

None = 0

No effect applied.

NoteProbability = 32

Note probability. XXYY specifies the probability.

NoteProbabilityRandomVelocity = 33

Note probability with random velocity. XXYY specifies the probability.

PitchBendDown = 6

Pitch bend down: pitch = original pitch (initialized when a note is activated) - XXYY. One semitone = 0x0100.

PitchBendUp = 5

Pitch bend up: pitch = original pitch (initialized when a note is activated) + XXYY. One semitone = 0x0100.

PlayNoteFromLine = 36

Take a note from line XXYY on the same track.

PlayNoteFromLineOnTrackZero = 40

Take a note from line XXYY on track 0x0.

PlayNoteRandomTrackSameLine = 38

Take a note from track XXYY on the same line.

PlayRandomNoteFromRange = 37

Take a random note from the range of lines XX..YY (inclusive) on the same track.

PlayRandomNoteFromRangeOnTrackZero = 41

Take a random note from the range of lines XX..YY (inclusive) on track 0x0.

PlayRandomNoteFromRangeTracksSameLine = 39

Take a random note from the range of tracks XX..YY (inclusive) on the same line.

ResetBypassSoloMute = 20

Reset Bypass/Solo/Mute (BSM = XYY) flags. Bypass - 0x0100; Solo - 0x0010; Mute - 0x0001.

Retrigger = 25

Retrigger note after XXYY ticks during the line.

SetBpm = 31

Set BPM to XXYY.

SetBypassSoloMute = 19

Set Bypass/Solo/Mute (BSM = XYY) flags. Bypass - 0x0100; Solo - 0x0010; Mute - 0x0001.

SetControllerRandomAbsolute = 34

Set controller value to a random number from 0x0000 to XXYY.

SetControllerRandomRange = 35

Set controller value to a random number with range from XX (0x00 to 0xFF) to YY (0x00 to 0xFF).

SetJumpMode = 50

Set jump address mode YY: 0x0 - absolute address, relative to the start of the timeline (default); 0x1 - (pattern beginning + address); 0x2 - (pattern beginning - address); 0x3 - (next line + address); 0x4 - (next line - address).

SetPhase = 9

Set phase (or sample offset) XXYY in samples*0x0100.

SetPhasePercents = 7

Set phase (or sample offset) XXYY in percents (from 0x0000 (0%) to 0x8000 (100%)).

SetPlayingSpeed = 15

Set playing speed or time grids. XXYY: 0x0001 to 0x001F - number of ticks per line; 0x0020 to 0x00FF - BPM; XXYY: 0xF001 to 0xF020 and 0xF100 to 0xF120 - time grids.

SetResetProjectOptions = 52

Set (XX) or reset (YY) project options: 0x1 - no portamento on the first tick (for compatibility with old tracker formats); 0x2 - no velocity slide on the first tick (for compatibility with old tracker formats); 0x4 - use Round-robin keyboard track allocation algorithm, instead of default tight packing; 0x8 - always output 7-bit MIDI controller values, even if the controller is 14-bit (0x0-0x1F).

SlideDown = 2

Slide down (portamento down). Sliding speed = XXYY. Can use the last nonzero parameter when XXYY = 0x0000.

SlideToNote = 3

Slide to note. Sliding speed = XXYY. Can use the last nonzero parameter when XXYY = 0x0000.

SlideUp = 1

Slide up (portamento up). Sliding speed = XXYY. Can use the last nonzero parameter when XXYY = 0x0000.

SlotSync = 51

Slot sync (for sv_sync_resume() in SunVox library).

StopPlaying = 48

Stop playing the song.

VelocitySlide = 10

Velocity slide up/down. XX - up speed; YY - down speed. Can use the last nonzero parameter when XXYY = 0x0000.

Vibrato = 4

Vibrato. XX - frequency; YY - amplitude. Can use the last nonzero parameter when XXYY = 0x0000.

WriteRandomValue = 61

Write a random value to track YY. Min value, max value and column must be in track 0x0, starting from line XX. Destructive effect - irreversibly changes the contents of the pattern.