CompositeFont.new

From GiderosMobile
Revision as of 15:26, 13 July 2023 by Hgy29 (talk | contribs) (Text replacement - "<source" to "<syntaxhighlight")

Available since: Gideros 2019.1
Class: CompositeFont

Description

Creates a new CompositeFont object. <syntaxhighlight lang="lua"> CompositeFont.new(definition) </source>

Each layer of the composited font is defined by a table. The following fields are possible:

  • font: the font object to use for this layer (mandatory)
  • color: the color to use when rendering this layer
  • alpha: the alpha value to use with the color
  • x: the X offset to apply
  • y: the Y offset to apply
  • name: a name for this layer (since 2021.9)

Note: TTFont without any character list specification aren't supported in composite fonts.

Parameters

definition: (table) a list of layer definition tables

Example

Drawing a black outline: <syntaxhighlight lang="lua"> local str = "My Composite Font text" local nf = TTFont.new("fonts/Tahoma.ttf", 32, str, true) --Normal local of = TTFont.new("fonts/Tahoma.ttf", 32, str, true, 3) --Outlined local cf= CompositeFont.new{ -- *** PLEASE NOTICE THE CURLY BRACES { } INSTEAD OF ( ) *** { font=of, color=0x0 }, -- draw outline in black { font=nf, x=1, y=2 }, -- draw normal text with an offset } local tf = TextField.new(cf, str) tf:setTextColor(0xff0000) tf:setPosition(16, 64) stage:addChild(tf) </source>