ofTrueTypeFontfile

The ofTrueTypeFont class provides an interface to load fonts into openFrameworks. The fonts are converted to textures, and can be drawn on screen. There are some options when you load the font - what size the font is rendered at, whether or not it is anti-aliased, and whether the font object will be the full character set or a subset (i.e., extended ASCII, which can include diacritics like umlauts, or ASCII). The default is anti-aliased, non-full character set. The library uses freetype, which has certain patent problems in regards to true type hinting, especially at small sizes, so non-anti-aliased type doesn't always render beautifully. But we find it quite adequate, and at larger sizes it seems to works well.

Fonts

OF_TTF_SANS variable

const string OF_TTF_SANS

undefined

OF_TTF_SERIF variable

const string OF_TTF_SERIF

undefined

OF_TTF_MONO variable

const string OF_TTF_MONO

undefined

ofTrueTypeFontclass

Load Font

load ()

bool load(string filename, int fontsize, bool _bAntiAliased=true, bool _bFullCharacterSet=false, bool makeContours=false, float simplifyAmt=0.3, int dpi=0)

Loads the font specified by filename, allows you to control size, aliasing, and other parameters.

loads a font, and allows you to set the following parameters: the filename, the size, if the font is anti-aliased, if it has a full character set, if you need it to have contours (for getStringPoints) and parameters that control the simplification amount for those contours and the dpi of the font.

default (without dpi), non-full char set, anti aliased, 96 dpi

Parameters

filename	The name of the font file to load.
fontsize	The size in pixels to load the font.
_bAntiAliased	true if the font should be anti-aliased.
_bFullCharacterSet	true if the full character set should be cached.
makeControus	true if the vector contours should be cached.
simplifyAmt	the amount to simplify the vector contours. Larger number means more simplified.
dpi	the dots per inch used to specify rendering size.

Returns: true if the font was loaded correctly.

loadFont () Use load instead

bool loadFont(string filename, int fontsize, bool _bAntiAliased=true, bool _bFullCharacterSet=false, bool makeContours=false, float simplifyAmt=0.3, int dpi=0)

isLoaded ()

bool isLoaded() const

Has the font been loaded successfully?

Returns: true if the font was loaded.

Font Settings

isAntiAliased ()

bool isAntiAliased() const

Is the font anti-aliased?

Returns: true if the font was set to be anti-aliased.

hasFullCharacterSet ()

bool hasFullCharacterSet() const

Does the font have a full character set?

Returns: true if the font was allocated with a full character set.

getNumCharacters ()

int getNumCharacters()

Get the number characters in the loaded character set.

If you allocate the font using different parameters, you can load in partial and full character sets, this helps you know how many characters it can represent.

Returns: Number of characters in loaded character set.

getEncoding ()

ofTextEncoding getEncoding() const

Get the current font encoding.

This is set by ofTrueTypeFont::setEncoding() to either OF_ENCODING_UTF8 or OF_ENCODING_ISO_8859_15. OF_ENCODING_ISO_8859_15 is for an 8-bit single-byte coded graphic character sets, like ASCII while OF_ENCODING_UTF8 is a variable-width encoding that can represent every character in the Unicode character set.

Returns: encoding used by the font object.

setEncoding ()

void setEncoding(ofTextEncoding encoding)

Sets the current font encoding.

Can be set to either OF_ENCODING_UTF8 or OF_ENCODING_ISO_8859_15. OF_ENCODING_ISO_8859_15 is for an 8-bit single-byte coded graphic character sets, like ASCII while OF_ENCODING_UTF8 is a variable-width encoding that can represent every character in the Unicode character set. This function is useful if you are trying to draw unicode strings.

Parameters

