Difference between revisions of "TTFont.new"

(formatting)
 
Line 3: Line 3:
 
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
 
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
 
'''<translate>Class</translate>:''' [[Special:MyLanguage/TTFont|TTFont]]<br/>
 
'''<translate>Class</translate>:''' [[Special:MyLanguage/TTFont|TTFont]]<br/>
 +
 
=== <translate>Description</translate> ===
 
=== <translate>Description</translate> ===
<translate>
 
 
Creates a new [[Special:MyLanguage/TTFont|TTFont]] object.
 
Creates a new [[Special:MyLanguage/TTFont|TTFont]] object.
 +
<source lang="lua">
 +
TTFont.new(filename,size,text,filtering,outlineSize)
 +
</source>
  
 +
=== <translate>Parameters</translate> ===
 +
'''filename''': (string) <translate>The name of the TTF file to be loaded</translate> <br/>
 +
'''size''': (number) <translate>size of the font</translate> <br/>
 +
'''text''': (string, optional) <translate>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.</translate> <br/>
 +
'''filtering''': (boolean, default = false) or (positive number, default = 0) <translate>Whether or not the font texture is filtered</translate> '''optional'''<br/>
 +
'''outlineSize''': (number) <translate>If set, the font will be rendered with an outline of the given size</translate> '''optional'''<br/>
  
Starting from gideros 2017.9, 'text' optional parameter can be the 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.
  
 
Also, 2017.9 allows filename to be a table of several file names and associated size factor.  
 
Also, 2017.9 allows filename to be a table of several file names and associated size factor.  
 
Two forms are accepted:  
 
Two forms are accepted:  
 
+
<source lang="lua">{"font1.ttf","font2.ttf",..}</source>
<source lang="lua">{"font1.ttf","font2.ttf",..} </source>
 
 
 
 
or  
 
or  
 +
<source lang="lua">{{file="font1.ttf", sizeMult=1},{file="font2.ttf", sizeMult=1.1},...}</source>
  
<source lang="lua"> {{file="font1.ttf", sizeMult=1},{file="font2.ttf", sizeMult=1.1},...} </source>
+
Characters will be looked up in each file in sequence until a glyph is found.
 
 
Characters will be looked up in each file in sequence until a glyph is found.</translate>
 
 
 
 
 
<source lang="lua">
 
TTFont.new(filename,size,text,filtering,outlineSize)
 
</source>
 
=== <translate>Parameters</translate> ===
 
'''filename''': (string) <translate>The name of the TTF file to be loaded</translate> <br/>
 
'''size''': (number) <translate>size of the font</translate> <br/>
 
'''text''': (string, optional) <translate>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.</translate> <br/>
 
'''filtering''': (boolean, default = false) <translate>Whether or not the font texture is filtered</translate> '''optional'''<br/>
 
'''outlineSize''': (number) <translate>If set, the font will be rendered with an outline of the given size</translate> '''optional'''<br/>
 
  
 
{{TTFont}}
 
{{TTFont}}

Latest revision as of 17:12, 10 December 2019


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.