Ovis_2D_Text_Position_Set()
Abstract
Specifies the position of the 2D text.
Syntax
Ovis_2D_Text_Position_Set (text_ptr, position)
| Argument | Type | Description |
|---|---|---|
text_ptr |
OvisT_2D_Text * |
Text |
position |
OvisT_2D_Position |
Specifies the position of the text. X and Y values must be between –128 and 127, inclusive. |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the provided object is a valid 2D text pointer and the position is a valid 2D position. Otherwise, it returns OvisC_Compcode_Failure.
Header
ovis_decoration.h
Details
This function specifies the coordinates of the 2D text.
Example
OvisT_2D_Position pos;
OvisT_2D_Text * text;
/* … text created at some point with an initial position */
pos.x = 20;
pos.y = 0; /* middle of the window */
Ovis_2D_Text_Position_Set (text, pos);
Errors
- Invalid 2D position
<x,y>. 2D position values must be between –128 and 127. - Decoration is NIL.
- Decoration is not a 2D text.
Reference
- Use the function
Ovis_2D_Text_Position_Get()to obtain the position of the text.