Function
|
Description
|
void SetDirection(int dir)
|
Set the direction of the effect. Valid values are DIR_UP, DIR_DOWN, DIR_LEFT and DIR_RIGHT.
|
int GetDirection()
|
Returns the current direction.
|
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 SetStep(int step)
|
Sets the step value, which stretches the drops. For example, a step value of 2 will render drops every second pixel. Valid values for step range from 1 to 100.
|
int GetStep()
|
Returns the currently set step value.
|
void SetLength(int length)
|
Sets the length of the objects. Valid values range from 1 to 100.
|
int GetLength()
|
Returns the current object length.
|
void SetCount(int count)
|
Sets the number of shapes which shall be created. Valid values range from 0 to 100.
|
int GetCount()
|
Returns the number of shapes currently used.
|
void SetWidth(int width)
|
Sets the size of the objects in pixels. Valid values range from 1 to 100.
|
int GetWidth()
|
Returns the size of the objects in pixels.
|
void SetPitch(int pitch)
|
Sets the pitch between two shapes in pixels. Valid values range from 1 to 100.
|
int GetPitch()
|
Returns the currently set pitch in pixels.
|
void SetColorMode(int mode)
|
Sets the effect color mode. See the color mode table below for further details.
|
int GetColorMode()
|
Returns the current color mode. See below for further details.
|
void SetShape(int mode)
|
Sets the shape the effect should use. See below for further details.
|
int GetShape()
|
Returns the currently used shape. See below for further details.
|
void SetColor(int idx, color c)
|
Sets the color with the specified index to the given color value. If the index is out of range, nothing happens.
|
color GetColor(int idx)
|
Returns the color with the specified index in the color table. If the index is out of range, black is returned.
|
int GetColorCount()
|
Returns the current number of colors in the color table.
|
void AddColor(int idx, color c)
|
Adds another color to the color table at the specified index position. 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 located at the specified index. If the given index is out of range, nothing happens. The Color Table of this effect needs to include at least 1 entry.
|