Difference between revisions of "Text:getWidth"

(Created page)
 
m (Wording)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{newin|[[0.10.0]]|100|type=function}}
 
{{newin|[[0.10.0]]|100|type=function}}
Gets width in pixels of the text.
+
Gets the width of the text in pixels.
  
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
width = Text:geWidth( )
+
width = Text:getWidth( )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
Line 16: Line 16:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
width = Text:geWidth( index )
+
width = Text:getWidth( index )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
{{param|number|index|An index number returned by [[Text:add]] or [[Text:addf]].}}
 
{{param|number|index|An index number returned by [[Text:add]] or [[Text:addf]].}}
 
=== Returns ===
 
=== Returns ===
{{param|number|width|The width of the sub-string (before scaling and other transformations.)}}
+
{{param|number|width|The width of the sub-string (before scaling and other transformations).}}
  
 
== See Also ==
 
== See Also ==
 
* [[parent::Text]]
 
* [[parent::Text]]
* [[Text:setFont]]
+
* [[Text:getHeight]]
 +
* [[Text:set]]
 +
* [[Text:setf]]
 +
* [[Text:add]]
 +
* [[Text:addf]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Gets the width of the text.}}
 
{{#set:Description=Gets the width of the text.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|Text:getWidth}}
 
{{i18n|Text:getWidth}}

Latest revision as of 15:50, 24 November 2015

Available since LÖVE 0.10.0
This function is not supported in earlier versions.

Gets the width of the text in pixels.

Function

Synopsis

width = Text:getWidth( )

Arguments

None.

Returns

number width
The width of the text. If multiple sub-strings have been added with Text:add, the width of the last sub-string is returned.

Function

Gets the width of a specific sub-string that was previously added to the Text object.

Synopsis

width = Text:getWidth( index )

Arguments

number index
An index number returned by Text:add or Text:addf.

Returns

number width
The width of the sub-string (before scaling and other transformations).

See Also

Other Languages