List Of Global Variables And Constants

Variable / Define

Description

Math

float PI

Represents the number PI with a value of 3.141592.

S2L - Sound2Light

int SOUND_DATA_LEFT[]

Contains the sound values of the left audio channel.

int SOUND_DATA_RIGHT[]

Contains the sound values of the right audio channel.

int MAX_FREQUENCY_VOLUME

Describes the maximum value of an entry in either SOUND_DATA_LEFT or SOUND_DATA_RIGHT.

Drawing

color WHITE

White color without alpha. {255,255,255,0,0}

color BLACK

Black color without alpha. {0,0,0,0,0}

color RED

Red color without alpha. {255,0,0,0,0}

color MAROON

Maroon color without alpha. {128,0,0,0,0}

color GREEN

Green color without alpha. {0,255,0,0,0}

color MADRIX_GREEN

MADRIX green without alpha. {177,219,24,0,0}

color BLUE

Blue color without alpha. {0,0,255,0,0}

color NAVY

Navy color without alpha. {0,0,128,0,0}

color AQUA

Aqua color without alpha. {0,255,255,0,0}

color CYAN

Cyan color without alpha. {0,255,255,0,0}

color TURQUOISE

Turquoise color without alpha. {0,255,255,0,0}

color TEAL

Teal color without alpha. {0,128,128,0,0}

color FUCHSIA

Fuchsia color without alpha. {255,0,255,0,0}

color PINK

Pink color without alpha. {255,0,255,0,0}

color MAGENTA

Magenta color without alpha. {255,0,255,0,0}

color PURPLE

Purple color without alpha. {128,0,128,0,0}

color YELLOW

Yellow color without alpha. {255,255,0,0,0}

color OLIVE

Olive color without alpha. {128,128,0,0,0}

color LIGHT_GRAY

Light gray color without alpha. {192,192,192,0,0}

color SILVER

Silver color without alpha. {192,192,192,0,0}

color GRAY

Gray color without alpha. {128,128,128,0,0}

color DARK_GRAY

Dark gray color without alpha. {64,64,64,0,0}

color ORANGE

Orange color without alpha. {255,128,0,0,0}

color BROWN

Brown color without alpha. {139,69,19,0,0}

color SKY

Sky color without alpha. {0,191,255,0,0}

color GOLD

Gold color without alpha. {238,201,0,0,0}

color WHITE_ALPHA

White color with alpha. {255,255,255,255,255}

color BLACK_ALPHA

Black color with alpha. {0,0,0,0,255}

color COLOR

COLOR may be used as last parameter for drawing functions. The functions then draws the color channels red, green, blue, and white.

color ALPHA

ALPHA may be used as last parameter for drawing functions. The functions then draws only the alpha channel.

color COLOR_AND_ALPHA

COLOR_AND_ALPHA may be used as last parameter for drawing functions. The function then draws both the color and the alpha channel.

Mix Modes

int MIXMODE_NORMAL

The normal mix mode.

int MIXMODE_DARKEN

The darken (LTP) mix mode.

int MIXMODE_MULTIPLY

The multiply/mask mix mode.

int MIXMODE_COLORBURN

The colur burn mix mode.

int MIXMODE_LINEARBURN

The linear burn mix mode.

int MIXMODE_LIGHTEN

The lighten (HTP) mix mode.

int MIXMODE_SCREEN

The screen mix mode.

int MIXMODE_COLORDODGE

The color dodge mix mode.

int MIXMODE_LINEARDODGE

The linear dodge mix mode.

int MIXMODE_OVERLAY

The overlay mix mode.

int MIXMODE_SOFTLIGHT

The softlight mix mode.

int MIXMODE_HARDLIGHT

The hard light mix mode.

int MIXMODE_VIVIDLIGHT

The vivid light mix mode.

int MIXMODE_LINEARLIGHT

The linear light mix mode.

int MIXMODE_PINLIGHT

The pin light mix mode.

int MIXMODE_HARDMIX

The hardmix mix mode.

int MIXMODE_DIFFERENCE

The difference mix mode.

int MIXMODE_EXCLUSION

The exclusion mix mode.

int MIXMODE_AND

The and mix mode.

int MIXMODE_OR

The or mix mode.

int MIXMODE_XOR

The xor mix mode.

int MIXMODE_NAND

The not and mix mode.

int MIXMODE_NOR

The not or mix mode.

int MIXMODE_MASK

The RGBW alpha mask mix mode.

Filters / Storage Place and Layer Effects (FX)

General Filters

int FILTER_NONE

Deactivates the filter.

Blur/Sharpen Filters

int FILTER_BLUR

This filter blurs the output.

int FILTER_BLUR_BSPLINE

This filter blurs the output applying a B-spline.

int FILTER_BLUR_CATMULL_ROM

This filter blurs the output applying a Catmull-Rom spline.

int FILTER_BLUR_GAUSS

This filter blurs the output applying the Gaussian function.

int FILTER_BLUR_MITCHELL

This filter blurs the output applying the Mitchell-Netravali function.

int FILTER_SHARPE

This filter sharpens the output.

Color Correction Filters

int FILTER_BRIGHTEN

The brighten filter to light up the whole matrix.

int FILTER_DARKEN

