Difference between revisions of "love.graphics.newImageFont"

(ISO 8859-1 notice.)
Line 6: Line 6:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
font = love.graphics.newImageFont( image, glyphs )
+
font = love.graphics.newImageFont( filename, glyphs )
 +
</source>
 +
=== Arguments ===
 +
{{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( file, glyphs )
 +
</source>
 +
=== Arguments ===
 +
{{param|File|file|A File pointing to an image.}}
 +
{{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>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|Image|image|The Image object to create the font from.}}
+
{{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 ===
 
{{param|Font|font|A Font object which can be used to draw text on screen.}}
 
{{param|Font|font|A Font object which can be used to draw text on screen.}}
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
font = love.graphics.newImageFont( filename, glyphs )
+
font = love.graphics.newImageFont( imageData, glyphs )
 +
</source>
 +
=== Arguments ===
 +
{{param|ImageData|imageData|The ImageData object to create the font from.}}
 +
{{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( image, glyphs )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|string|filename|The filepath to the image file.}}
+
{{param|Image|image|The Image object to create the font from.}}
 
{{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 00:54, 5 October 2012

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.

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!  



O.png LÖVE expects ISO 8859-1 encoding for the glyphs string.  


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( file, glyphs )

Arguments

File file
A File pointing to an image.
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( data, glyphs )

Arguments

Data data
The encoded data to decode into image data.
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