Difference between revisions of "gc:drawString"

From Inspired-Lua Wiki
Jump to navigation Jump to search
(Redirected page to drawString)
 
Line 1: Line 1:
#REDIRECT [[drawString]]
+
'''drawString ''' is a function that is part of [[:Category:gc|gc]] (Graphics Context).
 +
 
 +
<br />
 +
== Syntax  ==
 +
gc:'''drawString'''(string, x, y [,position])
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Parameter !! Type !! Description
 +
|-
 +
| <u>string</u> || string || The text to display
 +
|-
 +
| <u>x</u> || number || the ''x'' coordinate of the beginning of the string. Relative to ''position''.
 +
|-
 +
| <u>y</u> || number || the ''y'' coordinate of the beginning of the string. Relative to ''position''.
 +
|-
 +
| <u>position</u> || string || the string’s anchor point. It can either be "baseline", “bottom”, “middle”, or “top”.
 +
|}
 +
== Example  ==
 +
<syntaxhighlight>gc:drawString("Hello World", 0, 0, "top")</syntaxhighlight>
 +
will display&nbsp;&nbsp;&nbsp; Hello World &nbsp;&nbsp;&nbsp; at the top-left part of the screen.
 +
 
 +
<br /><br />
 +
[[Category:gc]]

Revision as of 11:42, 24 May 2011

drawString is a function that is part of gc (Graphics Context).


Syntax

gc:drawString(string, x, y [,position])

Parameter Type Description
string string The text to display
x number the x coordinate of the beginning of the string. Relative to position.
y number the y coordinate of the beginning of the string. Relative to position.
position string the string’s anchor point. It can either be "baseline", “bottom”, “middle”, or “top”.

Example

gc:drawString("Hello World", 0, 0, "top")

will display    Hello World     at the top-left part of the screen.