Ovis_Decoration_Parent_Layer_Nth()
Abstract
Returns the Nth layer that holds the Ovis decoration.
Syntax
Ovis_Decoration_Parent_Layer_Nth (dec_ptr, parent_index)
| Argument | Type | Description |
|---|---|---|
dec_ptr |
OvisT_Decoration * |
Ovis decoration |
parent_index |
unsigned int |
Index of layer |
Return Type
OvisT_Layer *
Parent layer
Header
ovis_decoration.h
Details
This function returns a pointer to the n-th layer that holds the Ovis decoration object.
Example
OvisT_2D_Line * line;
unsigned int count, i;
OvisT_Layer * layer;
/* …line created elsewhere */
count = Ovis_Decoration_Parent_Layer_Count (line);
for (i = 0; i < count; i++)
{
layer = Ovis_Decoration_Parent_Layer_Nth (line, i);
/* … do something with layer */
}
Errors
- Decoration is NIL.
Reference
- Use the function Ovis_Decoration_Parent_Layer_Count() to obtain the number of parent layers.