Forge: Font Class Reference

Forge

- Main Page
- Namespaces
- Data Structures
- Files

- Data Structures
- Data Structure Index
- Class Hierarchy
- Data Fields

Public Member Functions
Font Class Reference

Font object is essentially a resource handler for the specific font you want to use. More...

`#include <font.h>`

## Public Member Functions
FGAPI | Font ()
| Creates Font object. More...
FGAPI | Font (const Font &other)
| Copy constructor for Font. More...
FGAPI | ~Font ()
| Font Destructor. More...
FGAPI void | loadFont (const char *const pFile, int pFontSize)
| Load a given font file. More...
FGAPI void | loadSystemFont (const char *const pName, int pFontSize)
| Load a system font based on the name. More...
FGAPI internal::_Font * | get () const
| Get handle for internal implementation of Font object. More...

## Detailed Description

Font object is essentially a resource handler for the specific font you want to use.

## Constructor & Destructor Documentation

FGAPI Font | ( |  | ) |

Creates Font object.

FGAPI Font | ( | const Font & | other | ) |

Copy constructor for Font.

Parameters

  [in] | other | is the Font object of which we make a copy of, this is not a deep copy.

FGAPI ~Font | ( |  | ) |

Font Destructor.

## Member Function Documentation

FGAPI internal::_Font* get | ( |  | ) | const

Get handle for internal implementation of Font object.

FGAPI void loadFont | ( | const char *const | pFile,
|  | int | pFontSize
| ) |  |

Load a given font file.

Parameters

  [in] | pFile | True Type Font file path
  [in] | pFontSize | the size of the font glyphs that will be created

FGAPI void loadSystemFont | ( | const char *const | pName,
|  | int | pFontSize
| ) |  |

Load a system font based on the name.

Parameters

  [in] | pName | True Type Font name
  [in] | pFontSize | the size of the font glyphs that will be created

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

- font.h