|
Functions Provided By M2L Color Rings
The following table provides an overview over all functions the effect provides:
Function
|
Description
|
void SetColor(color col)
|
Sets the color of the effect. Please note that the alpha channel is not used by this effect.
|
color GetColor()
|
Returns the currently set color. Please note that the alpha channel is not used and should be ignored.
|
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 SetDirection(int dir)
|
Sets the direction of the effect. See below for further details.
|
int GetDirection()
|
Returns the current direction. See below for further details.
|
This Effect uses the Color Picker. Learn more about Using Colors.
Deprecated Functions
Deprecated functions are outdated functions and should not be used anymore.
Function
|
Description
|
void SetSpeed(int speed)
|
Sets the speed of the effect in FPS. Valid values range from 0 to 166. Please note: This function is deprecated and may be removed in one of the next releases. Use SetSpeed instead.
|
float GetSpeed()
|
Returns the current effect speed in FPS. Please note: This function is deprecated and may be removed in one of the next releases. Use GetSpeed instead.
|
Setting the Direction
This effect draws rings depending on the music. Those rings are drawn around the matrix and get smaller with each call (inwards) or they are drawn in the center of the matrix and grow with each frame (outwards). Using the function SetDirection it is possible to set this direction.
Value
|
Description
|
DIR_INWARDS
|
Selects an inward direction. Large rings will be drawn around the matrix and shrink with each frame.
|
DIR_OUTWARDS
|
Selects an outward direction. Small rings will be drawn in the center of the matrix and grow with each frame.
|
|