﻿ List Of Functions (Alphabetical Order)
 List Of Functions (Alphabetical Order) Print  Previous  Next

Overview

In addition to the specific functions of the MAS Script Effect, Macros for effects, the Main Ouput Macro, and the Storage Place Macro (all listed below), the following table lists additional functions. The "+" symbol indicates, in which areas of MADRIX Script the functions can be used.

Function

Description

MAS Script

Macros for Effects

Storage Place Macro

Main Output Macro

float abs(float x)

Returns the absolute value of x.

+

+

+

+

void AddPixelTransposeEntry(int srcX, int srcY, int destX, int destY)

Adds one entry to the pixel transpose table and resizes the table if necessary. srcX and srcY are the coordinates in X and Y of the source. destX and destY are the destination coordinates. »Description

+

+

+

+

void AddPixelTransposeEntry3D(int srcX, int srcY, int srcZ, int destX, int destY, int destZ)

Adds one entry to the pixel transpose table and resizes the table if necessary. srcX, srcY, and srcZ are the coordinates in X, Y, and Z of the source. destX, destY, and destZ are the coordinates of the destination. »Description

+

+

+

+

float arccos(float a)

float arccosDeg(float a)

Returns the arc cosine of the angle a in radian measure or degrees, respectively.

+

+

+

+

float arccot(float a)

float arccotDeg(float a)

Returns the arc cotangent of the angle a in radian measure or degrees, respectively.

+

+

+

+

float arcsin(float a)

float arcsinDeg(float a)

Returns the arc sine of the angle a in radian measure or degrees, respectively.

+

+

+

+

float arctan(float a)

float arctanDeg(float a)

Returns the arc tangent of the angle a in radian measure or degrees, respectively

+

+

+

+

float arctan2(float x, float y)

Returns the angle of polar coordinates from two Cartesian coordinates x and y.

+

+

+

+

float ceil(float f)

Rounds up the given value to the next integer value. E.g. ceil(2.00001) = 3.0

+

+

+

+

void ChangeBrightness(color col)

Adds the values of the specified color to the current color of each pixel in the matrix. »Example

+

+

+

+

int CheckScriptEngineVersion(int major, int minor)

Checks the Script engine version in use and returns 1 if the version is equal or higher to the version specified with major and minor. Or else 0 is returned. The current Script Engine Version is 2.22. A useful function to check if the minimum requirements of your script are met. »Example

+

+

+

+

int CheckSoftwareVersion(int major, int minor, int subminor, int subsubminor)

Checks the MADRIX software version in use and returns 1 if the version is equal or higher to the version specified with major, minor, subminor, and subsubminor. Or else 0 is returned. The current MADRIX version is 3.6.10.0. You can check which version you are using by opening the Logfile in MADRIX (at the beginning of the file) or check the MADRIX.exe (perform a right-click > Properties > Version). A useful function to check if the minimum requirements of your script are met. »Example

+

+

+

+

void Clear()

void Clear(color col)

Fills the whole matrix with the given color. The default color (no color parameter) is black.

+

+

+

+

void ClearAlpha(int alpha)

Sets the alpha value of each pixel in the matrix to alpha.

+

+

+

+

void ClearColor(color col)

Fills the whole matrix with the given color without changing the alpha value.

+

+

+

+

void ColorReplace(color oldCol, color newCol)

Replaces the given color oldCol with a new one (newCol).

+

+

+

+

float cotan(float a)

float cotanDeg(float a)

Returns the cotangent of the angle a in radian measure or degrees, respectively.

+

+

+

+

float cos(float a)

float cosDeg(float a)

Returns the cosine of the angle a in radian measure or degrees, respectively.

+

+

+

+

float cosH(float a)

float cosHDeg(float a)

Returns the hyperbolic cosine of the angle a in radian measure or degrees, respectively.

+

+

+

+

void CreatePixelTransposeTable(int size, int growsize)

Creates the pixel transpose table with the given size and growsize. »Description

+

+

+

+

Converts the angle a from degrees to radian measure.

+

+

+

+

void Dim(float value)

Reduces the brightness of the complete virtual matrix. Valid values for value range from 0.0 to 1.0.

+

+

+

+

void DimPixel(float value, int x, int y)

Reduces the brightness of an individual pixel. x and y are the coordinates of the pixel. Valid values for value range from 0.0 to 1.0.

+

+

+

+

void DimPixel3D(float value, int x, int y, int z)

Reduces the brightness of an individual voxel. x, y, and z are the coordinates of the voxel. Valid values for value range from 0.0 to 1.0.

+

+

+

+

void DimPixelArea(float value, int x, int y, int width, int height)

Reduces the brightness of a certain area of the virtual matrix. x and y are the coordinates of the area (upper left corner). width and height specify the width and height of the area. Valid values for value range from 0.0 to 1.0.

+

+

+

+

void DimPixelArea3D(float value, int x, int y, int z, int width, int height, int depth)

Reduces the brightness of a certain area of the virtual 3D matrix. x, y, and z are the coordinates of the area (front upper left corner). width, height, and depth specify the width, height, and depth of the area. Valid values for value range from 0.0 to 1.0.

+

+

+

+

void DrawPixelArea(color matrix[][], int xDst, int yDst, int w, int h,

int xSrc, int ySrc, color filter)

Copies data from a 2-dimensional array of colors and renders it on the matrix. »Description

+

+

+

+

void DrawPixelArea3D(color matrix[][][], int xDst, int yDst, int zDst, int w, int h, int d,

int xSrc, int ySrc, int zSrc, color filter)

Copies data from a 3-dimensional array of colors and renders it on the matrix.

+

+

+

+

void DrawPixelLine(color col, int x1, int y1, int x2, int y2)

Draws a line from pixel (x1, y1) to pixel (x2, y2) with the specified color col.

+

+

+

+

void DrawPixelLine3D(color col, int x1, int y1, int z1, int x2, int y2, int z2)

Draws a line from voxel (x1, y1, z1) to voxel (x2, y2, z2) with the specified color col.

+

+

+

+

void DrawPixelShape(color col, int shape, int x, int y, int z, int w, int h, int d, int lineWidth, int drawMode, int lookAtType)

Draws a given shape onto the matrix with the given size (width w, height h, depth d) at the given position (x, y, z) with the specified color col. Learn more »Draw Shapes

+

+

+

+

