Function

Description

void SetChangeTime(float time)

Sets the fade time for the effect in seconds.

float GetChangeTime()

Retrieves the fade time of the effect in seconds.

void SetBpm(int bpm)

Sets the speed of the color change in BPM. bpm is in the range of 0 to 9999.

int GetBpm()

Gets the speed of the effect in BPM.

void SetFade(int enable)

Disables fade if enable is false, otherwise it will be enabled. Please note that this does not affect the effect's frame fade.

int GetFade()

Returns true if fade is enabled, otherwise false.

void SetColor(int idx, color c)

Sets the color at the specified index in the Color Table dialog. If idx is out of range, nothing happens.

color GetColor(int idx)

Returns the color of the specified index in the color table. If the index is out of range, black is returned.

int GetColorCount()

Returns the 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 2 entries.