SetDisplayEffect
InstallShield 2008 ยป InstallScript Language Reference
Project
This information applies to the following project types:
- InstallScript
- InstallScript MSI
The SetDisplayEffect function specifies the display effect to be used when displaying bitmaps or metafiles with the PlaceBitmap function or when displaying billboards. Once the display effect has been set, all bitmaps subsequently displayed by PlaceBitmap, or billboards, are displayed with this effect until a new effect is set by another call to SetDisplayEffect.
Display effects occur only when placing bitmaps or billboards. No display effects are used when removing bitmaps or billboards.
Note
A bitmap that is displayed by PlaceBitmap with the option BITMAPICON, FULLSCREEN, FULLSCREENSIZE, or TILED is not displayed with display effects. Instead it is displayed normally. For more information, see PlaceBitmap.
Syntax
SetDisplayEffect ( nEffect );
Parameters
SetDisplayEffect Parameters
|
Parameter
|
Description
|
|
nEffect
|
Specifies a display effect. Pass one of the following predefined constants in this parameter. Note that these constants are exclusive; they cannot be bitwise ORed with each other. Moreover, this parameter has no effect when BITMAPICON, FULLSCREEN, FULLSCREENSIZE, or TILED is specified when displaying a bitmap with PlaceBitmap.
- EFF_FADE—The bitmap or billboard slowly fades in and out.
- EFF_REVEAL—The bitmap or billboard gradually fills in from the center toward all sides.
- EFF_HORZREVEAL—The bitmap or billboard gradually scrolls out horizontally from its center.
- EFF_HORZSTRIPE—section of the bitmap or billboard fills in horizontally from the outside in; then the remainder fills in from the center out.
- EFF_VERTSTRIPE—A section of the bitmap or billboard fills in vertically from the outside in; then the remainder fills in from the center out.
- EFF_BOXSTRIPE—A section of the bitmap or billboard fills in from all sides; then the remainder fills in toward all sides.
- EFF_NONE—This option is the default setting. Use it to clear the display effects after calling one of the other options.
Only EFF_REVEAL and EFF_HORZREVEAL work with metafiles.
|
Return Values
SetDisplayEffect Return Values
|
Return Value
|
Description
|
|
0
|
Indicates that the function successfully set the display effect.
|
|
< 0
|
Indicates that the function was unable to set the display effect.
|
See Also
SetDisplayEffect Example
