Introduction
▪Macros for MADRIX Effects can be used to modify, manipulate, and affect the visual outcome of an effect or add automatization to it.
▪Effect Macros are bound to a particular effect due to the different effects and its different functions and parameters.
▪Effect Macros are available for every single MADRIX Effect, incl. SCE, S2L, M2L, TRI, as well as MAS.
▪Effect Macros are stored as a part of the effect. This means they are part of a stored Storage Place file or Setup file.
▪It is possible to save macros as separate files. The file extension of a macro is *.mms. The extension of a crypted macro is *.mcm.
Editor - Controls the corresponding Macro Editor.
|
Macro - Allows you to configure and manage a Macro. At the same time this means that no Macro is running or included. |
|
Deactivated [Macro Included] - A macro is included/inserted in the Macro Editor, but the macro is currently not running. Left Mouse Click - Click once to activate the Macro. |
|
Activated - A macro has been compiled and is currently running. Left Mouse Click - Click once to deactivate the Macro. |
|
Right Mouse Click - Opens the context menu. Edit... - Opens the Macro Editor to write, edit, include, and compile Macros. Open... - Allows you to load a Macro from an external file [of the file type *.mms and *.mcm]. Once loaded, the Macro will automatically be activated. Copy - Allows you to copy the Macro to the clipboard of the computer. Paste - Allows you to paste the Macro from the clipboard into the currently selected Macro Editor. If the copied Macro is running, the new Macro will be automatically activated as well. If the copied Macro is deactivated, the new Macro will be automatically deactivated as well. Clear - Deletes all content of the Macro Editor and thereby deactivates and erases any Macro. |
Functions Called By MADRIX
Overview
The following functions are called by MADRIX for each effect and can be implemented by a macro in order to react to different events:
▪void InitEffect()
▪void PreRenderEffect()
▪void PostRenderEffect()
▪void MatrixSizeChanged()
If a function is not needed by a macro, it is not necessary to implement it. Regarding InitEffect, PreRenderEffect, and PostRenderEffect a message is printed out if one of them is missing. This is not an error, but only information for the developer of the script.
InitEffect
(Automatically included in a new macro)
InitEffect is called by MADRIX whenever the script needs to be initialized. This is the case after compiling and starting a new macro or when the user pressed the Start button of the »Script Editor. A macro can assume that any global variable is initialized with 0 and that any global array is empty as long as it has not been initialized with any value.
This function is the right place to initialize global variables, reset any arrays, or whatever is necessary to (re)start the macro.
PreRenderEffect
(Automatically included in a new macro)
PreRenderEffect is called before the effect is going to be rendered. Changes done here affect the current frame, but may be overwritten by the effect itself.
PostRenderEffect
(Automatically included in a new macro)
This function is called after the effect has been rendered. Here, the result of the effect can be manipulated. You could use a gray filter on it, for example.
Note: The matrix, which the macro manipulates, is the same matrix that the effect uses to calculate its own effect. The effect may rely on the output being the input for the next frame with undefined behavior.
Also note: Mapping operations done in PostRenderEffect will affect the next frame, but not the current one. To control the current frame, please use PreRenderEffect.
MatrixSizeChanged
(Automatically included in a new macro)
MatrixSizeChanged is called after the size of the matrix has been changed. This may be due to a change to the matrix settings or because a new map setting was set, e.g. caused by the call of a map function.
Standard Outline
When you open the Effect Macro Editor, the empty standard macro will look like this:
@scriptname="";
@author="";
@version="";
@description="";
void InitEffect()
{
}
void PreRenderEffect()
{
}
void PostRenderEffect()
{
}
void MatrixSizeChanged()
{
InitEffect();
}