Ovis_Decoration_Transparency_Get()
Abstract
Returns the transparency of the Ovis decoration.
Syntax
Ovis_Decoration_Transparency_Get (dec_ptr, transparency_ptr)
| Argument | Type | Description |
|---|---|---|
dec_ptr |
OvisT_Decoration * |
Decoration object |
transparency_ptr |
unsigned char * |
Specifies the value of the transparency. A value of 0 means it is completely opaque and a value of 100 means it is completely transparent (invisible) |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the transparency is obtained; OvisC_Compcode_Failure otherwise.
Header
ovis_decoration.h
Details
This function returns the transparency of the decoration. Transparency is a value from 0 to 100, with 0 being completely opaque and 100 being completely transparent (invisible).
Example
OvisT_3D_Cube * cube;
/* … cube created elsewhere */
Ovis_Decoration_Transparency_Get (cube, &transparency);
Errors
- Decoration is NIL.
- Return address for transparency value is NIL.
Reference
- Use the function Ovis_Decoration_Transparency_Set() to set the current transparency level.