The darken filter to darken the whole matrix.

int FILTER_GREYSCALE

The greyscale filter to render the matrix greyscale, i.e. in grey colors.

int FILTER_INVERT_COLOR

The invert color filter to invert every color channel.

Color Mask Filters

int FILTER_RED

The red filter to filter out every color except the red color channel.

int FILTER_GREEN

The green filter to filter out every color except the green color channel.

int FILTER_BLUE

The blue filter to filter out every color except the blue color channel.

int FILTER_WHITE

The white filter to filter out every color except the white color channel.

int FILTER_RED_GREEN

The red/green filter to filter out every color except the red and the green color channel.

int FILTER_RED_BLUE

The red/blue filter to filter out every color except the red and the blue color channel.

int FILTER_GREEN_BLUE

The green/blue filter to filter out every color except the green and the blue color channel.

int FILTER_RED_WHITE

The red/white filter to filter out every color except the red and the white color channel.

int FILTER_GREEN_WHITE

The green/white filter to filter out every color except the green and the white color channel.

int FILTER_BLUE_WHITE

The blue/white filter to filter out every color except the blue and the white color channel.

int FILTER_RED_GREEN_BLUE

The red/green/blue filter to filter out every color except the red, the green, and the blue color channel.

int FILTER_RED_GREEN_WHITE

The red/green/white filter to filter out every color except the red, the green, and the white color channel.

int FILTER_RED_BLUE_WHITE

The red/blue/white filter to filter out every color except the red, the blue, and the white color channel.

int FILTER_GREEN_BLUE_WHITE

The green/blue/white filter to filter out every color except the green, the blue, and the white color channel.

Style Filters

int FILTER_EDGES

The edges filter to make the edges of objects/motifs stand out.

int FILTER_EDGES_POPUP

The edges popup filter to make the edges of objects/motifs stand out.

int FILTER_EMBOSS

The emboss filter to create an image with just highlights and shadows.

int FILTER_EMBOSS_POPUP

The emboss popup filter to create an image with just highlights and shadows depending on the motif.

Transformation Filters

int FILTER_INVERT_H_MATRIX

The filter flips the matrix horizontally.

int FILTER_INVERT_V_MATRIX

The filter flips the matrix vertically.

int FILTER_INVERT_HV_MATRIX

The filter flips the matrix horizontally and vertically. Therefore it instantly rotates the matrix by 180°.

Shifting the Matrix

int SHIFT_UP

Shifts the content of the defined area upwards.

int SHIFT_DOWN

Shifts the content of the defined area downwards.

int SHIFT_LEFT

Shifts the content of the defined area to the left.

int SHIFT_RIGHT

Shifts the content of the defined area to the right.

int SHIFT_UL

Shifts the content of the defined area to the upper left.

int SHIFT_UR

Shifts the content of the defined area to the upper right.

int SHIFT_DL

Shifts the content of the defined area to the bottom left.

int SHIFT_DR

Shifts the content of the defined area to the bottom right.

int SHIFT_H_IN_OUT

Shifts the content of the defined area from the middle of the the area outwards in a horizontal direction.

int SHIFT_H_OUT_IN

Shifts the content of the defined area from the outside of the the area to the middle in a horizontal direction.

int SHIFT_V_IN_OUT

Shifts the content of the defined area from the middle of the the area outwards in a vertical direction.

int SHIFT_V_OUT_IN

Shifts the content of the defined area from the outside of the the area to the middle in a vertical direction.

int SHIFT_C_IN_OUT

Shifts the content of the defined area from the middle of the the area outwards in a vertical and a horizontal direction.

int SHIFT_C_OUT_IN

Shifts the content of the defined area from the outside of the the area to the middle in vertical and horizontal direction.

Map Modes

int MAP_MIRROR_NONE

Disables the mirror map mode.

int MAP_MIRROR_H

Mirrors the content of the matrix horizontally.

int MAP_MIRROR_V

Mirrors the content of the matrix vertically.

int MAP_MIRROR_HV

Mirrors the content of the matrix both vertically and horizontally.

int MAP_TILE_NONE

Disables mapping tile modes.

int MAP_TILE_REPEAT

Repeats tiles on the mapped matrix.

int MAP_TILE_MIRROR_H

Mirrors tiles horizontally.

int MAP_TILE_MIRROR_V

Mirrors tiles vertically.

int MAP_TILE_MIRROR_HV

Mirrors tiles both vertically and horizontally.

Directions

int DIR_UP

Sets an upward direction.

int DIR_DOWN

Sets a downward direction.

int DIR_LEFT

Sets the direction to 'left'.

int DIR_RIGHT

Sets the direction to 'right'.

int DIR_UL

Sets the direction to the upper left corner.

int DIR_UR

Sets the direction to the upper right corner.

int DIR_DL

Sets the direction to the lower left corner.

int DIR_DR

Sets the direction to the lower right corner.

int DIR_NONE

Sets no direction. Usually this is the same as stopping the movement of an effect, if this is possible with the effect.

Others

string WHITE_SPACES

A string which contains white spaces, like tab, new line, or space. This can be used as delimiter string for Tokenizing.

Deprecated Functions
Deprecated functions are outdated functions and should not be used anymore.