[handle] = ShowLayerFX(id[, table])

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 ShowLayerFX() 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.

NoBorderFade

If the layer to be shown has a border, do not gradually fade in the border but display it in one go at the end of the transition effect. (V5.0)

BorderFX:

If the layer to be shown has a border, Hollywood will only apply the transition effect to the border if the layer is a transparent layer with text or pixel graphics. For non-transparent and vector graphics layers a generic fade effect will be used instead because otherwise there would be visual glitches between the penultimate and final effect frame because of differences in the border algorithms. If you don't care about this glitch and want to force Hollywood to always apply the transition effect to the border, set this tag to True. To force Hollywood to always use the generic fade mode, set this tag to False. (V9.0)

You need to enable layers before you can use this function. See Layers introduction for details.

id

identifier of the layer or layer group to show

table

optional: table configuring the transition effects

handle

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

ShowLayerFX(5, #CROSSFADE)              ; old syntax

OR

ShowLayerFX(5, {Type = #CROSSFADE})     ; new syntax