DisplayTransitionFX -- change the background picture using a transition effect
[handle] = DisplayTransitionFX(id[, table])
This function displays a new background picture with the specified transition effect. A list of all available effects is appended below. You also have to specify the speed of the transition which can be either one of the special speed constants (#SLOWSPEED, #NORMALSPEED, #FASTSPEED) or a custom fine-tuned numeric value. The rule of thumb for the speed parameter: the higher the value the faster the transition will run.

For the best effect, the new background picture should have the same dimensions as the old. If this is not the case, the old background picture will be scaled to the size of the new one.

Note that transparent BGPics cannot be displayed using a transition effect. It is also not possible to display a non-transparent BGPic with transition effect if the current BGPic is a transparent one. For this function to work, two conditions must be met: The current BGPic as well as the new BGPic must both be non-transparent.

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:

Specifies the desired effect for the transition. See the list below for possible effects. (defaults to #RANDOMEFFECT)

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.

The following effects are currently available:

Starting with Hollywood 1.5 there are some new effects:

Starting with Hollywood 1.9 there are a number of new effects:

If you choose #RANDOMEFFECT, Hollywood will randomly choose any effect from all possible effects. Very useful when doing slideshows. When using the 68k version of Hollywood, #RANDOMEFFECT will not choose any high-end effects automatically.


effect can only be used with background pictures

effect can only be used with objects (brushes, layers etc. - but not background pictures!)

effect can only be used with text objects

high-end effects which means that it needs a lot of cpu power to run smoothly. You can run them on 68k, but it is no fun at all because they will take like 4 minutes for a transition or so. You should only use "!"-effects on PPC systems, e.g. MorphOS or WarpOS.

identifier of the background picture to display
optional: transition effect configuration
optional: handle to an asynchronous draw object; will only be returned if Async has been set to True (see above)
DisplayTransitionFX(2, #HSTRIPES32, 10)   ; old syntax


DisplayTransitionFX(2, {Type = #HSTRIPES32, Speed = 10})  ; new syntax
Display background picture 2 using the #HSTRIPES32 effect and speed 10.

Show TOC