Difference between revisions of "TTFont.new"
m (Text replacement - "</source>" to "</syntaxhighlight>") |
|||
| (16 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''Available since:''' Gideros 2011.6<br/> | '''Available since:''' Gideros 2011.6<br/> | ||
| + | '''Class:''' [[TTFont]]<br/> | ||
| + | |||
=== Description === | === Description === | ||
| − | + | Creates a new '''TTFont''' object. | |
| − | Creates a new | + | <syntaxhighlight lang="lua"> |
| − | + | TTFont.new(filename,size,text,filtering,outlineSize) | |
| − | + | </syntaxhighlight> | |
| − | + | ||
| − | |||
| − | |||
| − | < | ||
| − | |||
| − | </ | ||
=== Parameters === | === Parameters === | ||
| − | '''filename''': (string) | + | '''filename''': (string) the name of the TTF file to be loaded<br/> |
| − | '''size''': (number) | + | '''size''': (number) size of the font<br/> |
| − | '''text''': (string, optional) | + | '''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<br/> |
| − | '''filtering''': (boolean, default = false) | + | '''filtering''': (boolean, default = false) or (positive number, default = 0) whether or not the font texture is filtered '''optional'''<br/> |
| − | '''outlineSize''': (number) | + | '''outlineSize''': (number) if set, the font will be rendered with an outline of the given size '''optional'''<br/> |
| + | |||
| + | |||
| + | 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: | ||
| + | <syntaxhighlight lang="lua">{"font1.ttf","font2.ttf",..}</syntaxhighlight> | ||
| + | or | ||
| + | <syntaxhighlight lang="lua">{{file="font1.ttf", sizeMult=1},{file="font2.ttf", sizeMult=1.1},...}</syntaxhighlight> | ||
| + | |||
| + | Characters will be looked up in each file in sequence until a glyph is found. | ||
| + | |||
| + | {{TTFont}} | ||
Latest revision as of 14:33, 13 July 2023
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
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.
