Function
|
Description
|
void SetBpm(int bpm)
|
Sets the speed of the effect in BPM. Valid values range from 0 to 9999 BPM.
|
int GetBpm()
|
Returns the current effect speed in BPM.
|
void SetFade(int fade)
|
Sets the "fade" value. Valid values range from 1 to 100.
|
int GetFade()
|
Returns the current "fade" value.
|
void SetDirection(int dir)
|
Sets the direction of the effect. Valid values for dir are DIR_UP, DIR_DOWN, DIR_LEFT and DIR_RIGHT.
|
int GetDirection()
|
Returns the current direction.
|
void SetCrossed(int enable)
|
Enables cross-direction mode if enable is set to true. Otherwise, it is disabled.
|
int GetCrossed()
|
Returns true if cross-direction mode is enabled, otherwise false is returned.
|
void SetAmplify(int amp)
|
Sets the "Amplify" value. Valid values range from 0 to 100.
|
int GetAmplify()
|
Returns the current "Amplify" value.
|
void SetBandCount(int cnt)
|
Sets the number of "bands" to be displayed. Valid values are 1 and 2.
|
int GetBandCount()
|
Returns the current number of "bands".
|
int SetInvert(int enable)
|
Disables "Invert" if enable is set to false. Otherwise, it will be enabled.
|
void GetInvert()
|
Returns true if "Invert" is enabled, otherwise false.
|
void SetMirror(int mirror)
|
Disables "Mirror" if enable is set to false. Otherwise, it will be enabled.
|
int GetMirror()
|
Returns true if "Mirror" is enabled, otherwise false.
|
void SetViewLog(int enable)
|
Disables "ViewLog" if enable is set to false. Otherwise, it will be enabled.
|
int GetViewLog()
|
Returns true if "ViewLog" is enabled, otherwise false.
|
void SetDoubleOutwards(int enable)
|
Disables "double outwards" if enable is false. Otherwise, it will be enabled.
|
int GetDoubleOutwards()
|
Returns true if "double outwards" is enabled, otherwise false.
|
void SetDoubleInwards(int enable)
|
Disables "double inwards" if enable is set to false. Otherwise, it will be enabled.
|
int GetDoubleInwards()
|
Returns true if "double inwards" is enabled, otherwise false.
|
void SetMonochrome(int enable)
|
Enables or disables monochrome mode.
|
int GetMonochrome()
|
Returns whether monochrome mode is enabled or not.
|
void SetColor(int idx, color c)
|
Sets the color at the specified index in the Color Ramp dialog. If idx is out of range, nothing happens.
|
color GetColor(int idx)
|
Returns the color with the specified index in the Color Ramp dialog. If the index is out of range, black is returned.
|
int GetColorCount()
|
Returns the number of colors used in the Color Ramp.
|
int SetColorPosition(int idx, float position)
|
Sets the color of the given index to a new position and returns the new index. Valid values for position range from 0.01 to 0.99. The first and last color are not allowed to be moved!
|
float GetColorPosition(int idx)
|
Returns the position of a color at the specified index.
|
void SetColorFade(int idx, int fade)
|
Disables or enables color fade for the color at the specified position by either using 0 (Off) or 1 (On) for fade.
|
int GetColorFade(int idx)
|
Returns if color fade is set for the color at the specified index.
|
void FadeAllColors()
|
Enables color fade for all colors in the Color Ramp.
|
void FadeNoneColors()
|
Disables color fade for all colors in the Color Ramp.
|
void SetUniformDistances()
|
Sets uniform distances between each color in the Color Ramp.
|
void InvertColorPositions()
|
Inverts the positions of the colors in the Color Ramp.
|
void InvertColors()
|
Inverts every single color in the Color Ramp.
|
void AddColor(color c, float position, int idx)
|
Adds another color to the Color Ramp at the specified index position. Valid values for position range from 0.01 to 0.99. If the index is lower or equal to 0, the new color is added to the first position. If the index is greater than the current number of colors, the new color is added at the end.
|
void RemoveColor(int idx)
|
Removes the color at the specified index. If the given index is out of range, nothing happens.
|