Function

Description

void SetExtrusion(float value)

Sets the Extrusion value in percent of the matrix size (depending on the current look-at type).

float GetExtrusion()

Returns the current Extrusion value in percent of the matrix size (depending on the current look-at type).

void SetPixelExtrusion(int value)

Sets the Extrusion value in pixels.

int GetPixelExtrusion()

Returns the current Extrusion value in pixels.

void SetRotation(int angle)

Sets the Rotation globally for all images of the Image List. It is possible to rotate the images 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 currently set Rotation.

void SetTiling(int enable)

Disables Tile Mode if enable is set to FALSE, otherwise the Tile Mode will be enabled via TRUE.

int GetTiling()

Returns TRUE if Tile Mode is enabled, otherwise FALSE.

void ToggleTiling()

Enables Tile Mode or uses the default setting, depending on the current state.

void SetSeamless(int enable)

Disables Seamless if enable is FALSE, otherwise it will be enabled.

int GetSeamless()

Returns TRUE if Seamless is enabled, otherwise FALSE.

void ToggleSeamless()

Enables Seamless or uses the default setting, depending on the current state.

float GetImageWidth()

Returns the image width of the current image in percent of the matrix width.

float GetImageHeight()

Returns the image height of the current image in percent of the matrix height.

float GetImageDepth()

Returns the image depth of the current image in percent of the matrix depth.

int GetImagePixelWidth()

Returns the image width of the current image in pixels.

int GetImagePixelHeight()

Returns the image height of the current image in pixels.

int GetImagePixelDepth()

Returns the image depth of the current imagein pixel.

float GetCurrentPositionX()

Returns the X-position of the current image in percent of the matrix width.

float GetCurrentPositionY()

Returns the Y-position of the current image in percent of the matrix height.

float GetCurrentPositionZ()

Returns the Z-position of the current image in percent of the matrix depth.

int GetCurrentPixelPositionX()

Returns the X-position of the current image in pixels.

int GetCurrentPixelPositionY()

Returns the Y-position of the current image in pixels.

int GetCurrentPixelPositionZ()

Returns the Z-position of the current image in pixels.

void SetStretchMode(int mode)

Sets the Stretch mode. See below for details.

int GetStretchMode()

Returns the Stretch mode. See below for details.

void SetGrayscale(int enable)

Disables Grayscale if enable is set to FALSE. Otherwise it can be enabled using TRUE.

int GetGrayscale()

Returns TRUE if Stretch mode is enabled, otherwise FALSE.

void ToggleGrayscale()

Enables Stretch mode or uses the default setting, depending on the current state.

void SetGreyscale(int enable)

Is the same as SetGrayscale(int enable).

int GetGreyscale()

Is the same as GetGreyscale().

void ToggleGreyscale()

Is the same as ToggleGreyscale().

void SetRgbw(int enable)

Disables the RGB-To-RGBW mode if enable is FALSE, otherwise it can be enabled using TRUE.

int GetRgbw()

Returns TRUE if RGB-To-RGBW mode is enabled, otherwise FALSE.

void ToggleRgbw()

Enables RGB-To-RGBW mode or uses the default setting, depending on the current state.

void SetFilteringMode(int mode)

Sets the Filtering mode. See below for details.

int GetFilteringMode()

Returns the Filtering mode. See below for details.

void SetCaptureCoordinateTop(int coordinate)

Sets the Top coordinate of the capture area.

int GetCaptureCoordinateTop()

Returns the currently set Top coordinate of the capture area.

void SetCaptureCoordinateLeft (int coordinate)

Sets the Left coordinate of the capture area.

int GetCaptureCoordinateLeft()

Returns the currently set Left coordinate of the capture area.

void SetCaptureAreaWidth(int width)

Sets the Width of the capture area.

int GetCaptureAreaWidth()

Returns the currently set Width of the capture area.

void SetCaptureAreaHeight(int height)

Sets the Height of the capture area.

int GetCaptureAreaHeight()

Returns the currently set Height of the capture area.

void SetCaptureArea(int left, int top, int width, int height)

Sets the whole capture area with its left and top coordinates as well as the required width and height.

void SetCaptureFrameRate(float value)

Sets the Capture Frame Rate to use for screen capturing. The default value is 50.0.

float GetCaptureFrameRate()

Returns the currently set Capture Frame Rate.

void SetAeroOff()

Activates Aero Off.

int GetAeroOff()

Returns if Aero Off  is enabled (1) or disabled (0).

Value

Description

int STRETCH_MODE_NONE

Sets the stretch mode to None (no stretching).

int STRETCH_MODE_MATRIX

Sets the stretch mode to Matrix (stretches to the current aspect ratio of the matrix).

int STRETCH_MODE_ORIGINAL

Sets the stretch mode to Original (stretches to the original aspect ratio of the source).

int STRETCH_MODE_4_TO_3

Sets the stretch mode to 4:3.

int STRETCH_MODE_16_TO_9

Sets the stretch mode to 16:9.

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).

Function/Constant

Description

void SetNoAero(int enable)

Use void SetAeroOff() instead.

int GetNoAero()

Use int GetAeroOff() instead.

void ToggleNoAero()

Has been removed.