Ovis_Decoration_State_Set()
Abstract
Sets the client state of the Ovis decoration.
Syntax
Ovis_Decoration_State_Set (dec_ptr, user_state_ptr)
| Argument | Type | Description |
|---|---|---|
dec_ptr |
OvisT_Decoration * |
Specifies the decoration |
user_state_ptr |
void * |
Specifies the optional user-provided state of the decoration |
Return Type
void *
Previous state of the decoration
Header
ovis_decoration.h
Details
This function sets the client state of the Ovis decoration.
Example
OvisT_2D_Text * text;
void * old_state;
/* … text created at some point */
old_state = Ovis_Decoration_State_Set (text, OPC_NIL);
Errors
- Decoration is NIL.
Reference
- Use the function Ovis_Decoration_Destroy_Proc_Set() to specify a function to be invoked when the decoration is destroyed.
- Use the function Ovis_Decoration_State_Get() to retrieve the current client state of a decoration.