Ovis_Layer_Destroy()
Abstract
Destroys the Ovis layer and deallocates the memory of the layer.
Syntax
Ovis_Layer_Destroy (layer_ptr)
| Argument | Type | Description |
|---|---|---|
layer_ptr |
OvisT_Layer * |
Ovis layer |
Return Type
void
No return value.
Header
ovis_layer.h
Details
This function destroys the Ovis layer and deallocates the memory of the layer. Any associated graphical decorations have their reference to the destroyed layer removed.
The destroy_proc function associated with the layer is called if it was specified when the layer was created or with Ovis_Layer_Destroy_Proc_Set().
Example
OvisT_Layer * layer;
/* Layer was created at some point */
Ovis_Layer_Destroy (layer);
Errors
- Layer is NIL.
Reference
- Use the function
Ovis_Layer_Destroy_Proc_Set()to specify a function to be invoked when the layer is destroyed.