S2L Level Color Scroll

Function

Description

void SetStepWidth(float value)

Sets the Step value, which is the number of pixels the effect should scroll per frame using percentage values.

float GetStepWidth()

Returns the Step in percentage.

void SetPixelStepWidth(int value)

Sets the Step value, which is the number of pixels the effect should scroll per frame using pixel values.

int GetPixelStepWidth()

Returns the Step in pixels.

void SetColorWidth(float value)

Sets the Color Width value, which means the width of the single stripes using percentage values.

float GetColorWidth()

Returns the Color Width, the width of a stripe, in percentage.

void SetPixelColorWidth(int value)

Sets the Color Width value, which means the width of the single stripes using pixel values.

int GetPixelColorWidth()

Returns the Color Width, the width of a stripe, in pixels.

void SetCrossWidth(float value)

Sets the Cross Width value using percentage values.

float GetCrossWidth()

Returns the Cross Width in percentage.

void SetPixelCrossWidth(int value)

Sets the Cross Width value using pixel values.

int GetPixelCrossWidth()

Returns the Cross Width in pixels.

void SetCrossAxes(int value)

Sets the Cross Axis value. See below for a list of constants.

int GetCrossAxes()

Returns the Cross Axis. See below for a list of constants.

void SetAmplification(int value)

Sets the Amplification value.

int GetAmplification()

Returns the Amplification value.

void SetLogarithmic(int value)

Sets the Logarithmic option. Use 1 (TRUE) to activate it. Use 0 (FALSE) to deactivate it.

int GetLogarithmic()

Returns 1 (TRUE) if the Logarithmic option is activated, otherwise 0 (FALSE).

void ToggleLogarithmic()

Toggles the Logarithmic option.

void SetDisplacement(float value)

Sets the Displacement value. Valid values range from 0.0 to 100.0.

float GetDisplacement()

Returns the current Displacement.

void SetDisplacementSpeed(float value)

Sets the Displacement Speed value. Valid values range from 0.0 to 100.0.

float GetDisplacementSpeed()

Returns the current Displacement Speed.

Constant

Description

int AXIS_ONE

Sets the direction cross mode to Axis 1.

int AXIS_TWO

Sets the direction cross mode to Axis 2.

int AXES_ONE_AND_TWO

Sets the direction cross mode to Axes 1 And 2.