Font type, includes texture and charSet array data. More...

#include <Font.hpp>

Public Member Functions
	Font ()
	Retrieves the default Font. More...

	Font (const ::Font &font)

	Font (const ::Image &image, ::Color key, int firstChar)
	Loads a Font from the given image with a color key. More...

	Font (const Font &)=delete

	Font (const std::string_view fileName)
	Loads a Font from the given file. More...

	Font (const std::string_view fileName, int fontSize, int *fontChars=0, int charCount=0)
	Loads a Font from the given file, with generation parameters. More...

	Font (const std::string_view fileName, int fontSize, std::span< int > fontChars)
	Loads a Font from the given file, with generation parameters. More...

	Font (const std::string_view fileType, const unsigned char fileData, int dataSize, int fontSize, int fontChars, int charsCount)
	Loads a font from memory, based on the given file type and file data. More...

	Font (const std::string_view fileType, const unsigned char *fileData, int dataSize, int fontSize, std::span< int > fontChars)

	Font (Font &&other) noexcept

	Font (int baseSize, int glyphCount, int glyphPadding, ::Texture2D texture, ::Rectangle recs=nullptr, ::GlyphInfo glyphs=nullptr)

	Font (int baseSize, int glyphPadding, ::Texture2D texture, std::span<::Rectangle > recs={}, std::span<::GlyphInfo > glyphs={})

void	DrawText (const char *text, ::Vector2 position, ::Vector2 origin, Degree rotation, float fontSize, float spacing, ::Color tint=WHITE) const

void	DrawText (const char *text, ::Vector2 position, float fontSize, float spacing, ::Color tint=WHITE) const
	Draw text using font and additional parameters. More...

void	DrawText (const char *text, int posX, int posY, float fontSize, float spacing, ::Color tint=WHITE) const
	Draw text using font and additional parameters. More...

void	DrawText (const int *codepoints, int count, ::Vector2 position, float fontSize, float spacing, ::Color tint={255, 255, 255, 255}) const
	Draw multiple character (codepoint) More...

void	DrawText (const std::string_view text, ::Vector2 position, ::Vector2 origin, Degree rotation, float fontSize, float spacing, ::Color tint=WHITE) const

void	DrawText (const std::string_view text, ::Vector2 position, float fontSize, float spacing, ::Color tint=WHITE) const
	Draw text using font and additional parameters. More...

void	DrawText (const std::string_view text, int posX, int posY, float fontSize, float spacing, ::Color tint=WHITE) const
	Draw text using font and additional parameters. More...

void	DrawText (int codepoint, ::Vector2 position, float fontSize, ::Color tint={255, 255, 255, 255}) const
	Draw one character (codepoint) More...

void	DrawText (std::span< const int > codepoints, ::Vector2 position, float fontSize, float spacing, ::Color tint={ 255, 255, 255, 255 }) const
	Draw multiple character (codepoint) More...

int	GetBaseSize () const
	Retrieves the baseSize value for the object. More...

int	GetGlyphCount () const
	Retrieves the glyphCount value for the object. More...

int	GetGlyphIndex (int character) const
	Get index position for a unicode character on font. More...

int	GetGlyphPadding () const
	Retrieves the glyphPadding value for the object. More...

::GlyphInfo *	GetGlyphs () const
	Retrieves the glyphs value for the object. More...

::Rectangle *	GetRecs () const
	Retrieves the recs value for the object. More...

TextureUnmanaged	GetTexture ()
	Get the texture atlas containing the glyphs. More...

::Image	ImageText (const char *text, float fontSize, float spacing, ::Color tint) const
	Create an image from text (custom sprite font) More...

::Image	ImageText (const std::string_view text, float fontSize, float spacing, ::Color tint) const
	Create an image from text (custom sprite font) More...

bool	IsValid () const
	Returns if the font is ready to be used. More...

void	Load (const ::Image &image, ::Color key, int firstChar)

void	Load (const std::string_view fileName)
	Loads a font from a given file. More...

void	Load (const std::string_view fileName, int fontSize, int *fontChars, int charCount)
	Loads a font from a given file with generation parameters. More...

void	Load (const std::string_view fileName, int fontSize, std::span< int > fontChars)

void	Load (const std::string_view fileType, const unsigned char fileData, int dataSize, int fontSize, int fontChars, int charsCount)

void	Load (const std::string_view fileType, const unsigned char *fileData, int dataSize, int fontSize, std::span< int > fontChars)

void	Load (const std::string_view fileType, std::span< unsigned char > fileData, int fontSize, int *fontChars, int charsCount)

void	Load (const std::string_view fileType, std::span< unsigned char > fileData, int fontSize, std::span< int > fontChars)

