Ovis_Shape_Pattern_Set()
Abstract
Specifies the pattern of the Ovis decoration shape.
Syntax
Ovis_Shape_Pattern_Set (shape_ptr, pattern)
| Argument | Type | Description |
|---|---|---|
shape_ptr |
OvisT_Shape * |
Specifies the Ovis shape |
pattern |
unsigned int |
Specifies the pattern of the Ovis 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 specifies the pattern for the decoration shape.
Example
OvisT_2D_Circle *circle;
/* … circle created previously */
Ovis_Shape_Pattern_Set (circle, 0xF0F0F0F0);
Errors
- Decoration type does not support patterns.
- Decoration is NIL.
Reference
- Use the function Ovis_Shape_Pattern_Get() to obtain the current pattern.