Functions (Macros For Effects)

Specific Resources

General Resources

Available Functions

Standard Functions

Effect-Specific Functions Depending On The Effect

Using The Frame ID

There are a lot of effects which use an internal Frame ID to have more control. For example, the SCE Color Scroll Effect uses the Frame ID to control the speed of scrolling. This does not make sense for all effects. However, for each effect it is possible to set and get the current Frame ID and Frame Count. The Frame Count identifies the maximal Frame ID used by the effect. This may be utilized to speed up the effect. For example, the following source code increases the speed of an effect that is controlled by the Frame ID.

void PreRenderEffect()

{

    SetFrameId(fmod(GetFrameId() + 2, GetFrameCount()));

}

However, it is not possible to set the Frame Count by a macro; except for a macro of the MAS Script Effect.

Learn more »Using Frames

Applying Asynchronous Rendering

Applying Stepped Rendering

Normally, the effects use floating-point frames which is represented by the rational return values of the functions GetFrameId and GetFrameSteps. That way, the effects are able to render very precisely and smooth. However, sometimes it is desired to let the effects "step" pixel by pixel. This option is only available for some effects, for example »SCE Color Scroll and »MAS Script

Valid values for value are 0 (Off) or 1 (On). If stepped rendering is activated, effects like SCE Color Scroll look hard-stepping. In the MAS Script effect, stepped rendering causes GetFrameId and GetFrameSteps to return only integer values.

Learn more »Using Frames

Applying Filter Effects (FX)

You may quickly change the visual outcome of Effects using Filters (also called Filter Effects, FX).

Valid values for filter are the global variables »Filters. You can also find further explanations about the various filter types in this chapter.

Setting And Getting Blind Mode Or Solo Mode

Blind Mode and Solo Mode are two options available for each Layer. Blind Mode will deactivate the current Layer, while Solo Mode will only show this Layer while disabling all other Layers.

 
Valid values for value are 0 (Off) or 1 (On).