Difference between revisions of "FontBase:getAdvanceX"
From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight") |
m (Text replacement - "</source>" to "</syntaxhighlight>") |
||
| Line 11: | Line 11: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
(number) = FontBase:getAdvanceX(text,letterSpacing,size) | (number) = FontBase:getAdvanceX(text,letterSpacing,size) | ||
| − | </ | + | </syntaxhighlight> |
=== Parameters === | === Parameters === | ||
Revision as of 14:29, 13 July 2023
Available since: Gideros 2011.6
Class: FontBase
Description
Returns the width of the first size characters of text.
Note that this value is not equal to the 3rd return value (width) of getBounds().
getBounds() returns a rectangle describing the bounds this string will cover whereas getAdvanceX() returns the distance to where the next string should be drawn.
(number) = FontBase:getAdvanceX(text,letterSpacing,size)
Parameters
text: (string)
letterSpacing: (number, default = 0)
size: (number, optional)
Return values
Returns (number) The width of the first size characters of text.