Vector2	MeasureText (const char *text, float fontSize, float spacing) const
	Measure string size for Font. More...

Vector2	MeasureText (const std::string_view text, float fontSize, float spacing) const
	Measure string size for Font. More...

Font &	operator= (const ::Font &font)

Font &	operator= (const Font &)=delete

Font &	operator= (Font &&other) noexcept

void	SetTexture (const ::Texture &newTexture)
	Set the texture atlas containing the glyphs. More...

void	Unload ()

Protected Member Functions
void	set (const ::Font &font)

Detailed Description

Font type, includes texture and charSet array data.

Definition at line 18 of file Font.hpp.

Constructor & Destructor Documentation

◆ Font() [1/11]

raylib::Font::Font	(	int	baseSize,
		int	glyphCount,
		int	glyphPadding,
		::Texture2D	texture,
		::Rectangle *	recs = `nullptr`,
		::GlyphInfo *	glyphs = `nullptr`
	)

inline

Definition at line 20 of file Font.hpp.

◆ Font() [2/11]

raylib::Font::Font	(	int	baseSize,
		int	glyphPadding,
		::Texture2D	texture,
		std::span<::Rectangle >	recs = `{}`,
		std::span<::GlyphInfo >	glyphs = `{}`
	)

inline

Definition at line 31 of file Font.hpp.

◆ Font() [3/11]

raylib::Font::Font ( )

inline

Retrieves the default Font.

Definition at line 42 of file Font.hpp.

◆ Font() [4/11]

raylib::Font::Font ( const ::Font & font )

inline

Definition at line 44 of file Font.hpp.

◆ Font() [5/11]

raylib::Font::Font ( const std::string_view fileName )

inline

Loads a Font from the given file.

Parameters

fileName The file name of the font to load.

Exceptions

raylib::RaylibException Throws if the given font failed to initialize.

Definition at line 53 of file Font.hpp.

References Load().

◆ Font() [6/11]

raylib::Font::Font	(	const std::string_view	fileName,
		int	fontSize,
		int *	fontChars = `0`,
		int	charCount = `0`
	)

inline

Loads a Font from the given file, with generation parameters.

Parameters

fileName The file name of the font to load.

Exceptions

raylib::RaylibException Throws if the given font failed to initialize.

See also: LoadFontEx

Definition at line 66 of file Font.hpp.

References Load().

◆ Font() [7/11]

raylib::Font::Font	(	const std::string_view	fileName,
		int	fontSize,
		std::span< int >	fontChars
	)

inline

Loads a Font from the given file, with generation parameters.

Parameters

fileName The file name of the font to load.

Exceptions

raylib::RaylibException Throws if the given font failed to initialize.

See also: LoadFontEx

Definition at line 79 of file Font.hpp.

References Load().

◆ Font() [8/11]

raylib::Font::Font	(	const ::Image &	image,
		::Color	key,
		int	firstChar
	)

inline

Loads a Font from the given image with a color key.

Parameters

image The image to load the fond from.

Exceptions

raylib::RaylibException Throws if the given font failed to initialize.

See also: ::LoadFontFromImage()

Definition at line 92 of file Font.hpp.

References Load().

◆ Font() [9/11]

raylib::Font::Font	(	const std::string_view	fileType,
		const unsigned char *	fileData,
		int	dataSize,
		int	fontSize,
		int *	fontChars,
		int	charsCount
	)

inline

Loads a font from memory, based on the given file type and file data.

Exceptions

raylib::RaylibException Throws if the given font failed to initialize.

See also: ::LoadFontFromMemory()

Definition at line 101 of file Font.hpp.

References Load().

◆ Font() [10/11]

raylib::Font::Font	(	const std::string_view	fileType,
		const unsigned char *	fileData,
		int	dataSize,
		int	fontSize,
		std::span< int >	fontChars
	)

inline

Definition at line 106 of file Font.hpp.

◆ Font() [11/11]

raylib::Font::Font ( Font && other )

inlinenoexcept

Definition at line 113 of file Font.hpp.

◆ ~Font()

raylib::Font::~Font ( )

inline

Definition at line 124 of file Font.hpp.

Member Function Documentation

◆ DrawText() [1/9]

void raylib::Font::DrawText	(	const char *	text,
		::Vector2	position,
		::Vector2	origin,
		Degree	rotation,
		float	fontSize,
		float	spacing,
		::Color	tint = `WHITE`
	)		const

inline

Definition at line 296 of file Font.hpp.

◆ DrawText() [2/9]

void raylib::Font::DrawText	(	const char *	text,
		::Vector2	position,
		float	fontSize,
		float	spacing,
		::Color	tint = `WHITE`
	)		const

inline

Draw text using font and additional parameters.

Definition at line 267 of file Font.hpp.

