org.jsfml.graphics

Interface ConstFont

All Superinterfaces:

Const

All Known Implementing Classes:

Font

public interface ConstFont
extends Const

Interface for read-only fonts.

It provides methods to can gain information from a font, but none to modify it in any way.

Note that this interface is expected to be implemented by a Font. It is not recommended to be implemented outside of the JSFML API.

See Also:

Const

Method Summary

Methods

Modifier and Type	Method and Description
Glyph	getGlyph(int unicode, int characterSize, boolean bold) Gets a glyph information structure from the font.
int	getKerning(int first, int second, int characterSize) Gets the kerning offset between two glyphs.
int	getLineSpacing(int characterSize) Gets the line spacing of the font.
ConstTexture	getTexture(int characterSize) Retrieves the texture containing the font's glyphs.

Method Detail

getGlyph

Glyph getGlyph(int unicode,
             int characterSize,
             boolean bold)

Gets a glyph information structure from the font.

Parameters:

unicode - the unicode (UTF-32) of the character to retrieve the glyph for.

characterSize - the character size in question.

bold - true if the bold glyph version should be returned, false for the regular version.

Returns:

the Glyph representing the given unicode character.

getKerning

int getKerning(int first,
             int second,
             int characterSize)

Gets the kerning offset between two glyphs.

Parameters:

first - the unicode (UTF-32) of the first character.

second - the unicode (UTF-32) of the second character.

characterSize - the character size in question.

Returns:

the kerning offset between the two glyphs.

getLineSpacing

int getLineSpacing(int characterSize)

Gets the line spacing of the font.

Parameters:

characterSize - the character size in question.

Returns:

the line spacing of the font.

getTexture

ConstTexture getTexture(int characterSize)

Retrieves the texture containing the font's glyphs.

The texture returned is immutable.

Parameters:

characterSize - the character size in question.

Returns:

the texture containing the font's glyphs of the character given size.