ClearScreen -- clear screen with a transition effect
[handle] = ClearScreen(effect, color[, table])
This function clears the screen with one of Hollywood's transition effects. The color is a RGB value specifying the color of the transition effect.

Note that this function will automatically create a new BGPic filled with the specified color and switch to it.

Starting with Hollywood 5.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:

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

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

You can use this field to create an asynchronous draw object for this transition. If you pass True here DisplayTransitionFX() 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.

Specifies the new x-position for the display. If you want the display to keep its current x-position, specify the special constant #KEEPPOSITION. Defaults to #CENTER.

Specifies the new y-position for the display. If you want the display to keep its current y-position, specify the special constant #KEEPPOSITION. Defaults to #CENTER.

Have a look at the documentation of DisplayTransitionFX() to see the list of all transition effects that can be used.

special effect constant (see DisplayTransitionFX())
color that shall be used for the effect
optional: table configuring the transition effect
optional: handle to an asynchronous draw object; will only be returned if Async has been set to True (see above)
ClearScreen(#VBLINDS32, $000000, {Speed = 10})
The above code clears the screen with color black and the effect #VBLINDS32 and speed of 10.

Show TOC