void DrawPixelText(color c, font f, string t, int x, int y, int rotation)

Draws a text across the main output. »color c and »font f are structures. Valid values for rotation are ROTATION_CCW_0, ROTATION_CCW_90, ROTATION_CCW_180, ROTATION_CCW_270 for counter-clockwise rotation and ROTATION_CW_0, ROTATION_CW_90, ROTATION_CW_180, ROTATION_CW_270 for clockwise rotation. »Example 1 »Example 2 »Example 3 »Example 4

+

+

+

+

void DrawVectorLine(color col, float x1, float y1, float x2, float y2)

Draws a line from the relative position (x1, y1) to the relative position (x2, y2) with the specified color.

+

+

+

+

void DrawVectorLine3D(color col, float x1, float y1, float z1, float x2, float y2, float z2)

Draws a line from the relative position (x1, y1, z1) to the relative position (x2, y2, z2) with the specified color col.

+

+

+

+

void DrawVectorShape(color col, int shape, float x, float y, float z, float w, float h, float d, int lineWidth, int drawMode, int lookAtType)

Draws a given shape at the relative position (x, y, z) with the relative size (width w, height h, depth d) and the specified color col. Learn more »Draw Shapes

+

+

+

+

void DrawVectorText(color c, font f, string t, float x, float y, int rotation)

Draws a vector text across the main output. »color c and »font f are structures. Valid values for rotation are ROTATION_CCW_0, ROTATION_CCW_90, ROTATION_CCW_180, ROTATION_CCW_270 for counter-clockwise rotation and ROTATION_CW_0, ROTATION_CW_90, ROTATION_CW_180, ROTATION_CW_270 for clockwise rotation. »Example 1 »Example 2

+

+

+

+

int endswith(string text, string substring)

This function checks if the string text ends with the given substring. If text ends with the specified substring, true is returned, otherwise false. »Description

+

+

+

+

void ExecutePixelTranspose(int clear)

Executes the pixel transposition by using the pixel transpose table. Using the value clear will erase/overwrite all pixels that are not defined as destination with the color black. Otherwise, NOCLEAR will keep all pixels that are not defined as original destination. »Description

+

+

+

+

float exp(float x)

Returns the result of e (2.7182...) to the power of x.

+

+

+

+

void Filter(int filter)

Renders a filter over the matrix. »Valid parameters (Filters) »Description

+

+

+

+

int findstring(int startIndex, string text, string substring)

Searches for the substring within text starting at startIndex. The function returns an index that describes the position at which the substring begins. »Description

Example: substring(0, "Hallo Welt", "Welt") returns 6. If the substring is not found within text, -1 is returned.

+

+

+

+

float fmax(float x, float y)

Returns the maximum value of the floating point numbers x and y.

+

+

+

+

float fmin(float x, float y)

Returns the minimum value of x and y.

+

+

+

+

float fmod(float denominator, float divisor)

Calculates the remainder of the float division.

+

+

+

+

float frandom()

Returns a random number within the the range of 0 to 1.

+

+

+

+

void GetAllIntervals(int buf[])

Fills the array buf with the occurrences of each interval (buf[0] ... buf[10]). buf[index] is true, if the specified interval was analyzed. »Example

+

+

void GetAllNoteValues(int buf[])

Fills the array buf with the sound level values for each note (buf[0] ... buf[127]). buf[index] can differ from 0 to 127.

+

+

string GetApplicationPath()

Locates the MADRIX.exe on your harddisk and returns the path as a string. »Example

+

+

+

+

int GetAsync()

Returns if asynchronous rendering is used. »Description

This function is only available for some effects.

+

+

int GetBlind()

Returns if Blind Mode is used. »Description

+

+

int GetBassTone()

