org.jsfml.graphics

Class Font

java.lang.Object

org.jsfml.internal.SFMLNativeObject

org.jsfml.graphics.Font

All Implemented Interfaces:

ConstFont, Const

public class Font
extends SFMLNativeObject
implements ConstFont

Holds a character font for use in text displays.

Constructor Summary

Constructors

Constructor and Description
Font() Constructs a new font.

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.
void	loadFromFile(Path path) Attempts to load the texture from a file.
void	loadFromStream(InputStream in) Fully loads all available bytes from an InputStream and attempts to load the texture from it.
protected long	nativeCreate() Deprecated.
protected void	nativeDelete() Deprecated.
protected void	nativeSetExPtr() Deprecated.

Methods inherited from class org.jsfml.internal.SFMLNativeObject

finalize

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Font

public Font()

Constructs a new font.

Method Detail

nativeCreate

@Deprecated
protected long nativeCreate()

Deprecated.

Description copied from class: SFMLNativeObject

Creates a new native SFML object of the represented SFML class in the JVM memory heap.

Specified by:

nativeCreate in class SFMLNativeObject

Returns:

the pointer to the newly created native SFML object.

nativeSetExPtr

@Deprecated
protected void nativeSetExPtr()

Deprecated.

Description copied from class: SFMLNativeObject

This method is expected to fill the extra pointers array, if any.

It is called after the object has been created or wrapped around an already existing pointer.

Specified by:

nativeSetExPtr in class SFMLNativeObject

nativeDelete

@Deprecated
protected void nativeDelete()

Deprecated.

Description copied from class: SFMLNativeObject

Deletes the underlying SFML object.

Specified by:

nativeDelete in class SFMLNativeObject

loadFromStream

public void loadFromStream(InputStream in)
                    throws IOException

Fully loads all available bytes from an InputStream and attempts to load the texture from it.

Parameters:

in - the input stream to read from.

Throws:

IOException - in case an I/O error occurs.

loadFromFile

public void loadFromFile(Path path)
                  throws IOException

Attempts to load the texture from a file.

Parameters:

path - the path to the file to load the texture from.

Throws:

IOException - in case an I/O error occurs.

getGlyph

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

Description copied from interface: ConstFont

Gets a glyph information structure from the font.

Specified by:

getGlyph in interface ConstFont

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

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

Description copied from interface: ConstFont

Gets the kerning offset between two glyphs.

Specified by:

getKerning in interface ConstFont

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

public int getLineSpacing(int characterSize)

Description copied from interface: ConstFont

Gets the line spacing of the font.

Specified by:

getLineSpacing in interface ConstFont

Parameters:

characterSize - the character size in question.

Returns:

the line spacing of the font.

getTexture

public ConstTexture getTexture(int characterSize)

Description copied from interface: ConstFont

Retrieves the texture containing the font's glyphs.

The texture returned is immutable.

Specified by:

getTexture in interface ConstFont

Parameters:

characterSize - the character size in question.

Returns:

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