Daikon Forge GUI  v1.0.16
Daikon Forge user interface library for Unity
 All Classes Functions Variables Enumerations Enumerator Properties Events Pages
dfFont Class Reference

Implements bitmapped-font functionality for text rendering More...

Inheritance diagram for dfFont:
dfFontBase

Detailed Description

Implements bitmapped-font functionality for text rendering

Nested Classes

class  BitmappedFontRenderer
 
class  GlyphDefinition
 
class  GlyphKerning
 

Public Member Functions

void AddKerning (int first, int second, int amount)
 
GlyphDefinition GetGlyph (char id)
 
int GetKerning (char previousChar, char currentChar)
 
override dfFontRendererBase ObtainRenderer ()
 

Properties

dfAtlas Atlas [get, set]
 The Texture Atlas which contains the rendered font as a bitmap sprite More...
 
bool Bold [get]
 Indicates whether this font definition is BOLD More...
 
int Count [get]
 Returns the number of glyphs defined in this instance More...
 
string FontFace [get]
 The name of the TrueType font represented by this instance More...
 
override int FontSize [get, set]
 The size (in pixels) of the TrueType font More...
 
List< GlyphDefinitionGlyphs [get]
 
override bool IsValid [get]
 Returns a value indicating whether the dfFont configuration is valid More...
 
bool Italic [get]
 Indicates whether this font definition is ITALIC More...
 
List< GlyphKerningKerningInfo [get]
 
override int LineHeight [get, set]
 The distance in pixels between each line of text More...
 
override Material Material [get, set]
 Gets or sets the Material that will be used to render text More...
 
int Outline [get]
 The thickness (in pixels) of the outline for each character. Will be 0 if there is no outline. More...
 
int[] Padding [get]
 The amount of padding (in pixels) surrounding each character (up, right, down, left) More...
 
int[] Spacing [get]
 The spacing for each character (horz, vert) More...
 
string Sprite [get, set]
 The sprite which contains the per-rendered font graphics More...
 
override Texture Texture [get]
 Returns a reference to the texture which contains the glyph images that will be used to render text More...
 
- Properties inherited from dfFontBase
abstract int FontSize [get, set]
 Returns the default font size, in pixels More...
 
abstract bool IsValid [get]
 Returns a value indicating whether the font configuration is valid More...
 
abstract int LineHeight [get, set]
 Returns the minimimum height (in pixels) of each line of rendered text More...
 
abstract UnityMaterial Material [get, set]
 Returns a reference to the material that will be used to render text More...
 
abstract Texture Texture [get]
 Returns a reference to the texture which contains the glyph images that will be used to render text More...
 

Member Function Documentation

void dfFont.AddKerning ( int  first,
int  second,
int  amount 
)
GlyphDefinition dfFont.GetGlyph ( char  id)
int dfFont.GetKerning ( char  previousChar,
char  currentChar 
)
override dfFontRendererBase dfFont.ObtainRenderer ( )
virtual

Implements dfFontBase.

Property Documentation

dfAtlas dfFont.Atlas
getset

The Texture Atlas which contains the rendered font as a bitmap sprite

bool dfFont.Bold
get

Indicates whether this font definition is BOLD

int dfFont.Count
get

Returns the number of glyphs defined in this instance

string dfFont.FontFace
get

The name of the TrueType font represented by this instance

override int dfFont.FontSize
getset

The size (in pixels) of the TrueType font

List<GlyphDefinition> dfFont.Glyphs
get
override bool dfFont.IsValid
get

Returns a value indicating whether the dfFont configuration is valid

bool dfFont.Italic
get

Indicates whether this font definition is ITALIC

List<GlyphKerning> dfFont.KerningInfo
get
override int dfFont.LineHeight
getset

The distance in pixels between each line of text

override Material dfFont.Material
getset

Gets or sets the Material that will be used to render text

int dfFont.Outline
get

The thickness (in pixels) of the outline for each character. Will be 0 if there is no outline.

int [] dfFont.Padding
get

The amount of padding (in pixels) surrounding each character (up, right, down, left)

int [] dfFont.Spacing
get

The spacing for each character (horz, vert)

string dfFont.Sprite
getset

The sprite which contains the per-rendered font graphics

override Texture dfFont.Texture
get

Returns a reference to the texture which contains the glyph images that will be used to render text