Name
ShowLayerFX -- display a hidden layer with transition effects (V1.9)
Synopsis
[handle] = ShowLayerFX(id[, table])
Function
This function is an extended version of the ShowLayer() command. It displays the hidden layer specified by id uses one of the many Hollywood transition effects. You can also specify the speed for the transition and an optional argument.

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)

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

Inputs
id
identifier or name of the hidden layer to display
table
optional: table configuring the transition effects
Results
handle
optional: handle to an asynchronous draw object; will only be returned if Async has been set to True (see above)
Example
ShowLayerFX(5, #CROSSFADE)              ; old syntax

OR

ShowLayerFX(5, {Type = #CROSSFADE})     ; new syntax
The above code shows layer 5 with a nice crossfade transition.

Show TOC