Ovis_Decoration_Color_Get()
Abstract
Returns the color of the Ovis decoration.
Syntax
Ovis_Decoration_Color_Get (dec_ptr, color_ptr)
| Argument | Type | Description |
|---|---|---|
dec_ptr |
OvisT_Decoration * |
Decoration object |
color_ptr |
PrgT_Color * |
Color of the object (red, green, blue) |
Return Type
OvisT_Compcode
If color is returned, OvisC_Compcode_Success; OvisC_Compcode_Failure otherwise.
Header
ovis_decoration.h
Details
This function returns the color of the decoration.
Example
OvisT_3D_Sphere * sphere;
PrgT_Color color;
/* … sphere created elsewhere */
Ovis_Decoration_Color_Get (sphere, &color);
Errors
- Decoration is NIL.
- Return address for color value is NIL.
Reference
- Use the function
Ovis_Decoration_Color_Set()to specify the color of a decoration.