References raylib::DrawTextEx().

◆ DrawText() [3/9]

void raylib::Font::DrawText	(	const char *	text,
		int	posX,
		int	posY,
		float	fontSize,
		float	spacing,
		::Color	tint = `WHITE`
	)		const

inline

Draw text using font and additional parameters.

Definition at line 282 of file Font.hpp.

References raylib::DrawTextEx().

◆ DrawText() [4/9]

void raylib::Font::DrawText	(	const int *	codepoints,
		int	count,
		::Vector2	position,
		float	fontSize,
		float	spacing,
		::Color	tint = `{255, 255, 255, 255}`
	)		const

inline

Draw multiple character (codepoint)

Definition at line 334 of file Font.hpp.

◆ DrawText() [5/9]

void raylib::Font::DrawText	(	const std::string_view	text,
		::Vector2	position,
		::Vector2	origin,
		Degree	rotation,
		float	fontSize,
		float	spacing,
		::Color	tint = `WHITE`
	)		const

inline

Definition at line 310 of file Font.hpp.

◆ DrawText() [6/9]

void raylib::Font::DrawText	(	const std::string_view	text,
		::Vector2	position,
		float	fontSize,
		float	spacing,
		::Color	tint = `WHITE`
	)		const

inline

Draw text using font and additional parameters.

Definition at line 274 of file Font.hpp.

References raylib::DrawTextEx().

◆ DrawText() [7/9]

void raylib::Font::DrawText	(	const std::string_view	text,
		int	posX,
		int	posY,
		float	fontSize,
		float	spacing,
		::Color	tint = `WHITE`
	)		const

inline

Draw text using font and additional parameters.

Definition at line 289 of file Font.hpp.

References raylib::DrawTextEx().

◆ DrawText() [8/9]

void raylib::Font::DrawText	(	int	codepoint,
		::Vector2	position,
		float	fontSize,
		::Color	tint = `{255, 255, 255, 255}`
	)		const

inline

Draw one character (codepoint)

Definition at line 327 of file Font.hpp.

◆ DrawText() [9/9]

void raylib::Font::DrawText	(	std::span< const int >	codepoints,
		::Vector2	position,
		float	fontSize,
		float	spacing,
		::Color	tint = `{ 255, 255, 255, 255 }`
	)		const

inline

Draw multiple character (codepoint)

Definition at line 347 of file Font.hpp.

◆ GetBaseSize()

int raylib::Font::GetBaseSize ( ) const

inline

Retrieves the baseSize value for the object.

Returns: The baseSize value of the object.

Definition at line 134 of file Font.hpp.

◆ GetGlyphCount()

int raylib::Font::GetGlyphCount ( ) const

inline

Retrieves the glyphCount value for the object.

Returns: The glyphCount value of the object.

Definition at line 135 of file Font.hpp.

◆ GetGlyphIndex()

int raylib::Font::GetGlyphIndex ( int character ) const

inline

Get index position for a unicode character on font.

Definition at line 373 of file Font.hpp.

◆ GetGlyphPadding()

int raylib::Font::GetGlyphPadding ( ) const

inline

Retrieves the glyphPadding value for the object.

Returns: The glyphPadding value of the object.

Definition at line 136 of file Font.hpp.

◆ GetGlyphs()

::GlyphInfo * raylib::Font::GetGlyphs ( ) const

inline

Retrieves the glyphs value for the object.

Returns: The glyphs value of the object.

Definition at line 138 of file Font.hpp.

◆ GetRecs()

::Rectangle * raylib::Font::GetRecs ( ) const

inline

Retrieves the recs value for the object.

Returns: The recs value of the object.

Definition at line 137 of file Font.hpp.

◆ GetTexture()

TextureUnmanaged raylib::Font::GetTexture ( )

inline

Get the texture atlas containing the glyphs.

Definition at line 143 of file Font.hpp.

◆ ImageText() [1/2]

::Image raylib::Font::ImageText	(	const char *	text,
		float	fontSize,
		float	spacing,
		::Color	tint
	)		const

inline

Create an image from text (custom sprite font)

Definition at line 378 of file Font.hpp.

◆ ImageText() [2/2]

::Image raylib::Font::ImageText	(	const std::string_view	text,
		float	fontSize,
		float	spacing,
		::Color	tint
	)		const

inline

Create an image from text (custom sprite font)

Definition at line 385 of file Font.hpp.

◆ IsValid()

bool raylib::Font::IsValid ( ) const

inline

Returns if the font is ready to be used.

Definition at line 262 of file Font.hpp.

Referenced by Load().

◆ Load() [1/8]

void raylib::Font::Load	(	const ::Image &	image,
		::Color	key,
		int	firstChar
	)

inline

Definition at line 216 of file Font.hpp.

