Name
FreeClipRegion -- free a clip region (V2.0)
Synopsis
FreeClipRegion(id)
Function
This function frees a clip region created by CreateClipRegion().

If there are sprites which are attached to this clip region, they will be let out and the clip region is freed immediately.

The behaviour for layers is different: If there are layers which reference this clip region, then Hollywood will keep the clip region until these layers are gone. As soon as there are no more layers which reference this clip region, the Hollywood garbage collector will free the clip region automatically if you have previously called FreeClipRegion() on it.

Please see also the documentation of CreateClipRegion() for more information on clip regions.

Inputs
id
identifier for the clip region to be freed
Example
See SetClipRegion


Show TOC