[handle] = DisplayBrushFX(id, x, y[, table])

If layers are enabled, this command will add a new layer of the type #BRUSH to the layer stack.

Starting with Hollywood 4.0 this function uses a new syntax with just a single table as an optional argument. The old syntax is still supported for compatibility reasons. The optional table argument can be used to configure the transition effect. The following options are possible:

Type:

Specifies the desired effect for the transition. See DisplayTransitionFX for a list of all supported transition effects. (defaults to #RANDOMEFFECT)

Speed:

Specifies the desired speed for the transition. The higher the value you specify here, the faster the effect will be displayed. (defaults to #NORMALSPEED)

Parameter:

Some transition effects accept an additional parameter. This can be specified here. (defaults to #RANDOMPARAMETER)

Async:

You can use this field to create an asynchronous draw object for this transition. If you pass True here DisplayBrushFX() will exit immediately, returning a handle to an asynchronous draw object which you can then draw using AsyncDrawFrame(). See AsyncDrawFrame for more information on asynchronous draw objects.

id

identifier of the brush to display

x

desired x position for the brush

y

desired y position for the brush

table

optional: configuration for the transition effect

handle

optional: handle to an asynchronous draw object; will only be returned if Async has been set to True (see above)

DisplayBrushFX(1, 0, 0, #VLINES, 10)   ; old syntax

OR

DisplayBrushFX(1, 0, 0, {Type = #VLINES, Speed = 10})  ; new syntax