◆ Load() [2/8]

void raylib::Font::Load ( const std::string_view fileName )

inline

Loads a font from a given file.

Parameters

fileName The filename of the font to load.

Exceptions

raylib::RaylibException Throws if the given font failed to initialize.

See also: LoadFont()

Definition at line 185 of file Font.hpp.

References IsValid(), and raylib::LoadFont().

Referenced by Font().

◆ Load() [3/8]

void raylib::Font::Load	(	const std::string_view	fileName,
		int	fontSize,
		int *	fontChars,
		int	charCount
	)

inline

Loads a font from a given file with generation parameters.

Parameters

fileName	The filename of the font to load.
fontSize	The desired size of the font.

Exceptions

raylib::RaylibException Throws if the given font failed to initialize.

See also: LoadFontEx()

Definition at line 202 of file Font.hpp.

References IsValid(), and raylib::LoadFontEx().

◆ Load() [4/8]

void raylib::Font::Load	(	const std::string_view	fileName,
		int	fontSize,
		std::span< int >	fontChars
	)

inline

Definition at line 209 of file Font.hpp.

◆ Load() [5/8]

void raylib::Font::Load	(	const std::string_view	fileType,
		const unsigned char *	fileData,
		int	dataSize,
		int	fontSize,
		int *	fontChars,
		int	charsCount
	)

inline

Definition at line 223 of file Font.hpp.

◆ Load() [6/8]

void raylib::Font::Load	(	const std::string_view	fileType,
		const unsigned char *	fileData,
		int	dataSize,
		int	fontSize,
		std::span< int >	fontChars
	)

inline

Definition at line 232 of file Font.hpp.

◆ Load() [7/8]

void raylib::Font::Load	(	const std::string_view	fileType,
		std::span< unsigned char >	fileData,
		int	fontSize,
		int *	fontChars,
		int	charsCount
	)

inline

Definition at line 241 of file Font.hpp.

◆ Load() [8/8]

void raylib::Font::Load	(	const std::string_view	fileType,
		std::span< unsigned char >	fileData,
		int	fontSize,
		std::span< int >	fontChars
	)

inline

Definition at line 250 of file Font.hpp.

◆ MeasureText() [1/2]

Vector2 raylib::Font::MeasureText	(	const char *	text,
		float	fontSize,
		float	spacing
	)		const

inline

Measure string size for Font.

Definition at line 359 of file Font.hpp.

◆ MeasureText() [2/2]

Vector2 raylib::Font::MeasureText	(	const std::string_view	text,
		float	fontSize,
		float	spacing
	)		const

inline

Measure string size for Font.

Definition at line 366 of file Font.hpp.

◆ operator=() [1/2]

Font & raylib::Font::operator= ( const ::Font & font )

inline

Definition at line 150 of file Font.hpp.

◆ operator=() [2/2]

Font & raylib::Font::operator= ( Font && other )

inlinenoexcept

Definition at line 158 of file Font.hpp.

◆ set()

void raylib::Font::set ( const ::Font & font )

inlineprotected

Definition at line 390 of file Font.hpp.

◆ SetTexture()

void raylib::Font::SetTexture ( const ::Texture & newTexture )

inline

Set the texture atlas containing the glyphs.

Definition at line 148 of file Font.hpp.

◆ Unload()

void raylib::Font::Unload ( )

inline

Definition at line 126 of file Font.hpp.

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Font() [1/11]

◆ Font() [2/11]

◆ Font() [3/11]

◆ Font() [4/11]

◆ Font() [5/11]

◆ Font() [6/11]

◆ Font() [7/11]

◆ Font() [8/11]

◆ Font() [9/11]

◆ Font() [10/11]

◆ Font() [11/11]

◆ ~Font()

Member Function Documentation

◆ DrawText() [1/9]

◆ DrawText() [2/9]

◆ DrawText() [3/9]

◆ DrawText() [4/9]

◆ DrawText() [5/9]

◆ DrawText() [6/9]

◆ DrawText() [7/9]

◆ DrawText() [8/9]

◆ DrawText() [9/9]

◆ GetBaseSize()

◆ GetGlyphCount()

◆ GetGlyphIndex()

◆ GetGlyphPadding()

◆ GetGlyphs()

◆ GetRecs()

◆ GetTexture()

◆ ImageText() [1/2]

◆ ImageText() [2/2]

◆ IsValid()

◆ Load() [1/8]

◆ Load() [2/8]

◆ Load() [3/8]

◆ Load() [4/8]

◆ Load() [5/8]

◆ Load() [6/8]

◆ Load() [7/8]

◆ Load() [8/8]

◆ MeasureText() [1/2]

◆ MeasureText() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ set()

◆ SetTexture()

◆ Unload()