Function

Description

void SetColorSelect(int mode)

Sets the color mode. See below for a list of constants.

int GetColorSelect()

Returns the current color mode.

void SetAutoStart(int value)

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

int GetAutoStart()

Returns 1 (TRUE) if Autostart is activated, otherwise 0 (FALSE).

void ToggleAutoStart()

Toggles Autostart.

void Start()

Forces a start.

void SetEndMode(int mode)

Sets the mode for the last shown text. See below for a list of constants.

int GetEndMode()

Returns the current mode for the last shown text.

void SetTextAlignmentHorizontal(int alignment)

Sets the horizontal text alignment of elements. See below for a list of constants.

int GetTextAlignmentHorizontal()

Returns the current horizontal text alignment of elements.

void SetTextAlignmentVertical(int alignment)

Sets the vertical text alignment of elements. See below for a list of constants.

int GetTextAlignmentVertical()

Returns the current vertical text alignment of elements.

void SetShuffle(float value)

Sets the Shuffle parameter.

float GetShuffle()

Returns the currently set Shuffle value.

void SetShuffleCount(int value)

Sets the Shuffle Count.

int GetShuffleCount()

Returns the currently set Count value.

void SetLineBreak(float value)

Sets the Line Break parameter.

float GetLineBreak()

Returns the currently set Line Break value.

void SetPageBreak(float value)

Sets the Page Break parameter.

float GetPageBreak()

Returns the currently set Page Break value.

void SetPageFade(float value)

Sets the Page Fade parameter.

float GetPageFade()

Returns the currently set Page Fade value.

void SetRotation(int angle)

Sets the Rotation globally for all elements of the String Table. It is possible to rotate the elements by multiples of 90°. This function is equal to the rotation button provided by the GUI of the effect. Valid values for angle are 0, 90, 180, and 270.

int GetRotation()

Returns the current Rotation value.

void SetFilteringMode(int mode)

Sets the Filtering mode. See below for a list of constants.

mode GetFilteringMode()

Returns the Filtering mode.

Constant

Description

int COLORSELECT_PAGE

Sets the color mode to Page.

int COLORSELECT_LINE

Sets the color mode to Line.

Constant

Description

int ENDMODE_STAY

Sets the Last Element Mode to Stay.

int ENDMODE_CLEAR

Sets the Last Element Mode to Clear.

Constant

Description

int TEXT_ALIGNMENT_HORIZONTAL_LEFT

Sets the Horizontal Text Alignment to Left.

int TEXT_ALIGNMENT_HORIZONTAL_CENTER

Sets the Horizontal Text Alignment to Center.

int TEXT_ALIGNMENT_HORIZONTAL_RIGHT

Sets the Horizontal Text Alignment to Right.

Constant

Description

int TEXT_ALIGNMENT_VERTICAL_TOP

Sets the Vertical Text Alignment to Top.

int TEXT_ALIGNMENT_VERTICAL_CENTER

Sets the Vertical Text Alignment to Center.

int TEXT_ALIGNMENT_VERTICAL_BOTTOM

Sets the Vertical Text Alignment to Bottom.

Value

Description

int FILTERING_MODE_NEAREST_NEIGHBOR

Sets the Filtering Mode to None (no filtering).

int FILTERING_MODE_LINEAR

Sets the Filtering Mode to Linear (may require additional performance).