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

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:

Type:

Specifies the desired effect for the transition. See the list below for possible 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 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.

X:

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.

Y:

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:

• – Horizontal stripes: #HSTRIPES2, #HSTRIPES4, #HSTRIPES16, #HSTRIPES32
• – Vertical stripes: #VSTRIPES2, #VSTRIPES8, #VSTRIPES16, #VSTRIPES32
• – Fast horizontal blinds: #HBLINDS8, #HBLINDS16, #HBLINDS32, #HBLINDS64, #HBLINDS128
• – Fast vertical blinds: #VBBLINDS8, #VBLINDS16, #VBLINDS32, #VBLINDS64, #VBLINDS128
• – Horizontal curtain: #HOPENCURTAIN, #HCLOSECURTAIN
• – Vertical curtain: #VOPENCURTAIN, #VCLOSECURTAIN
• – Horizontal lines: #HLINES, #HLINES2
• – Vertical lines: #VLINES, #VLINES2
• – Reveal: #REVEALLEFT, #REVEALRIGHT, #REVEALTOP, #REVEALBOTTOM
• – Bars: #BARS
• – Quarters: #QUARTERS
• – Crossfade: #CROSSFADE
• – Fade: #FADE; optional argument specifies color to use
• – Blend: #BLEND; optional argument specifies color to use for blending

Starting with Hollywood 1.5 there are some new effects:

• – Rectangle zoom in: #RECTCENTER, #RECTNORTH, #RECTNORTHEAST, #RECTEAST, #RECTSOUTHEAST, #RECTSOUTH, #RECTSOUTHWEST, #RECTWEST, #RECTNORTHWEST
• – Rectangle zoom out: #RECTBACKCENTER, #RECTBACKNORTH, #RECTBACKNORTHEAST, #RECTBACKEAST, #RECTBACKSOUTHEAST, #RECTBACKSOUTH, #RECTBACKSOUTHWEST, #RECTBACKWEST, #RECTBACKNORTHWEST
• – Scroll in: #SCROLLLEFT, #SCROLLRIGHT, #SCROLLTOP, #SCROLLBOTTOM (optional argument specifies a special effect to apply to the scroll process, you can use the same effects here like in MoveBrush())
• – Stretch image in: #STRETCHLEFT, #STRETCHRIGHT, #STRETCHTOP, #STRETCHBOTTOM, #HSTRETCHCENTER, #VSTRETCHCENTER
• – Zoom image in: #ZOOMCENTER, #ZOOMNORTH, #ZOOMNORTHEAST, #ZOOMEAST, #ZOOMSOUTHEAST, #ZOOMSOUTH, #ZOOMSOUTHWEST, #ZOOMWEST, #ZOOMNORTHWEST
• – Flow: #HFLOWTOP, #HFLOWBOTTOM, #VFLOWLEFT, #VFLOWRIGHT
• – Gates: #HOPENGATE, #HCLOSEGATE, #VOPENGATE, #VCLOSEGATE (B)
• – Pushes: #PUSHLEFT, #PUSHRIGHT, #PUSHTOP, #PUSHBOTTOM (B)
• – Puzzle: #PUZZLE
• – Diagonal: #DIAGONAL
• – Roll on: #ROLLTOP
• – Wallpaper: #WALLPAPERTOP
• – General vertical stripes: #VSTRIPES; optional argument specifies the number of stripes to display
• – General horizontal stripes: #HSTRIPES; optional argument specifies the number of stripes to display

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

• – Scroll image in: #SCROLLNORTHEAST, #SCROLLSOUTHEAST, #SCROLLSOUTHWEST, #SCROLLNORTHWEST (optional argument specifies a special effect to apply to the scroll process, you can use the same effects here like in MoveBrush())
• – Reveal clock wise: #CLOCKWIPE
• – Star zoom in: #STAR
• – Strange pushes: #HSTRANGEPUSH, #VSTRANGEPUSH (B)
• – Slide projector: #SLIDELEFT, #SLIDERIGHT, #SLIDETOP, #SLIDEBOTTOM (B)
• – Spiral reveal: #SPIRAL
• – Swiss cross effect: #SWISS
• – Quad rectangles: #QUADRECT
• – Split effects: #HSPLIT, #VSPLIT
• – Up'n'down: #UPNDOWN
• – Register card effect: #CARDTOP, #CARDBOTTOM (B)
• – Sun zoom in: #SUN
• – Water ripples: #WATER1, #WATER2, #WATER3, #WATER4 (!)
• – Strudel effect: #STRUDEL (!)
• – Dissolve picture: #DISSOLVE
• – Zoom to pixels: #PIXELZOOM1
• – Zoom to pixels 2: #PIXELZOOM2 (B)
• – Large zoom effects: #ZOOMIN, #ZOOMOUT (B)
• – Crush effects: #CRUSHLEFT, #CRUSHRIGHT, #CRUSHTOP, #CRUSHBOTTOM (B)
• – Flip coins: #VFLIPCOIN, #VLOWFLIPCOIN, #HFLIPCOIN, #HLOWFLIPCOIN (B)
• – Turn down picture effect: #TURNDOWNTOP, #TURNDOWNBOTTOM, #TURNDOWNLEFT, #TURNDOWNRIGHT (B)
• – Type writer effect: #TYPEWRITER (T) [no longer supported since V3.1]
• – Wallpaper: #WALLPAPERLEFT (!)
• – Roll on: #ROLLLEFT

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.

Legend:

(B):

effect can only be used with background pictures

(O):

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

(T):

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.

id

identifier of the background picture to display

table

optional: transition effect configuration

handle

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

OR

DisplayTransitionFX(2, {Type = #HSTRIPES32, Speed = 10})  ; new syntax