Ovis_Decoration_State_Get()
Abstract
Returns the client state pointer of the Ovis decoration.
Syntax
Ovis_Decoration_State_Get (dec_ptr)
| Argument | Type | Description |
|---|---|---|
dec_ptr |
OvisT_Decoration * |
Ovis decoration |
Return Type
void *
The state
Header
ovis_decoration.h
Details
This function returns the client state pointer of the decoration.
Example
OvisT_2D_Text * text;
void * state;
/* … text created at some point */
state = Ovis_Decoration_State_Get (text);
Errors
- Decoration is NIL.
Reference
- Use the function Ovis_Decoration_State_Set() to specify the decoration’s client state.