TTFont.new: Difference between revisions

From GiderosMobile
No edit summary
No edit summary
 
Line 15: Line 15:
'''filtering''': (boolean, default = false) or (positive number, default = 0) whether or not the font texture is filtered '''optional'''<br/>
'''filtering''': (boolean, default = false) or (positive number, default = 0) whether or not the font texture is filtered '''optional'''<br/>
'''outlineSize''': (number) if set, the font will be rendered with an outline of the given size '''optional'''<br/>
'''outlineSize''': (number) if set, the font will be rendered with an outline of the given size '''optional'''<br/>
'''When you export to win32, your app may crash when you minimize its window. The fix is to cache your TTFont using: ''TTFont.new("font.ttf", 64, "")'''''


Starting from gideros 2017.9, 'text' optional parameter can be an empty string '''""''', in which case Gideros will automatically cache characters as they are used.
Starting from gideros 2017.9, 'text' optional parameter can be an empty string '''""''', in which case Gideros will automatically cache characters as they are used.
Line 32: Line 28:


=== Example ===
=== Example ===
'''Prevent crash on win32 export when minimizing window'''
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--local ttf = TTFont.new("fonts/Cabin-Italic-TTF.ttf", 64) -- this crashes Gideros
local ttf = TTFont.new("fonts/Cabin-Italic-TTF.ttf", 64)
local ttf = TTFont.new("fonts/Cabin-Italic-TTF.ttf", 64, "") -- this works fine :-)
local tf = TextField.new(ttf, "hello Gideros!")
local tf = TextField.new(ttf, "hello Gideros!")
tf:setPosition(4*32, 4*32)
tf:setPosition(4*32, 4*32)

Latest revision as of 21:37, 8 October 2026

Available since: Gideros 2011.6
Class: TTFont

Description

Creates a new TTFont object.

TTFont.new(filename,size,text,filtering,outlineSize)

Parameters

filename: (string) the name of the TTF file to be loaded. OTF files seem to be supported as well
size: (number) size of the font
text: (string, optional) if specified, TTFont caches the characters of specified text to speed up the rendering. If instead of specified symbols empty quotes "" are provided, then all font symbols are cached
filtering: (boolean, default = false) or (positive number, default = 0) whether or not the font texture is filtered optional
outlineSize: (number) if set, the font will be rendered with an outline of the given size optional

Starting from gideros 2017.9, 'text' optional parameter can be an empty string "", in which case Gideros will automatically cache characters as they are used.

Also, 2017.9 allows filename to be a table of several file names and associated size factor.

Two forms are accepted:

{"font1.ttf","font2.ttf",..}

or

{{file="font1.ttf", sizeMult=1},{file="font2.ttf", sizeMult=1.1},...}

Characters will be looked up in each file in sequence until a glyph is found.

Example

local ttf = TTFont.new("fonts/Cabin-Italic-TTF.ttf", 64)
local tf = TextField.new(ttf, "hello Gideros!")
tf:setPosition(4*32, 4*32)
stage:addChild(tf)