Functions
Font.h File Reference
#include <SFML/Graphics/Export.h>
#include <SFML/Graphics/FontInfo.h>
#include <SFML/Graphics/Glyph.h>
#include <SFML/Graphics/Types.h>
#include <SFML/System/InputStream.h>
#include <stddef.h>

Go to the source code of this file.

Functions

CSFML_GRAPHICS_API sfFontsfFont_createFromFile (const char *filename)
 Create a new font from a file. More...
 
CSFML_GRAPHICS_API sfFontsfFont_createFromMemory (const void *data, size_t sizeInBytes)
 Create a new image font a file in memory. More...
 
CSFML_GRAPHICS_API sfFontsfFont_createFromStream (sfInputStream *stream)
 Create a new image font a custom stream. More...
 
CSFML_GRAPHICS_API sfFontsfFont_copy (const sfFont *font)
 Copy an existing font. More...
 
CSFML_GRAPHICS_API void sfFont_destroy (sfFont *font)
 Destroy an existing font. More...
 
CSFML_GRAPHICS_API sfGlyph sfFont_getGlyph (sfFont *font, sfUint32 codePoint, unsigned int characterSize, sfBool bold, float outlineThickness)
 Get a glyph in a font. More...
 
CSFML_GRAPHICS_API float sfFont_getKerning (sfFont *font, sfUint32 first, sfUint32 second, unsigned int characterSize)
 Get the kerning value corresponding to a given pair of characters in a font. More...
 
CSFML_GRAPHICS_API float sfFont_getLineSpacing (sfFont *font, unsigned int characterSize)
 Get the line spacing value. More...
 
CSFML_GRAPHICS_API float sfFont_getUnderlinePosition (sfFont *font, unsigned int characterSize)
 Get the position of the underline. More...
 
CSFML_GRAPHICS_API float sfFont_getUnderlineThickness (sfFont *font, unsigned int characterSize)
 Get the thickness of the underline. More...
 
CSFML_GRAPHICS_API const sfTexturesfFont_getTexture (sfFont *font, unsigned int characterSize)
 Get the texture containing the glyphs of a given size in a font. More...
 
CSFML_GRAPHICS_API sfFontInfo sfFont_getInfo (const sfFont *font)
 Get the font information. More...
 

Function Documentation

◆ sfFont_copy()

CSFML_GRAPHICS_API sfFont* sfFont_copy ( const sfFont font)

Copy an existing font.

Parameters
fontFont to copy
Returns
Copied object

◆ sfFont_createFromFile()

CSFML_GRAPHICS_API sfFont* sfFont_createFromFile ( const char *  filename)

Create a new font from a file.

Parameters
filenamePath of the font file to load
Returns
A new sfFont object, or NULL if it failed

◆ sfFont_createFromMemory()

CSFML_GRAPHICS_API sfFont* sfFont_createFromMemory ( const void *  data,
size_t  sizeInBytes 
)

Create a new image font a file in memory.

Parameters
dataPointer to the file data in memory
sizeInBytesSize of the data to load, in bytes
Returns
A new sfFont object, or NULL if it failed

◆ sfFont_createFromStream()

CSFML_GRAPHICS_API sfFont* sfFont_createFromStream ( sfInputStream stream)

Create a new image font a custom stream.

Parameters
streamSource stream to read from
Returns
A new sfFont object, or NULL if it failed

◆ sfFont_destroy()

CSFML_GRAPHICS_API void sfFont_destroy ( sfFont font)

Destroy an existing font.

Parameters
fontFont to delete

◆ sfFont_getGlyph()

CSFML_GRAPHICS_API sfGlyph sfFont_getGlyph ( sfFont font,
sfUint32  codePoint,
unsigned int  characterSize,
sfBool  bold,
float  outlineThickness 
)

Get a glyph in a font.

Parameters
fontSource font
codePointUnicode code point of the character to get
characterSizeCharacter size, in pixels
boldRetrieve the bold version or the regular one?
outlineThicknessThickness of outline (when != 0 the glyph will not be filled)
Returns
The corresponding glyph

◆ sfFont_getInfo()

CSFML_GRAPHICS_API sfFontInfo sfFont_getInfo ( const sfFont font)

Get the font information.

The returned structure will remain valid only if the font is still valid. If the font is invalid an invalid structure is returned.

Parameters
fontSource font
Returns
A structure that holds the font information

◆ sfFont_getKerning()

CSFML_GRAPHICS_API float sfFont_getKerning ( sfFont font,
sfUint32  first,
sfUint32  second,
unsigned int  characterSize 
)

Get the kerning value corresponding to a given pair of characters in a font.

Parameters
fontSource font
firstUnicode code point of the first character
secondUnicode code point of the second character
characterSizeCharacter size, in pixels
Returns
Kerning offset, in pixels

◆ sfFont_getLineSpacing()

CSFML_GRAPHICS_API float sfFont_getLineSpacing ( sfFont font,
unsigned int  characterSize 
)

Get the line spacing value.

Parameters
fontSource font
characterSizeCharacter size, in pixels
Returns
Line spacing, in pixels

◆ sfFont_getTexture()

CSFML_GRAPHICS_API const sfTexture* sfFont_getTexture ( sfFont font,
unsigned int  characterSize 
)

Get the texture containing the glyphs of a given size in a font.

Parameters
fontSource font
characterSizeCharacter size, in pixels
Returns
Read-only pointer to the texture

◆ sfFont_getUnderlinePosition()

CSFML_GRAPHICS_API float sfFont_getUnderlinePosition ( sfFont font,
unsigned int  characterSize 
)

Get the position of the underline.

Underline position is the vertical offset to apply between the baseline and the underline.

Parameters
fontSource font
characterSizeReference character size
Returns
Underline position, in pixels

◆ sfFont_getUnderlineThickness()

CSFML_GRAPHICS_API float sfFont_getUnderlineThickness ( sfFont font,
unsigned int  characterSize 
)

Get the thickness of the underline.

Underline thickness is the vertical size of the underline.

Parameters
fontSource font
characterSizeReference character size
Returns
Underline thickness, in pixels