Returns a value, ranging from 0 to 127, representing the lowest tone (0 = C, 1 = C#, 2 = D, ...). The return value is -1, if the lowest tone could not be determined.

+

+

int GetBassType()

Returns a value, ranging from 0 to 11, representing the bass type (0 = base bass, 1,2 = small/large second bass, 3,4 = small/large third bass, ... , 10, 11 = small/large seventh bass). The return value is -1 if the bass type could not be determined.

+

+

int GetBassValue()

Returns a value, ranging from 0 to 127, representing the sound level of the bass tone.

+

+

int GetColorDepth()

Returns the color depth of the fixture.

+

+

+

+

string GetComputerName()

Retrieves the name of the computer in use as defined in the Windows operating system.

+

+

+

+

date GetDate()

Returns a date structure with the current date. »Example

+

+

+

+

int GetDayOfWeek(int day, int month, int year)

Returns the day of the week of a specified date. Returned values include 0 = Sunday, 1 = Monday, ..., 6 = Saturday. -1 is returned if the provided parameters are invalid. Valid values for day range from 1 to 31. Valid values for month range from 1 to 12. Valid values for year start with value 1900.

+

+

+

+

Returns on which DMX channel the specified fader sends data. Valid values for index range from 0 to 11 (Indexing starts with 0). Valid values for value range from 0 to 511 (Counting starts with 0). Note: Make sure to activate the fader in the DMX Fader Tool first!

+

+

+

+

+

+

+

+

Returns on which DMX universe the specified fader sends data. Valid values for index range from 0 to 11 (Indexing starts with 0). Valid values for value range from 0 to 255 (Counting starts with 0). Note: Make sure to activate the fader in the DMX Fader Tool first!

+

+

+

+

Returns the DMX value the specified fader sends. Valid values for index range from 0 to 11 (Indexing starts with 0). Valid values for value range from 0 to 255 (Counting starts with 0). Note: Make sure to activate the fader in the DMX Fader Tool first!

+

+

+

+

void GetDmxIn(int DmxValues[], int startchannel, int channels, int universe)

Stores the DMX-IN status of several DMX channels in an array (DmxValues[]). To use the function, choose a DMX start channel and specify the number of channels that should be scanned. Valid values for startchannel range from 0 to 511. Valid values for channels range from 0 to 511. Please note that a maximum of 512 channels can be scanned. This means that the sum of startchannel + channels must be less or equal to 512. In addition, specify the universe that should be scanned. Valid values for universe range from 0 to 255. The default universe is 0, i.e. DMX Universe 1.

+

+

+

+

int GetDmxInChannel(int channel, int universe)

Returns the status of the DMX-IN functionality of a specified DMX channel (channel). Valid values for channel range from 0 to 511. In addition, specify the universe that should be scanned. Valid values for universe range from 0 to 255. The default value of universe is 0, i.e. DMX Universe 1.

+

+

+

+

int GetFilter()

Returns which Filter (FX) is applied to the matrix.

+

+

+

float GetFrameCount()

Retrieves the number of frames the effect produces before it gets repeated. This is the same value which was set by SetFrameCount for MAS Script. The initial value is 1000.0.

+

+

float GetFrameId()

Returns the ID of the current frame. »Description

+

+

float GetFrameSteps()

Returns the number of frames which are between this and the last call. »Description

+

+

Returns 1 (i.e. true) if the option to link effect Layers is enabled, otherwise 0 (false).

+

+

int GetMatrixDepth()

Returns the pixel count of the matrix regarding the depth.

+

+

+

+

int GetMatrixHeight()

Returns the vertical pixel count of the matrix.

+

+

+

+

int GetMatrixWidth()

Returns the horizontal pixel count of the matrix.

+

+

+

+

void GetMidiInControl(int midivalues[], int startcontrol, int controlcount, int midichannel, int device)

Stores the MIDI values for multiple controls in an array (midivalues[]). To use the function, choose a start control (startcontrol) and the number of controls (controlcount), as well as the MIDI channel (midichannel) and the device. The default value of startnote, midichannel, and device is 0, i.e. the first control, channel, and device. The default and maximum value of controlcount is 128. (Please note: In MADRIX, the index for channels and devices starts with 1, while the index for MIDI notes starts with 0). »Example

+

+

+

+

int GetMidiInControlValue(int midicontrol, int midichannel, int device)

Returns the MIDI control value of the specified MIDI control change (midicontrol) and midichannel for the specified device. The default value of control, midichannel, and device is 0, i.e. the first control, channel, and device. (Please note: In MADRIX, the index for channels and devices starts with 1, while the index for MIDI notes starts with 0). »Example

+

+

+

+

void GetMidiInNote(int midivalues[], int startnote, int notecount, int midichannel, int device)

Stores the MIDI values for multiple notes in an array (midivalues[]). To use the function, choose a start note (startnote) and the number of notes (notecount), as well as the MIDI channel (midichannel) and the device. The default value of startnote, midichannel, and device is 0, i.e. the first control, channel, and device. The default and maximum value of notecount is 128. (Please note: In MADRIX, the index for channels and devices starts with 1, while the index for MIDI notes starts with 0). »Example

+

+

+

+

int GetMidiInNoteValue(int midinote, int midichannel, int device)

Returns the MIDI note value of the specified MIDI note (midinote) and midichannel for the specified device. The default value of note, midichannel, and device is 0, i.e. the first note, channel, and device. (Please note: In MADRIX, the index for channels and devices starts with 1, while the index for MIDI notes starts with 0). »Example

+

+

+

+

int GetMixMode()

Returns the currently set Mix Mode. »Valid parameters (Mix modes) »Description

+

+

int GetNoteValue(int note)

Returns a value, ranging from 0 to 127, representing the sound level of the specified note: 0 = C = 8.25 Hz, ..., 127 = G = 12.67 kHz. »Example

+

+

int GetOpacity()

Returns the currently set Opacity value of the effect. The value ranges from 0 to 255.

+

+

color GetPixel(int x, int y)

Returns the color of the pixel at position (x, y).

+

+

+

+

color GetPixel3D(int x, int y, int z)

Returns the color of the voxel at position (x, y, z ).

+

+

+

+

void GetPixelArea(color matrix[][], int xSrc, int ySrc, int w, int h,

int xDst, int yDst)

Retrieves data from the matrix and stores it into a 2-dimensional array of colors. »Description

+

+

+

+

void GetPixelArea3D(color matrix[][][], int xSrc, int ySrc, int zSrc, int w, int h, int d,

int xDst, int yDst, int zDst)

Retrieves data from the matrix and stores it into a 3-dimensional array of colors.

+

+

+

+

string GetScriptEngineVersion()

Returns the script engine version and returns the value as a string. »Example

+

+

+

+

string GetSoftwareVersion()

Returns the MADRIX software version and returns the value as a string. »Example

+

+

+

+

int GetSolo()

Returns if Solo Mode is used. »Description

+

+

float GetSoundLevel(int channel)

Returns a value, ranging from 0.0 to 1.0, representing the sound level of the stereo channel: 0 = left channel, 1 = right channel. »Example

+

+

int GetStep()

Returns if stepped rendering is used. »Description

This function is only available for some effects.

+

+

int GetSubMaster()

Returns the currently set Submaster value of the effect. The value ranges from 0 to 255.

+

+

time GetTime()

Returns a time structure with the current time.

+

+

+

+

time GetTimeCode()

Returns a time structure with the currently used Time Code. »Example

+

+

+

+

time GetTimeSunrise(struct date, int latitude_degrees, int latitude_minutes, int longitude_degrees, int longitude_minutes, float time_zone_UTC_offset)

Returns the sunrise time of a geographic location at the specified date. Note: Please use cautiously! Due to the performance requirements of this function, it is not recommended to call it often. Please call this function seldomly in your script/macro. »Example

+

+

+

+

time GetTimeSunriseCity(struct date, int city)

Returns the sunrise time of a specified city at the specified date. Valid values for city are »city constants. Note: Please use cautiously! Due to the performance requirements of this function, it is not recommended to call it often. Please call this function seldomly in your script/macro. »Example

+

+

+

+

time GetTimeSunset(struct date, int latitude_degrees, int latitude_minutes, int longitude_degrees, int longitude_minutes, float time_zone_UTC_offset)

Returns the sunset time of a geographic location at the specified date. Note: Please use cautiously! Due to the performance requirements of this function, it is not recommended to call it often. Please call this function seldomly in your script/macro. »Example

+

+

+

+

time GetTimeSunsetCity(struct date, int city)

Returns the sunset time of a specified city at the specified date. Valid values for city are »city constants. Note: Please use cautiously! Due to the performance requirements of this function, it is not recommended to call it often. Please call this function seldomly in your script/macro. »Example

+

+

+

+

int GetTonality()

Returns a value, ranging from 0 to 11, representing the tonality (0 = C, 1 = C#, 2 = D ...). The return value is -1, if the tonality could not be determined. »Example

+

+

int GetToneScale()

Returns a value, ranging from 0 to 2, representing the tone scale (0 = undetermined, 1 = major, 2 = minor). »Example

+

+

Retrieves the name of the current user as defined in the Windows operating system.

+

+

+

+

string GetUserProfileDirectory()

Locates the directory of the current user profile on the harddisk and returns the path as a string. »Example

+

+

+

+

color GetVectorPixel(float x,float y)

Returns the color of the pixel drawn at vector coordinates x and y.

+

+

+

+

color GetVectorPixel3D(float x,float y,float z)

Returns the color of the voxel drawn at vector coordinates x, y, and z.

+

+

+

+

void Grayscale()

Converts the whole matrix to grayscaled values.

+

+

+

+

float hypot(float x, float y)

Calculates the length of the hypotenuse of an orthogonal triangle with x and y as the cathetus' lengths.

+

+

+

+

void InvertColor()

Inverts the color of the entire matrix.

+

+

+

+

void InvertMatrix()

Inverts the whole matrix. The top left pixel will be moved to the bottom right and the bottom left pixel to the top right.

+

+

+

+

int isalnum(string text)

Returns true if the given string text contains only characters and figures and if its length is greater then 0. Otherwise, false is returned. »Description

+

+

+

+

int isalpha(string text)

Returns true if the given string contains only characters and if its length is greater than 0. Otherwise, false is returned. »Description

+

+

+

+

Returns if the specified fader is enabled (1) or not (0).Valid values for index range from 0 to 11 (Indexing starts with 0).

+

+

+

+

int IsDmxInEnabled()

Retrieves if DMX-IN is activated (1) or not (0).

+

+

+

+

int IsInterval(int index)

Returns true if the specified interval (at the index position, ranging from 0 to 10) was analyzed.

+

+

int IsMidiInEnabled()

Retrieves if MIDI-IN is activated (1) or not (0).

+

+

+

+

int IsNote(int note)

Returns true if the specified note was analyzed. (0 = C = 8.25 Hz, ..., 127 = G = 12.67 kHz)

+

+

int isnum(string text)

Returns true if the given text represents a number. This may be an integer value or a floating point number. Otherwise it returns false. »Description

+

+

+

+

int IsTonality()

Returns true if the tonality could be determined.

+

+

float ln(float x)

Returns the result of the natural logarithm of x.

+

+

+

+

float log10(float x)

Returns the result of the common logarithm of x.

+

+

+

+

int MapDlgGetAntiAliasing()

Retrieves the Anti-Aliasing mode of the Layer. See »here for a list of Anti-Aliasing Mode constants.

+

+

int MapDlgGetMapMode()

Retrieves the currently used Map Mirror Mode of the Layer. See »here for a list of constants.

+

+

void MapDlgGetMapPixel(int map[])

Retrieves the map settings for the Layer using pixel values. The values are saved in an array (map[]).

 ▪ map[0] = X-coordinate (Position X)
 ▪ map[1] = Y-coordinate (Position Y)
 ▪ map[2] = width (Size X)
 ▪ map[3] = height (Size Y)

+

+

void MapDlgGetMapPixel3D(int map[])

Retrieves the map settings for the Layer in 3D using pixel values. The values are saved in an array (map[]).

 ▪ map[0] = X-coordinate (Position X)
 ▪ map[1] = Y-coordinate (Position Y)
 ▪ map[2] = Z-coordinate (Position Z)
 ▪ map[3] = width (Size X)
 ▪ map[4] = height (Size Y)
 ▪ map[5] = depth (Size Z)

+

+

void MapDlgGetMapVector(float map[])

Retrieves the map settings for the Layer using relative values. The values are saved in an array (map[]).

 ▪ map[0] = X-coordinate (Position X)
 ▪ map[1] = Y-coordinate (Position Y)
 ▪ map[2] = width (Size X)
 ▪ map[3] = height (Size Y)

+

+

void MapDlgGetMapVector3D(float map[])

Retrieves the map settings for the Layer in 3D using relative values. The values are saved in an array (map[]).

 ▪ map[0] = X-coordinate (Position X)
 ▪ map[1] = Y-coordinate (Position Y)
 ▪ map[2] = Z-coordinate (Position Z)
 ▪ map[3] = width (Size X)
 ▪ map[4] = height (Size Y)
 ▪ map[5] = depth (Size Z)

+

+

void MapDlgGetRotationDegree(int rot[])

Retrieves the Rotation values for axes x, y, and z of the Layer using degree values.The values are saved in an array (rot[]).

 ▪ rot[0] = X-coordinate (X-Axis)
 ▪ rot[1] = Y-coordinate (Y-Axis)
 ▪ rot[2] = Z-coordinate (Z-Axis)

+

+

void MapDlgGetRotationMode(int mode[])

Retrieves the Rotation mode for axes x, y, and z of the Layer. See »here for a list of Rotation Mode constants. The values are saved in an array (mode[]).

 ▪ mode[0] = X-coordinate (X-Axis)
 ▪ mode[1] = Y-coordinate (Y-Axis)
 ▪ mode[2] = Z-coordinate (Z-Axis)

+

+

void MapDlgGetRotationVector(float rot[])

Retrieves the Rotation values for axes x, y, and z of the Layer using relative values. The values are saved in an array (rot[]).

 ▪ rot[0] = X-coordinate (X-Axis)
 ▪ rot[1] = Y-coordinate (Y-Axis)
 ▪ rot[2] = Z-coordinate (Z-Axis)

+

+

int MapDlgGetRotationXDegree()

Retrieves the Rotation for the X-axis of the Layer using degree values.

+

+

int MapDlgGetRotationXMode()

Retrieves the Rotation mode for the X-axis of the Layer. See »here for a list of Rotation Mode constants.

+

+

float MapDlgGetRotationXVector()

Retrieves the Rotation for the X-axis of the Layer using relative values.

+

+

int MapDlgGetRotationYDegree()

Retrieves the Rotation for the Y-axis of the Layer using degree values.

+

+

int MapDlgGetRotationYMode()

Retrieves the Rotation mode for the Y-axis of the Layer. See »here for a list of Rotation Mode constants.

+

+

float MapDlgGetRotationYVector()

Retrieves the Rotation for the Y-axis of the Layer using relative values.

+

+

int MapDlgGetRotationZDegree()

Retrieves the Rotation value for the Z-axis of the Layer using degree values.

+

+

int MapDlgGetRotationZMode()

Retrieves the Rotation mode for the Z-axis of the Layer. See »here for a list of Rotation Mode constants.

+

+

float MapDlgGetRotationZVector()

Retrieves the Rotation value for the Z-axis of the Layer using relative values.

+

+

int MapDlgGetTileMode()

Retrieves the currently used Tile Mode of the Layer. See »here for a list of Tile Mode constants.

+

+

void MapDlgGetTileOffsetPixel(int offset[])

Retrieves the Tiling Offset of the Layer using pixel values. The values are saved in an array (offset[]).

 ▪ offset[0] = X-coordinate (Offset X)
 ▪ offset[1] = Y-coordinate (Offset Y)

+

+

void MapDlgGetTileOffsetPixel3D(int offset[])

Retrieves the Tiling Offset of the Layer in 3D using pixel values. The values are saved in an array (offset[]).

 ▪ offset[0] = X-coordinate (Offset X)
 ▪ offset[1] = Y-coordinate (Offset Y)
 ▪ offset[2] = Z-coordinate (Offset Z)

+

+

void MapDlgGetTileOffsetVector(float offset[])

Retrieves the Tiling Offset of the Layer using relative values. The values are saved in an array (offset[]).

 ▪ offset[0] = X-coordinate (Offset X)
 ▪ offset[1] = Y-coordinate (Offset Y)

+

+

void MapDlgGetTileOffsetVector3D(float offset[])

Retrieves the Tiling Offset of the Layer in 3D using relative values. The values are saved in an array (offset[]).

 ▪ offset[0] = X-coordinate (Offset X)
 ▪ offset[1] = Y-coordinate (Offset Y)
 ▪ offset[2] = Z-coordinate (Offset Z)

+

+

void MapDlgGetTilePixel(int tile[])

Retrieves the Tiling settings for the Layer using pixel values. The values are saved in an array (tile[]).

 ▪ tile[0] = X-coordinate (Position X)
 ▪ tile[1] = Y-coordinate (Position Y)
 ▪ tile[2] = width (Size X)
 ▪ tile[3] = height (Size Y)

+

+

void MapDlgGetTilePixel3D(int tile[])

Retrieves the Tiling settings for the Layer in 3D using pixel values. The values are saved in an array (tile[]).

 ▪ tile[0] = X-coordinate (Position X)
 ▪ tile[1] = Y-coordinate (Position Y)
 ▪ tile[2] = Z-coordinate (Position Z)
 ▪ tile[3] = width (Size X)
 ▪ tile[4] = height (Size Y)
 ▪ tile[5] = depth (Size Z)

+

+

void MapDlgGetTileVector(float tile[])

Retrieves the Tiling settings for the Layer using relative values. The values are saved in an array (tile[]).

 ▪ tile[0] = X-coordinate (Position X)
 ▪ tile[1] = Y-coordinate (Position Y)
 ▪ tile[2] = width (Size X)
 ▪ tile[3] = height (Size Y)

+

+

void MapDlgGetTileVector3D(float tile[])

Retrieves the tile settings for the Layer in 3D using relative values. The values are saved in an array (tile[]).

 ▪ tile[0] = X-coordinate (Position X)
 ▪ tile[1] = Y-coordinate (Position Y)
 ▪ tile[2] = Z-coordinate (Position Z)
 ▪ tile[3] = width (Size X)
 ▪ tile[4] = height (Size Y)
 ▪ tile[5] = depth (Size Z)

+

+

int MapDlgIsMapped()

Retrieves if the Layer is mapped.

+

+

void MapDlgSetAntiAliasing(int aaLevel)

Sets the Anti-Aliasing mode of the Layer. See »here for a list of Anti-Aliasing Mode constants.

+

+

void MapDlgSetMapMode(int mode)

Sets the Map Mirror Mode for the Layer. See »here for a list of constants.

+

+

void MapDlgSetMapPixel(int x, int y, int w, int h)

Maps the Layer to a certain area of the matrix using pixel values. x and y describe the coordinates. w and h describe width and height, respectively.

+

+

void MapDlgSetMapPixel3D(int x, int y, int z, int w, int h, int d)

Maps the Layer to a certain area of the matrix in 3D using pixel values. x, y, and z describe the coordinates. w, h, and d describe width, height, and depth.

+

+

void MapDlgSetMapVector(float x, float y, float w, float h)

Maps the Layer to a certain area of the matrix using relative values. x and y describe the coordinates. w and h describe width and height, respectively.

+

+

void MapDlgSetMapVector3D(float x, float y, float z, float w, float h, float d)

Maps the Layer to a certain area of the matrix in 3D using relative values. x, y, and z describe the coordinates. w, h, and d describe width, height, and depth.

+

+

void MapDlgSetRotationDegree(int x, int y, int z)

Sets the Rotation values for axes x, y, and z of the Layer using degree values.

+

+

void MapDlgSetRotationMode(int x, int y, int z)

Sets the Rotation mode for axes x, y, and z of the Layer. See »here for a list of Rotation Mode constants.

+

+

void MapDlgSetRotationVector(float x, float y, float z)

Sets the Rotation values for axes x, y, and z of the Layer using relative values.

+

+

void MapDlgSetRotationXDegree(int value)

Sets the Rotation value for the X-axis of the Layer using degree values.

+

+

void MapDlgSetRotationXMode(int mode)

Sets the Rotation mode for the X-axis of the Layer. See »here for a list of Rotation Mode constants.

+

+

void MapDlgSetRotationXVector(float value)

Sets the Rotation value for the X-axis of the specified Layer using degree values.

+

+

void MapDlgSetRotationYDegree(int value)

Sets the Rotation value for the Y-axis of the Layer using degree values.

+

+

void MapDlgSetRotationYMode(int mode)

Sets the Rotation mode for the Y-axis of the Layer. See »here for a list of Rotation Mode constants.

+

+

void MapDlgSetRotationYVector(float value)

Sets the Rotation value for the Y-axis of the Layer using relative values.

+

+

void MapDlgSetRotationZDegree(int value)

Sets the Rotation value for the Z-axis of the Layer using degree values.

+

+

void MapDlgSetRotationZMode(int mode)

Sets the Rotation mode for the Z-axis of the Layer. See »here for a list of Rotation Mode constants.

+

+

void MapDlgSetRotationZVector(float value)

Sets the Rotation value for the Z-axis of the Layer using relative values.

+

+

void MapDlgSetTileMode(int mode)

Sets the Tile Mode of the Layer. See »here for a list of Tile Mode constants.

+

+

void MapDlgSetTileOffsetPixel(int x, int y)

Sets the Tiling Offset of the Layer using pixel values. x describes Offset X, while y represents Offset Y.

+

+

void MapDlgSetTileOffsetPixel3D(int x, int y, int z)

Sets the Tiling Offset of the Layer in 3D using pixel values. x describes Offset X, y describes Offset Y, while z represents Offset Z.

+

+

void MapDlgSetTileOffsetVector(float x, float y)

Sets the Tiling Offset of the Layer using relative values. x describes Offset X, while y represents Offset Y.

+

+

void MapDlgSetTileOffsetVector3D(float x, float y, float z)

Sets the Tiling Offset of the Layer in 3D using relative values. x describes Offset X, y describes Offset Y, while z represents Offset Z.

+

+

void MapDlgSetTilePixel(int x, int y, int w, int h)

Tiles the Layer in a certain area of the mapping using pixel values. x and y describe the coordinates. w and h describe width and height, respectively.

+

+

void MapDlgSetTilePixel3D(int x, int y, int z, int w, int h, int d)

Tiles the Layer in a certain area of the mapping using pixel values. x, y and z describe the coordinates. w, h, and d describe width, height, and depth.

+

+

void MapDlgSetTileVector(float x, float y, float w, float h)

Tiles the Layer to a certain area of the mapping using relative values. x and y describe the coordinates. w and h describe width and height, respectively.

+

+

void MapDlgSetTileVector3D(float x, float y, float z, float w, float h, float d)

Tiles the Layer in a certain area of the mapping in 3D using relative values. Layer indexing (number) starts with 0. x, y, and z describe the coordinates. w, h, and d describe width, height, and depth.

+

+

int max(int x, int y)

Returns the maximum value of the integer numbers x and y.

+

+

+

+

int min(int x, int y)

Returns the minimum value of x and y.

+

+

+

+

void PixelFloodFill(color col, int x, int y)

Fills a single-colored area with the specified color col, starting at the given position x and y.

+

+

+

+

float pow(float x, float y)

Returns the result of the calculation of x to the power of y.

+

+

+

+

Converts the angle a from radian measure to degrees.

+

+

+

+

int random(int min, int max)

Returns a random integer number in the value range of min to max.

+

+

+

+

Reads content as text from a file into the string txt. »Description And Examples

+

+

+

+

void RenderShape(struct color, int shapeType, float positionX, float positionY, float positionZ,
float sizeX, float sizeY, float sizeZ, struct shape, int unitType)

Renders 2D or 3D shapes onto the matrix. »Render Shapes

+

+

+

+

void replace(string src, string old, string new)

Replaces any appearances of old within src with new. »Description

+

+

+

+

int rfindstring(int startIndex, string text, string substring)

This function looks for the substring in the given text from its ending to the beginning. The search starts at the given startIndex, while the last charachter has the index 0. The function returns the index where the substring occurs for the first time after the specified startIndex. If the substring was not found, -1 is returned. »Description

+

+

+

+

float round(float f)

Rounds the given value to its next integer value. The value is rounded correctly, either up or down.

+

+

+

+

void SetAsync(int value)

Sets the asynchronous rendering mode. »Description

This function is only available for some effects.

+

+

void SetBlind(int value)

Sets the Blind Mode. »Description

+

+

void SetChromaKey(color c, int alpha)

Sets the specified alpha value for the specified color c. color c is a structure.  Valid values for alpha range from 0 to 255. Note: To be mainly used in PostRenderEffect().

+

+

+

+

Sets the value for a fader of the DMX Fader Tool. Valid values for index range from 0 to 11 (Indexing starts with 0). Valid values for value range from 0 to 255. Note: Make sure to activate the fader in the DMX Fader Tool first!

+

+

+

+

void SetFilter(int filter)

Applies a Filter Effect (FX) to the matrix. Valid values for filter are »Filters »Description

+

+

+

void SetFrameId(float id)

Sets a new Frame ID. If the given id is lower than 0, it is set to 0. »Description

+

+

Enables or disables the option to link effect Layers. Valid values are 0 (false) or 1 (true).

+

+

void SetMixMode(int mode)

Sets the Mix Mode of the effect. mode may be one of the values defined in »Mix Modes. If mode is invalid, nothing happens and a message is displayed in the Script output of the Script Editor. »Description

+

+

void SetOpacity(int value)

Sets the Opacity value of the effect. Valid values range from 0 to 255.

+

+

void SetPixel(color col, int x, int y)

Sets the pixel at position (x, y) to the specified color. »Description And Examples

+

+

+

+

void SetPixel3D(color col, int x, int y, int z)

Sets the voxel at position (x, y, z) to the specified color.

+

+

+

+

void SetPixelGrayscale(int x, int y)

Renders the selected pixel at position (x, y) in grayscale. »Description

+

+

+

+

void SetPixelGrayscale3D(int x, int y, int z)

Renders the selected voxel at position (x, y, z) in grayscale.

+

+

+

+

void SetPixelTransposeEntry(int idx, int srcX, int srcY, int destX, int destY)

Adds one pixel transpose table entry defined by idx. srcX and srcY are the coordinates of the source in x and y. destX and destY are the destination coordinates. »Description

+

+

+

+

void SetPixelTransposeEntry3D(int idx, int srcX, int srcY, int srcZ, int destX, int destY, int destZ)

Adds one pixel transpose table entry defined by idx. srcX, srcY and srcZ are the coordinates of the source in x, y, and z. destX, destY, and destZ are the destination coordinates. »Description

+

+

+

+

Sets the reading interval for a certain file. To be used in combination with ReadAsync. »Description And Examples

+

+

+

+

void SetSolo(int value)

Sets the Solo Mode. »Description

+

+

void SetStep(int value)

Sets the stepped rendering mode. »Description

This function is only available for some effects.

+

+

void SetSubMaster(int value)

Sets the Submaster value of the effect. Valid values range from 0 to 255.

+

+

void SetVectorPixel(color, float x, float y)

Draws one pixel at the given vector coordinates. In addition to the coordinates, a color must be specified.

+

+

+

+

void SetVectorPixel3D(color, float x, float y, float z)

Draws one voxel at the given vector coordinates. In addition to the coordinates, a color must be specified.

+

+

+

+

void ShiftPixelMatrix(int x, int y, int w, int h, int dir, int step)

Moves the area of the matrix (defined by x, y, w, and h) step pixel into the given direction. Exemplary values for dir are SHIFT_UP, SHIFT_DOWN, or SHIFT_UL. »List Of Global Constants
Note: After shifting the pixels, the data is lost. It is not possible to undo a shifting operation. x, y, w, h describe the rectangle that should be shifted. x and y describe the upper left corner. w and h are the width and height of the rectangle. Learn more »ShiftMatrix

+

+

+

+

void ShiftVectorMatrix(float x, float y, float w, float h, int dir, float step)

Moves the area of the matrix (defined by x, y, w, and h) step pixel into the given direction. Exemplary values for dir are SHIFT_UP, SHIFT_DOWN, or SHIFT_UL. »List Of Global Constants
Note: After shifting the pixels, the data is lost. It is not possible to undo a shifting operation. x, y, w, h describe the rectangle that should be shifted. x and y describe the upper left corner. w and h are the width and height of the rectangle. Learn more »ShiftMatrix

+

+

+

+

float sin(float a)

float sinDeg(float a)

Returns the sine of the angle a in radian measure or degrees, respectively.

+

+

+

+

float sinH(float a)

float sinHDeg(float a)

Returns the hyperbolic sine of the angle a in radian measure or degrees, respectively.

+

+

+

+

float sqrt(float x)

Returns the square root of x.

+

+

+

+

int startswith(string text, string substring)

This function checks if the text string starts with the given substring. If text starts with substring,true is returned. Otherwise false is returned. »Description

+

+

+

+

int strcmp(string str1, string str2)

Compares the two given strings each other. If they are equal, 0 is returned. A value of -1 is returned if str1 is less than str2. A value of 1 is returned if str1 is greater than str2. »Description

+

+

+

+

void strip(string text)

Removes leading and ending white spaces, such as space, tabulator, line feeds, etc., from the given string text. »Description

+

+

+

+

string substring(string text, int start, int count)

Extracts a certain number of characters (count) beginning with start from the given text. If count is -1, all characters of the string starting at start are returned. »Description

E.g.: substring("Hello", 0, 2) returns "He".

+

+

+

+

float tan(float a)

float tanDeg(float a)

Returns the tangent of the angle a in radian measure or degrees, respectively.

+

+

+

+

float tanH(float a)

float tanHDeg(float a)

Returns the hyperbolic tangent of the angle a in radian measure or degrees, respectively.

+

+

+

+

void ToggleAsync()

Toggles the asynchronous rendering mode. »Description

This function is only available for some effects.

+

+

void ToggleBlind()

Toggles Blind Mode. »Description

+

+

+

+

void ToggleSolo()

Toggles Solo Mode. »Description

+

+

void ToggleStep()

Toggles the stepped rendering mode. »Description

This function is only available for some effects.

+

+

void tokenize(string src, string delimiter, string reslist[])

Strips the string src into smaller pieces delimited by characters within delemiter. The result is returned in reslist. »Description

+

+

+

+

void tolower(string text)

Converts each character of the given string text into a lowercase character. »Description

+

+

+

+

void toupper(string text)

Converts each character of the given string text into a uppercase characters. »Description

+

+

+

+

void TRACE(variable)

Writes the value of the specified variable into the Script output window. Fulfills the same function as »WriteText

+

+

+

+

float trunc(float f)

Truncates/cuts off the decimals from a floating point value.

+

+

+

+

void VectorFloodFill(color col, float x, float y)

Fills an single-colored area with the given color col, starting at the given position x and y. In contrast to PixelFloodFill(), the coordinates are given as floating point values ranging from 0.0 to 1.0.

+

+

+

+

void WriteText(string s)

Writes the specified message into the Script Output window. »Example

+

+

+

+

void WriteTextClear()

Clears the Script Output window from all messages.

+

+

+

+

Deprecated Functions

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

Specific Functions

Macro Functions Only Available For The MAS Script Effect

You can find a detailed description in the chapter »MAS Script Effect: Functions

Here is an overview:

 ▪ SetFrameCount

Functions Only Available For Macros For Effects

The standard functions of the MAS Script effect are also available for effect macros. Effects in MADRIX are grouped into three categories: SCE - Static Color effects, S2L - Sound2Light effects, and M2L - Music2Light effects.
For better readability, we have only listed the various effects. You can find more information in the chapter »Macros for Effects: Functions or in the sub-chapters:

 SCE - Static Color Effects S2L - Sound2Light Effects M2L - Music2Light Effects

Functions Only Available For The Main Output Macro

You can find a detailed description in the chapter »Main Output Macro: Functions
Here is an overview:

 ▪ CallGroupPreset
 ▪ CueDelete
 ▪ CueDeleteAll
 ▪ CueDeleteCurrent
 ▪ CueGetDateDay
 ▪ CueGetDateMonth
 ▪ CueGetDateString
 ▪ CueGetDateWeekday
 ▪ CueGetDateYear
 ▪ CueGetDescription
 ▪ CueGetDurationFrame
 ▪ CueGetDurationHour
 ▪ CueGetDurationMinute
 ▪ CueGetDurationSecond
 ▪ CueGetDurationString
 ▪ CueGetFollowCue
 ▪ CueGetGroupPreset
 ▪ CueGetPlace
 ▪ CueGetStorage
 ▪ CueGetTimeCodeFrame
 ▪ CueGetTimeCodeHour
 ▪ CueGetTimeCodeMinute
 ▪ CueGetTimeCodeSecond
 ▪ CueGetTimeCodeString
 ▪ CuelistBack
 ▪ CuelistCount
 ▪ CuelistCueAllOccupied
 ▪ CuelistCurrentCue
 ▪ CuelistCurrentCue
 ▪ CuelistGo
 ▪ CuelistGoto
 ▪ CuelistNew
 ▪ CuelistPlay
 ▪ CuelistProgress
 ▪ CuelistStop
 ▪ CueSetDate
 ▪ CueSetDateString
 ▪ CueSetDateWeekday
 ▪ CueSetDescription
 ▪ CueSetDuration
 ▪ CueSetDurationString
 ▪ CueSetFollow
 ▪ CueSetGroupPreset
 ▪ CueSetPlace
 ▪ CueSetStorage
 ▪ CueSetTimeCode
 ▪ CueSetTimeCodeString
 ▪ Filter
 ▪ GetAutoGainControl
 ▪ GetBlackout
 ▪ GetFilter
 ▪ GetFilterColor
 ▪ GetFreeze
 ▪ GetGroupCount
 ▪ GetGroupDefaultValue
 ▪ GetGroupDefaultValueByIndex
 ▪ GetGroupDisplayColor
 ▪ GetGroupDisplayColorByIndex
 ▪ GetGroupDisplayName
 ▪ GetGroupDisplayNameByIndex
 ▪ GetGroupFlashMode
 ▪ GetGroupFlashModeByIndex
 ▪ GetGroupIdByIndex
 ▪ GetGroupValue
 ▪ GetGroupValueByIndex
 ▪ GetStorage
 ▪ GetStoragePause
 ▪ GetStoragePlace
 ▪ GetStoragePlaceFilter
 ▪ GetStoragePlaceFullState
 ▪ GetStoragePlaceSubMaster
 ▪ GetStorageSpeedMaster
 ▪ GetStorageSubMaster
 ▪ GetStrobe
 ▪ GetStrobeColor
 ▪ GetStrobeValue
 ▪ ImportPatch
 ▪ ImportStorage
 ▪ ImportStoragePlace
 ▪ SetAutoGainControl
 ▪ SetBlackout
 ▪ SetFilter
 ▪ SetFilterColor
 ▪ SetFreeze
 ▪ SetGroupFlashMode
 ▪ SetGroupFlashModeByIndex
 ▪ SetGroupPreset
 ▪ SetGroupValue
 ▪ SetGroupValueByIndex
 ▪ SetStorage
 ▪ SetStoragePause
 ▪ SetStoragePlace
 ▪ SetStoragePlaceFilter
 ▪ SetStoragePlaceSubMaster
 ▪ SetStorageSpeedMaster
 ▪ SetStorageSubMaster
 ▪ SetStrobe
 ▪ SetStrobeColor
 ▪ SetStrobeValue
 ▪ ToggleGroupFlashMode
 ▪ ToggleGroupFlashModeByIndex

Functions Only Available For The Storage Place Macro

You can find a detailed description in the chapter »Storage Place Macro: Functions
Here is an overview:

 ▪ GetDescription
 ▪ GetFilter
 ▪ GetLayerCount
 ▪ GetPause
 ▪ GetSpeedMaster
 ▪ GetSubMaster
 ▪ LayerGetAsync
 ▪ LayerGetBlind
 ▪ LayerGetFilter
 ▪ LayerGetFrameCount
 ▪ LayerGetFrameId
 ▪ LayerGetFrameSteps
 ▪ LayerGetMixMode
 ▪ LayerGetOpacity
 ▪ LayerGetSolo
 ▪ LayerGetStep
 ▪ LayerGetSubMaster
 ▪ LayerMapDlgGetMapMode
 ▪ LayerMapDlgGetMapPixel
 ▪ LayerMapDlgGetMapPixel3D
 ▪ LayerMapDlgGetMapVector
 ▪ LayerMapDlgGetMapVector3D
 ▪ LayerMapDlgGetRotationDegree
 ▪ LayerMapDlgGetRotationMode
 ▪ LayerMapDlgGetRotationVector
 ▪ LayerMapDlgGetRotationXDegree
 ▪ LayerMapDlgGetRotationXMode
 ▪ LayerMapDlgGetRotationXVector
 ▪ LayerMapDlgGetRotationYDegree
 ▪ LayerMapDlgGetRotationYMode
 ▪ LayerMapDlgGetRotationYMode
 ▪ LayerMapDlgGetRotationYVector
 ▪ LayerMapDlgGetRotationZDegree
 ▪ LayerMapDlgGetRotationZMode
 ▪ LayerMapDlgGetRotationZVector
 ▪ LayerMapDlgGetTileMode
 ▪ LayerMapDlgGetTileOffsetPixel
 ▪ LayerMapDlgGetTileOffsetPixel3D
 ▪ LayerMapDlgGetTileOffsetVector
 ▪ LayerMapDlgGetTileOffsetVector3D
 ▪ LayerMapDlgGetTilePixel
 ▪ LayerMapDlgGetTilePixel3D
 ▪ LayerMapDlgGetTileVector
 ▪ LayerMapDlgGetTileVector3D
 ▪ LayerMapDlgIsMapped
 ▪ LayerMapDlgSetMapMode
 ▪ LayerMapDlgSetMapPixel
 ▪ LayerMapDlgSetMapPixel3D
 ▪ LayerMapDlgSetMapVector
 ▪ LayerMapDlgSetMapVector3D
 ▪ LayerMapDlgSetRotationDegree
 ▪ LayerMapDlgSetRotationMode
 ▪ LayerMapDlgSetRotationVector
 ▪ LayerMapDlgSetRotationXDegree
 ▪ LayerMapDlgSetRotationXMode
 ▪ LayerMapDlgSetRotationXVector
 ▪ LayerMapDlgSetRotationYDegree
 ▪ LayerMapDlgSetRotationYMode
 ▪ LayerMapDlgSetRotationYMode
 ▪ LayerMapDlgSetRotationYVector
 ▪ LayerMapDlgSetRotationZDegree
 ▪ LayerMapDlgSetRotationZMode
 ▪ LayerMapDlgSetRotationZVector
 ▪ LayerMapDlgSetTileMode
 ▪ LayerMapDlgSetTileOffsetPixel
 ▪ LayerMapDlgSetTileOffsetPixel3D
 ▪ LayerMapDlgSetTileOffsetVector
 ▪ LayerMapDlgSetTileOffsetVector3D
 ▪ LayerMapDlgSetTilePixel
 ▪ LayerMapDlgSetTilePixel3D
 ▪ LayerMapDlgSetTileVector
 ▪ LayerMapDlgSetTileVector3D
 ▪ LayerSetAsync
 ▪ LayerSetBlind
 ▪ LayerSetFilter
 ▪ LayerSetFrameId
 ▪ LayerSetMixMode
 ▪ LayerSetOpacity
 ▪ LayerSetSolo
 ▪ LayerSetStep
 ▪ LayerSetSubMaster
 ▪ LayerToggleAsync
 ▪ LayerToggleBlind