v1::true_type_font Class Reference

Inheritance diagram for v1::true_type_font:

Public Member Functions
	true_type_font (std::filesystem::path const &path)
	true_type_font (true_type_font const &other)=delete
true_type_font &	operator= (true_type_font const &other)=delete
	true_type_font (true_type_font &&other)=delete
true_type_font &	operator= (true_type_font &&other)=delete
bool	loaded () const noexcept override
	Return if the font is loaded.
hi::glyph_id	find_glyph (char32_t c) const override
	Get the glyph for a code-point.
std::optional< hi::glyph_id >	load_glyph (hi::glyph_id glyph_id, graphic_path &path) const override
	Load a glyph into a path.
bool	load_glyph_metrics (hi::glyph_id glyph_id, glyph_metrics &metrics, hi::glyph_id lookahead_glyph_id=hi::glyph_id{}) const override
	Load a glyphMetrics into a path.
vector2	get_kerning (hi::glyph_id current_glyph, hi::glyph_id next_glyph) const override
	Get the kerning between two glyphs.
void	substitution_and_kerning (iso_639 language, iso_15924 script, std::vector< substitution_and_kerning_type > &word) const override
	Substitute and kern a run of glyphs.
Public Member Functions inherited from v1::font
	font (font const &)=delete
font &	operator= (font const &)=delete
	font (font &&)=delete
font &	operator= (font &&)=delete
hi::glyph_ids	find_glyph (grapheme g) const
	Get the glyphs for a grapheme.
glyph_atlas_info &	atlas_info (glyph_ids const &glyphs) const
font_variant	font_variant () const noexcept

Additional Inherited Members
Data Fields inherited from v1::font
std::string	family_name
	The family name as parsed from the font file.
std::string	sub_family_name
	The sub-family name as parsed from the font file.
bool	monospace = false
bool	serif = false
bool	italic = false
bool	condensed = false
font_weight	weight = font_weight::Regular
float	optical_size = 12.0
std::string	features
	A string representing the features of a font.
hi::unicode_mask	unicode_mask
hi::font_metrics	metrics
	The metrics of a font.
std::vector< hi::font * >	fallback_chain
	List of fonts to use as a fallback for this font.

Member Function Documentation

find_glyph()

hi::glyph_id v1::true_type_font::find_glyph ( char32_t c ) const

overridevirtual

Get the glyph for a code-point.

Returns

glyph-index, or invalid when not found or error.

Implements v1::font.

get_kerning()

vector2 v1::true_type_font::get_kerning ( hi::glyph_id current_glyph, hi::glyph_id next_glyph ) const

inlineoverridevirtual

Get the kerning between two glyphs.

Parameters

current_glyph	The glyph on the left
next_glyph	The glyph on the right

Returns

The vector to add to the advance of the current_glyph.

Implements v1::font.

load_glyph()

std::optional< hi::glyph_id > v1::true_type_font::load_glyph ( hi::glyph_id glyph_id, graphic_path & path ) const

overridevirtual

Load a glyph into a path.

The glyph is directly loaded from the font file.

Parameters

glyph_id	the index of a glyph inside the font.
path	The path constructed by the loader.

Returns

empty on failure, or the glyphID of the metrics to use.

Implements v1::font.

load_glyph_metrics()

bool v1::true_type_font::load_glyph_metrics ( hi::glyph_id glyph_id, glyph_metrics & metrics, hi::glyph_id lookahead_glyph_id = hi::glyph_id{} ) const

overridevirtual

Load a glyphMetrics into a path.

The glyph is directly loaded from the font file.

Parameters

glyph_id	the index of a glyph inside the font.
metrics	The metrics constructed by the loader.
lookahead_glyph_id	The next glyph, used for determining kerning.

Returns

1 on success, 0 on not implemented

Implements v1::font.

loaded()

bool v1::true_type_font::loaded ( ) const

inlineoverridevirtualnoexcept

Return if the font is loaded.

Returns

true if the font is fully loaded, false if only metadata of the font is available.

Implements v1::font.

substitution_and_kerning()

void v1::true_type_font::substitution_and_kerning ( iso_639 language, iso_15924 script, std::vector< substitution_and_kerning_type > & word ) const

inlineoverridevirtual

Substitute and kern a run of glyphs.

Parameters

	language	The language that the word is written in.
	script	The script that the word is written in.
[in,out]	word	A run of glyphs, from the same font, font-size and script of a word.

Implements v1::font.

---

The documentation for this class was generated from the following file:

• hikogui/src/hikogui/font/true_type_font.hpp