Ovis_Decoration_Color_Set()
Abstract
Specifies the color of the Ovis decoration.
Syntax
Ovis_Decoration_Color_Set (dec_ptr, color)
| Argument | Type | Description |
|---|---|---|
dec_ptr |
OvisT_Decoration * |
Specifies the decoration |
color |
PrgT_Color |
Specifies the color (red, green, blue). Each component is a value between 0 (no component) and 255 (full component). |
Return Type
OvisT_Compcode
If color is set, OvisC_Compcode_Success; OvisC_Compcode_Failure otherwise.
Header
ovis_decoration.h
Details
This function specifies the color of the decoration.
Example
OvisT_3D_Sphere * sphere;
/* … sphere created elsewhere */
Ovis_Decoration_Color_Set (sphere, prg_color_from_string ("blue"));
Errors
- Decoration is NIL.
Reference
- Use the function
Ovis_Decoration_Color_Get()to obtain the color of a decoration.