Difference between revisions of "FontBase:getAdvanceX"
From GiderosMobile
| (13 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
'''Available since:''' Gideros 2011.6<br/> | '''Available since:''' Gideros 2011.6<br/> | ||
| + | '''Class:''' [[FontBase]]<br/> | ||
| + | |||
=== Description === | === Description === | ||
| − | + | Returns the width of the first ''size'' characters of ''text''. | |
| − | Returns the width of the first | + | <syntaxhighlight lang="lua"> |
| − | |||
| − | |||
| − | |||
| − | |||
| − | < | ||
(number) = FontBase:getAdvanceX(text,letterSpacing,size) | (number) = FontBase:getAdvanceX(text,letterSpacing,size) | ||
| − | </ | + | </syntaxhighlight> |
| + | |||
| + | 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. | ||
| + | |||
=== Parameters === | === Parameters === | ||
| − | '''text''': (string) | + | '''text''': (string) <br/> |
| − | '''letterSpacing''': (number, default = 0) | + | '''letterSpacing''': (number, default = 0) <br/> |
| − | '''size''': (number, optional) | + | '''size''': (number, optional) <br/> |
| + | |||
=== Return values === | === Return values === | ||
| − | '''Returns''' (number) | + | '''Returns''' (number) the width of the first size characters of text<br/> |
| + | |||
| + | {{FontBase}} | ||
Latest revision as of 18:12, 17 November 2023
Available since: Gideros 2011.6
Class: FontBase
Description
Returns the width of the first size characters of text.
(number) = FontBase:getAdvanceX(text,letterSpacing,size)
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.
Parameters
text: (string)
letterSpacing: (number, default = 0)
size: (number, optional)
Return values
Returns (number) the width of the first size characters of text
