S2L Level Ring

   Print  Previous  Next

Functions Provided By S2L Level Ring

The following table provides an overview over all functions the effect provides:

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 SetAmplify(int amp)

Sets the "Amplify" value. Valid values range from 0 to 100.

int GetAmplify()

Returns the current "Amplify" value.

void SetMono(int enable)

Disables "mono" if enable is set to false. Otherwise, use true.

int GetMono()

Returns true if "mono" is enabled, otherwise false.

void SetViewLog(int enable)

Disables "ViewLog" if enable is set to false. Otherwise, use true.

int GetViewLog()

Returns true if "ViewLog" is enabled, otherwise false.

void SetDirection(int dir)

Sets the direction of the effect. See below for details.

int GetDirection()

Returns the current effect direction. See below for details.

void SetShape(int shape)

Sets the shape of the objects. See below for details.

int GetShape()

Returns the currently used shape of the objects. See below for details.

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. The Color Table of this Effect always requires 3 entries.

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 number of colors in the color table. The Color Table of this Effect always requires 3 entries.

 

This Effect uses the Color Table. 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 SetBpm 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 GetBpm instead.

void SetDrawMode(int mode)

Sets the current draw mode the effect should use. Please note: This function is deprecated and may be removed in one of the next releases. Use SetShape instead.

int GetDrawMode()

Returns the current draw mode. Please note: This function is deprecated and may be removed in one of the next releases. Use GetShape instead.

 

Setting The Direction

The directions for this effect are only "inward" or "outward". Therefore, SetDirection only gets the following values as valid parameters:

Value

Description

DIR_OUTWARDS

Sets the direction from the center to the outside.

DIR_INWARDS

Sets the direction from the outside to the center.

 

Shapes

This effect uses different geometrical figures. With the function SetShape it is possible to change them. The following values can be used as parameter:

Value

Description

DRAW_CROSS

Selects the cross for drawing.

DRAW_CIRCLE

Selects the unfilled circle for drawing.

DRAW_RECT

Selects the unfilled rectangle for drawing.

DRAW_STAR

Selects the star for drawing.

FILL_CIRCLE

Selects the filled circle for drawing.

FILL_RECT

Selects the filled rectangle for drawing.