Difference between revisions of "love.graphics.newImageFont"

m
m
Line 1: Line 1:
 
{{newin|[[0.2.0]]|020|type=function}}
 
{{newin|[[0.2.0]]|020|type=function}}
 
Creates a new [[Font]] by loading a [[ImageFontFormat|specifically formatted]] image. There can be up to 256 glyphs.
 
Creates a new [[Font]] by loading a [[ImageFontFormat|specifically formatted]] image. There can be up to 256 glyphs.
 +
 +
In versions prior to [[0.9.0]], LÖVE expects ISO 8859-1 encoding for the glyphs string.
 +
 
{{newobjectnotice}}
 
{{newobjectnotice}}
{{notice|In versions prior to [[0.9.0]], LÖVE expects ISO 8859-1 encoding for the glyphs string.}}
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 10: Line 12:
 
=== Arguments ===
 
=== Arguments ===
 
{{param|string|filename|The filepath to the image file.}}
 
{{param|string|filename|The filepath to the image file.}}
{{param|string|glyphs|A string of the characters in the image in order from left to right.}}
 
=== Returns ===
 
{{param|Font|font|A Font object which can be used to draw text on screen.}}
 
== Function ==
 
=== Synopsis ===
 
<source lang="lua">
 
font = love.graphics.newImageFont( data, glyphs )
 
</source>
 
=== Arguments ===
 
{{param|Data|data|The encoded data to decode into image data.}}
 
 
{{param|string|glyphs|A string of the characters in the image in order from left to right.}}
 
{{param|string|glyphs|A string of the characters in the image in order from left to right.}}
 
=== Returns ===
 
=== Returns ===

Revision as of 08:36, 19 November 2015

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

Creates a new Font by loading a specifically formatted image. There can be up to 256 glyphs.

In versions prior to 0.9.0, LÖVE expects ISO 8859-1 encoding for the glyphs string.


O.png This function can be slow if it is called repeatedly, such as from love.update or love.draw. If you need to use a specific resource often, create it once and store it somewhere it can be reused!  



Function

Synopsis

font = love.graphics.newImageFont( filename, glyphs )

Arguments

string filename
The filepath to the image file.
string glyphs
A string of the characters in the image in order from left to right.

Returns

Font font
A Font object which can be used to draw text on screen.

Function

Synopsis

font = love.graphics.newImageFont( imageData, glyphs )

Arguments

ImageData imageData
The ImageData object to create the font from.
string glyphs
A string of the characters in the image in order from left to right.

Returns

Font font
A Font object which can be used to draw text on screen.

Function

Synopsis

font = love.graphics.newImageFont( image, glyphs )

Arguments

Image image
The Image object to create the font from.
string glyphs
A string of the characters in the image in order from left to right.

Returns

Font font
A Font object which can be used to draw text on screen.

See Also


Other Languages