| synopsis || arguments || prev || next |
void remove_compositing_layer( int layer_idx, bool permanent)
Java: void Remove_compositing_layer( int layer_idx, boolean permanent)
[Declared in "../apps/support/kdu_region_compositor.h"]
Use this function to remove layers from the current composition and/or to permanently destroy the resources allocated to layers. You can simultaneously remove all layers by setting layer_idx to a negative value.
Unused layers can also be implicitly removed in the process of adding new layers, by using the set_frame function.
If negative, all layers are simultaneously removed. Otherwise, only the layer (if any) which matches this index is affected.
If true, the layer is permanently destroyed, cleaning up its internal resources (they may be substantial).
Otherwise, the layer is moved onto an inactive list, from which it may be retrieved later with the add_compositing_layer function (or indirectly using set_frame). The layer may later be permanently removed from the inactive list by calling the present function at any time, with permanent set to true. In addition, layers which have been inactive for some time may be destroyed by calling cull_inactive_layers.