M2L Color Scroll

Functions Provided By M2L Color Scroll

This effect uses the following functions:

▪	This Effect uses Directions. Learn more »Using Directions

▪	This Effect uses the Color Controls. Learn more »Using Color Controls

▪	This Effect uses the M2L Color Table. Learn more »Using M2L Color Table

▪	This Effect uses the BPM Control. Learn more »Using BPM Control

▪	This Effect uses Look-At Types. Learn more »Using Look-At Types

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 SetSensitivity(int value)	Sets the Sensitivity value.
int GetSensitivity()	Returns the current Sensitivity.
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.

Cross Axis Constants

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.

MADRIX 2.X To MADRIX 3.X Migration Hints

The following functions and constants are not supported anymore. Please follow the hints to migrate your macros.

Function/Constant	Description
void SetStep(int step)	Use SetStepWidth(float value) instead.
int GetStep()	Use GetStepWidth() instead.
void SetXOffset(int offset)	Use SetCrossWidth(float value) with percentage values instead.
int GetXOffset()	Use GetCrossWidht() instead.