Documentation of SFML 1.6

sf::Font Class Reference

Font is the low-level class for loading and manipulating character fonts. More...

#include <Font.hpp>

Inheritance diagram for sf::Font:
sf::Resource< Font >

Public Member Functions

 Font ()
 Default constructor.
 
bool LoadFromFile (const std::string &Filename, unsigned int CharSize=30, const Unicode::Text &Charset=ourDefaultCharset)
 Load the font from a file.
 
bool LoadFromMemory (const char *Data, std::size_t SizeInBytes, unsigned int CharSize=30, const Unicode::Text &Charset=ourDefaultCharset)
 Load the font from a file in memory.
 
unsigned int GetCharacterSize () const
 Get the base size of characters in the font; All glyphs dimensions are based on this value.
 
const GlyphGetGlyph (Uint32 CodePoint) const
 Get the description of a glyph (character) given by its unicode value.
 
const ImageGetImage () const
 Get the image containing the rendered characters (glyphs)
 

Static Public Member Functions

static const FontGetDefaultFont ()
 Get the SFML default built-in font (Arial)
 

Detailed Description

Font is the low-level class for loading and manipulating character fonts.

This class is meant to be used by sf::String

Definition at line 54 of file Font.hpp.

Constructor & Destructor Documentation

sf::Font::Font ( )

Default constructor.

Member Function Documentation

unsigned int sf::Font::GetCharacterSize ( ) const

Get the base size of characters in the font; All glyphs dimensions are based on this value.

Returns
Base size of characters
static const Font& sf::Font::GetDefaultFont ( )
static

Get the SFML default built-in font (Arial)

Returns
Instance of the default font
const Glyph& sf::Font::GetGlyph ( Uint32  CodePoint) const

Get the description of a glyph (character) given by its unicode value.

Parameters
CodePoint: Unicode value of the character to get
Returns
Glyph's visual settings, or an invalid glyph if character not found
const Image& sf::Font::GetImage ( ) const

Get the image containing the rendered characters (glyphs)

Returns
Image containing glyphs
bool sf::Font::LoadFromFile ( const std::string &  Filename,
unsigned int  CharSize = 30,
const Unicode::Text Charset = ourDefaultCharset 
)

Load the font from a file.

Parameters
Filename: Font file to load
CharSize: Size of characters in bitmap - the bigger, the higher quality (30 by default)
Charset: Characters set to generate (by default, contains the ISO-8859-1 printable characters)
Returns
True if loading was successful
bool sf::Font::LoadFromMemory ( const char *  Data,
std::size_t  SizeInBytes,
unsigned int  CharSize = 30,
const Unicode::Text Charset = ourDefaultCharset 
)

Load the font from a file in memory.

Parameters
Data: Pointer to the data to load
SizeInBytes: Size of the data, in bytes
CharSize: Size of characters in bitmap - the bigger, the higher quality (30 by default)
Charset: Characters set to generate (by default, contains the ISO-8859-1 printable characters)
Returns
True if loading was successful

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