NGUI: Next-Gen UI kit  3.7.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros
Public Member Functions | Properties | List of all members
BMFont Class Reference

BMFont reader. C# implementation of http://www.angelcode.com/products/bmfont/ More...

Public Member Functions

BMGlyph GetGlyph (int index, bool createIfMissing)
 Helper function that retrieves the specified glyph, creating it if necessary. More...
 
BMGlyph GetGlyph (int index)
 Retrieve the specified glyph, if it's present. More...
 
void Clear ()
 Clear the glyphs. More...
 
void Trim (int xMin, int yMin, int xMax, int yMax)
 Trim the glyphs, ensuring that they will never go past the specified bounds. More...
 

Properties

bool isValid [get]
 Whether the font can be used. More...
 
int charSize [get, set]
 Size of this font (for example 32 means 32 pixels). More...
 
int baseOffset [get, set]
 Base offset applied to characters. More...
 
int texWidth [get, set]
 Original width of the texture. More...
 
int texHeight [get, set]
 Original height of the texture. More...
 
int glyphCount [get]
 Number of valid glyphs. More...
 
string spriteName [get, set]
 Original name of the sprite that the font is expecting to find (usually the name of the texture). More...
 
List< BMGlyph > glyphs [get]
 Access to BMFont's entire set of glyphs. More...
 

Detailed Description

BMFont reader. C# implementation of http://www.angelcode.com/products/bmfont/

Member Function Documentation

void BMFont.Clear ( )

Clear the glyphs.

BMGlyph BMFont.GetGlyph ( int  index,
bool  createIfMissing 
)

Helper function that retrieves the specified glyph, creating it if necessary.

BMGlyph BMFont.GetGlyph ( int  index)

Retrieve the specified glyph, if it's present.

void BMFont.Trim ( int  xMin,
int  yMin,
int  xMax,
int  yMax 
)

Trim the glyphs, ensuring that they will never go past the specified bounds.

Property Documentation

int BMFont.baseOffset
getset

Base offset applied to characters.

int BMFont.charSize
getset

Size of this font (for example 32 means 32 pixels).

int BMFont.glyphCount
get

Number of valid glyphs.

List<BMGlyph> BMFont.glyphs
get

Access to BMFont's entire set of glyphs.

bool BMFont.isValid
get

Whether the font can be used.

string BMFont.spriteName
getset

Original name of the sprite that the font is expecting to find (usually the name of the texture).

int BMFont.texHeight
getset

Original height of the texture.

int BMFont.texWidth
getset

Original width of the texture.

The documentation for this class was generated from the following file: