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 SetColorMix(int value)

Use value 1 (TRUE) to activate the Color Mix. When Color Mix is activated, stripes with distinct colors depending on the »Color Table Mode are generated. Use value 0 (FALSE) to use the default setting.

int GetColorMix()

Returns 1 (TRUE) if the Color Mix is enabled, otherwise 0 (FALSE).

void ToggleColorMix()

Enables or disables the Color Mix depending on the current state.

void SetFillTime(float value)

Sets the Fill Time value which defines how long is takes to fill the whole matrix.

float GetFillTime()

Returns the current Fill Time.

void SetDuration(float value)

Sets the Duration value which defines how long the completely filled matrix is displayed.

float GetDuration()

Returns the current Duration.

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.