Font functions

Functions
C2D_Font	C2D_FontLoad (const char *filename)
	Load a font from a file. More...
C2D_Font	C2D_FontLoadFromMem (const void *data, size_t size)
	Load a font from memory. More...
C2D_Font	C2D_FontLoadFromFD (int fd)
	Load a font from file descriptor. More...
C2D_Font	C2D_FontLoadFromHandle (FILE *f)
	Load font from stdio file handle. More...
C2D_Font	C2D_FontLoadSystem (CFG_Region region)
	Load corresponding font from system archive. More...
void	C2D_FontFree (C2D_Font font)
	Free a font. More...
void	C2D_FontSetFilter (C2D_Font font, GPU_TEXTURE_FILTER_PARAM magFilter, GPU_TEXTURE_FILTER_PARAM minFilter)
	Set a font's texture filter. More...
int	C2D_FontGlyphIndexFromCodePoint (C2D_Font font, u32 codepoint)
	Find the glyph index of a codepoint, or returns the default. More...
charWidthInfo_s *	C2D_FontGetCharWidthInfo (C2D_Font font, int glyphIndex)
	Get character width info for a given index. More...
void	C2D_FontCalcGlyphPos (C2D_Font font, fontGlyphPos_s *out, int glyphIndex, u32 flags, float scaleX, float scaleY)
	Calculate glyph position of given index. More...
FINF_s *	C2D_FontGetInfo (C2D_Font font)
	Get the font info structure associated with the font. More...

Detailed Description

Function Documentation

void C2D_FontCalcGlyphPos	(	C2D_Font	font,
		fontGlyphPos_s *	out,
		int	glyphIndex,
		u32	flags,
		float	scaleX,
		float	scaleY
	)

Calculate glyph position of given index.

Parameters

[in]	font	Font to read from, or NULL for system font
[out]	out	Glyph position
[in]	glyphIndex	Index to get position of
[in]	flags	Misc flags
[in]	scaleX	Size to scale in X
[in]	scaleY	Size to scale in Y

void C2D_FontFree

(

C2D_Font

font

)

Free a font.

Parameters

[in]

font

Font handle

charWidthInfo_s* C2D_FontGetCharWidthInfo	(	C2D_Font	font,
		int	glyphIndex
	)

Get character width info for a given index.

Parameters

[in]	font	Font to read from, or NULL for system font
[in]	glyphIndex	Index to get the width of

Returns

Width info for glyph

FINF_s* C2D_FontGetInfo

(

C2D_Font

font

)

Get the font info structure associated with the font.

Parameters

[in]

font

Font to read from, or NULL for the system font

Returns

FINF associated with the font

int C2D_FontGlyphIndexFromCodePoint	(	C2D_Font	font,
		u32	codepoint
	)

Find the glyph index of a codepoint, or returns the default.

Parameters

[in]	font	Font to search, or NULL for system font
[in]	codepoint	Codepoint to search for

Returns

Glyph index

Return values

font->cfnt->finf.alterCharIndex

The codepoint does not exist in the font

C2D_Font C2D_FontLoad

(

const char *

filename

)

Load a font from a file.

Parameters

[in]

filename

Name of the font file (.bcfnt)

Returns

Font handle

Return values

NULL

Error

C2D_Font C2D_FontLoadFromFD

(

int

fd

)

Load a font from file descriptor.

Parameters

[in]

fd

File descriptor used to load data

Returns

Font handle

Return values

NULL

Error

C2D_Font C2D_FontLoadFromHandle

(

FILE *

f

)

Load font from stdio file handle.

Parameters

[in]

f

File handle used to load data

Returns

Font handle

Return values

NULL

Error

C2D_Font C2D_FontLoadFromMem	(	const void *	data,
		size_t	size
	)

Load a font from memory.

Parameters

[in]	data	Data to load
[in]	size	Size of the data to load

Returns

Font handle

Return values

NULL

Error

C2D_Font C2D_FontLoadSystem

(

CFG_Region

region

)

Load corresponding font from system archive.

Parameters

[in]

region

Region to get font from

Returns

Font handle

Return values

NULL

Error

Remarks

JPN, USA, EUR, and AUS all use the same font.

void C2D_FontSetFilter	(	C2D_Font	font,
		GPU_TEXTURE_FILTER_PARAM	magFilter,
		GPU_TEXTURE_FILTER_PARAM	minFilter
	)

Set a font's texture filter.

Parameters

[in]	font	Font handle
[in]	magFilter	the magnification filter
[in]	minFilter	the minification filter