encoding	The encoding used by the font object, either `OF_ENCODING_UTF8 or
OF_ENCODING_ISO_8859_15

setGlobalDpi ()

void setGlobalDpi(int newDpi)

The descender is the vertical distance from the baseline to the lowest "character" coordinate. The meaning of "character" coordinate depends on the font. Some fonts take accents into account, others do not, and still others define it simply to be the lowest coordinate over all glyphs. This value will be negative for descenders below the baseline (which is typical).

Returns: Returns font descender height in pixels.

getGlyphBBox ()

ofRectangle getGlyphBBox() const

Get the global bounding box for this font.

The global bounding box is the rectangle inside of which all glyphs in the font can fit. Glyphs are drawn starting from (0,0) in the returned box (though note that the box can extend in any direction out from the origin).

Returns: Returns font descender height in pixels.

getLetterSpacing ()

float getLetterSpacing() const

Returns letter spacing of font object.

You can control this by the ofTrueTypeFont::setLetterSpacing() function. 1.0 = default spacing, less then 1.0 would be tighter spacing, greater then 1.0 would be wider spacing.

Returns: Returns letter spacing of font object.

setLetterSpacing ()

void setLetterSpacing(float spacing)

Sets the letter spacing of the font object.

1.0 = default spacing, less then 1.0 would be tighter spacing, greater then 1.0 would be wider spacing.

Parameters

spacing Spacing of font object.

getSpaceSize ()

float getSpaceSize() const

Returns a variable that represents how wide spaces are.

It's a scalar for the width of the letter 'p', so 1.0 means that a space will be the size of the lower case 'p' of that font. 2.0 means that it's 2 times the size of the lower case 'p', etc.

Returns: Returns a variable that represents how wide spaces are.

setSpaceSize ()

void setSpaceSize(float size)

Sets the size of the space ' ' character.

This number, which defaults to 1.0, scales the width of the letter 'p' for the space.

Parameters

size	Scales the width of the letter 'p' for the space.

stringWidth ()

float stringWidth(string s) const

Returns the string width.

This is essentially the width component of the ofTrueTypeFont::getStringBoundingBox() rectangle.

Parameters

s	The string to get the width of.

Returns: Returns the string width.

stringHeight ()

float stringHeight(string s) const

Returns the string height.

This is essentially the height component of the ofTrueTypeFont::getStringBoundingBox() rectangle.

Parameters

s	The string to get the height of.

Returns: Returns the string height.

getStringBoundingBox ()

ofRectangle getStringBoundingBox(string s, float x, float y) const

Returns the bounding box of a string as a rectangle.

Parameters

s	The string to get bounding box of.
x	X position of returned rectangle.
y	Y position of returned rectangle.

Returns: Returns the bounding box of a string as a rectangle.

Drawing

drawString ()

void drawString(string s, float x, float y) const

Draw a string s at position x,y.

Parameters

s	String to draw
x	X position of string
y	Y position of string

drawStringAsShapes ()

void drawStringAsShapes(string s, float x, float y) const

Draws the string as if it was geometrical shapes.

Uses the information contained in ofTTFContour and ofTTFCharacter.

Parameters

x	X position of shapes
y	Y position of shapes

getNumCharacters ()

int getNumCharacters() const

Get the num chars in the loaded character set.

If you allocate the font using different paramters, you can load in partial and full character sets, this helps you know how many characters it can represent.

Returns: Number of characters in loaded character set.

getCharacterAsPoints ()

ofTTFCharacter getCharacterAsPoints(int character, bool vflip=true, bool filled=true) const

getStringAsPoints ()

vector< ofTTFCharacter > getStringAsPoints(string str, bool vflip=true, bool filled=true) const

getStringMesh ()

ofMesh getStringMesh(string s, float x, float y, bool vflip=true) const

getFontTexture ()

ofTexture getFontTexture() const

bind ()

void bind()

unbind ()

void unbind()

Functions

ofTrueTypeFont ()

ofTrueTypeFont()

~ofTrueTypeFont ()

~ofTrueTypeFont()

Friends

ofExitCallback friend

friend void ofExitCallback()

ofTrueTypeFontfile

Fonts

ofTrueTypeFontclass

Load Font

Font Settings

Font Size

Drawing

Functions

Friends