Ovis_Shape_Pattern_Get()
Abstract
Returns the pattern of the Ovis decoration shape.
Syntax
Ovis_Shape_Pattern_Get (shape_ptr, pattern_ptr)
| Argument | Type | Description |
|---|---|---|
shape_ptr |
OvisT_Shape * |
Ovis shape |
pattern_ptr |
unsigned int * |
Pattern of the shape |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the decoration type supports patterns. Otherwise, it returns OvisC_Compcode_Failure.
Header
ovis_decoration.h
Details
This function returns the pattern of the decoration shape.
Example
OvisT_2D_Circle * circle;
unsigned int pattern;
/* … circle created previously */
Ovis_2D_Shape_Pattern_Get (circle, &pattern);
Errors
- Decoration type does not support patterns.
- Decoration is NIL.
- Return address for pattern value is NIL.
Reference
- Use the function Ovis_Shape_Pattern_Set() to modify the pattern.