CreateCompositorEffect()

Syntax

Result = CreateCompositorEffect(#Effect, CameraID, EffectName$)

Create a new compositor effect. Once created, the effect is immediately applied to the rendering. It is possible to hide the effect with HideEffect().

Parameters

#Effect	The number to identify the new effect. #PB_Any can be used to auto-generate this number.
CameraID	The camera to apply the effect. This effect will only affect this camera. To get a valid 'CameraID', use CameraID().
EffectName$	Name of effect, as described in the OGRE compositor file (usually a '.compositor' file).

Return value

Returns nonzero if the effect was created successfully and zero if there was an error. If #PB_Any was used as the #Effect parameter then the new generated number is returned on success.

See Also

FreeEffect(), HideEffect()

Supported OS

All