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 SetDisplacement(float value)

Sets the Displacement value. Valid values range from 0.00 to 100.00.

float GetDisplacement()

Returns the currently set Displacement.

void SetDisplacementSpeed(float value)

Sets the Displacement Speed value. Valid values range from 0.00 to 100.00.

float GetDisplacementSpeed()

Returns the currently set Displacement Speed.

void SetDisplacementDistribution(int mode)

Sets the Displacement Distribution. See »here for a list of constants (not all apply).

int GetDisplacementDistribution()

Returns the currently set Displacement Distribution. See »here for a list of constants (not all apply).

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.

Function/Constant

Description

void SetVectorStepWidth(float value)

Use SetStepWidth(float value) with percentage values instead.

float GetVectorStepWidth()

Use GetStepWidth() instead. But GetStepWidth() returns a floating point percentage value instead of a floating point normalized value like GetVectorStepWidth().

void SetVectorOffset(float value)

Use SetColorWidth(float value) with percentage values instead.

float GetVectorOffset()

Use GetColorWidth() instead. But GetColorWidth() returns a floating point percentage value instead of a floating point normalized value like GetVectorOffset().

void SetPixelOffset(int value)

Use SetPixelColorWidth(int value) instead.

int GetPixelOffset()

Use GetPixelColorWidth() instead.

void SetVectorXOffset(float offset)

Use SetCrossWidth(float value) with percentage values instead.

float GetVectorXOffset()

Use GetCrossWidth() instead. But GetCrossWidth() returns a floating point percentage value instead of a floating point normalized value like GetVectorXOffset().

void SetPixelXOffset(int offset)

Use SetPixelCrossWidth(int value) instead.

int GetPixelXOffset()

Use GetPixelCrossWidth() instead.

void SetCrossed(int enable)

Use SetDirectionCrossMode(int value) instead.

int GetCrossed()

Use GetDirectionCrossMode() instead.