S2L Tubes

Functions Provided By S2L Tubes

This effect uses the following functions:

▪	This Effect uses the Color Controls. Learn more »Using Color Controls

Function	Description
void SetFade(int value)	Sets the Fade value.
int GetFade()	Returns the Fade value.
void SetSize1(float value)	Sets the Size 1 value
float GetSize1()	Returns the Size 1 value.
void SetPitch1(float value)	Sets the Pitch 1 value
float GetPitch1()	Returns the Pitch 1 value.
void SetSize2(float value)	Sets the Size 2 value
float GetSize2()	Returns the Size 2 value.
void SetPitch2(float value)	Sets the Pitch 2 value
float GetPitch2()	Returns the Pitch 2 value.
void SetAlphaMix(int value)	Sets the Alpha Mix value.
int GetAlphaMix()	Returns the Alpha Mix value.
void SetInvert(int value)	Sets the Invert option. Use TRUE to activate it. Use FALSE to deactivate it.
int GetInvert()	Returns TRUE, if the Invert option is activated, otherwise FALSE.
void ToggleInvert()	Toggle the Invert option.
void SetMirror(int value)	Sets the Mirror option. Use TRUE to activate it. Use FALSE to deactivate it.
int GetMirror()	Returns TRUE, if the Mirror option is activated, otherwise FALSE.
void ToggleMirror()	Toggle the Mirror option.
void SetTubesVertical(int value)	Use TRUE to activate vertical Tubes. Use FALSE to deactivate it.
int GetTubesVertical()	Returns TRUE if vertical Tubes are activated, otherwise FALSE.
void ToggleTubesVertical()	Toggle vertical Tubes.
void SetTubesHorizontal(int value)	Use TRUE to activate horizontal Tubes. Use FALSE to deactivate it.
int GetTubesHorizontal()	Returns TRUE if horizontal Tubes are activated, otherwise FALSE.
void ToggleTubesHorizontal()	Toggle horizontal Tubes.
void SetTubesDepth(int value)	Use TRUE to activate depth Tubes. Use FALSE to deactivate it.
int GetTubesDepth()	Returns TRUE if depth Tubes are activated, otherwise FALSE.
void ToggleTubesDepth()	Toggle depth Tubes.

void SetSensitivity(int value)	Sets the Sensitivity value.
int SetSensitivity()	Returns the Sensitivity value.
void SetShift(int value)	Sets the Shift value.
int GetShift()	Returns the Shift value.
void SetAmplification(int value)	Sets the Amplification value.
int GetAmplification()	Returns the Amplification value.
void SetGeneratorType(int value)	Sets the Generator Type. See below for a list of constants.
int GetGeneratorType()	Returns the current Generator Type. See below for a list of constants.

Generator Type Constants

Constant	Description
int GENERATOR_TYPE_EQ	Sets the generator type to EQ.
int GENERATOR_TYPE_LEVEL_MONO	Sets the generator type to Level Mono.
int GENERATOR_TYPE_LEVEL_STEREO	Sets the generator type to Level Stereo.

Deprecated Functions

Deprecated functions are outdated functions and should not be used anymore.

Function/Constant	Description
void SetAmplify(int value)	Use void SetAmplification(int value) instead.
int GetAmplify()	Use int GetAmplification() instead.

MADRIX 2.X To MADRIX 3.X Migration Hints

The MADRIX 2.X effect S2L EQ Tubes has been renamed to S2L Tubes in MADRIX 3.X. The following functions and constants are not supported anymore. Please follow the hints to migrate your macros.

Function/Constant	Description
void SetSens(int value)	Use SetSensitivity(int value) instead.
int GetSens()	Use GetSetSensitivity() instead.
void SetDirection(int value)	Use SetTubesVertical(int value), SetTubesHorizontal() and SetTubesDepth() instead.
int GetDirection()	Use GetTubesVertical(), GetTubesHorizontal() and GetTubesDepth() instead.
void SetBandCount(int value)	Use SetPitch1(float value) and SetPitch2(float value) instead. If you like to see no gabs or overlapping tubes use SetSize1(float value) and SetSize2(float value) with the same values as the pitch values.
int GetBandCount()	Use GetPitch1() and GetPitch2() instead.
void SetUseLevel(int value)	Use SetAlphaMix(int value) with a value of 100 instead.
int GetUseLevel()	Use GetAlphaMix() instead.