Ovis_Segmented_Line_Segment_Transparency_Get()
Abstract
Gets the transparency of a segment in a segmented line.
Syntax
Ovis_Segmented_Line_Segment_Transparency_Get (seg_line_ptr, index, transparency_ptr)
| Argument | Type | Description |
|---|---|---|
seg_line_ptr |
OvisT_Segmented_Line * |
The segmented line of interest. |
index |
unsigned char |
The index of the line segment of interest. |
transparency_ptr |
unsigned char * |
Area to be filled with the current transparency setting of the line segment. |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the decoration is a valid 2D or 3D segmented line; OvisC_Compcode_Failure otherwise.
Header
ovis_decoration.h
Details
This function returns the transparency of the specified line segment. Transparency is a value from 0 to 100, with 0 being completely opaque and 100 being completely transparent (invisible).
Example
OvisT_2D_Segmented_Line * line;
unsigned char transparency;
/* … .line created at some point */
Ovis_Segmented_Line_Segment_Transparency_Get (line, 0, &transparency);
Errors
- Decoration is not a segmented Line.
- Decoration is NIL.
- 0-based segment index (
<index>) is too large for<num>segments. - Can't use 'OVISC_SEGMENTED_LINE_ALL_SEGMENTS' index value.
- Return address for transparency value is NIL.
Reference
- Use the function Ovis_Segmented_Line_Segment_Transparency_Set() to specify the transparency of a segment.