MGL フォントクラス [詳解]

#include <mgl_font.h>

公開メンバ関数
	Font (FontKey key) noexcept
	コンストラクタ

constexpr	Font () noexcept
	コンストラクタ

bool	Load (FontKey key) noexcept
	フォントストレージからフォントを読み込み

constexpr FontKey	GetFontKey () const noexcept
	このフォントのキーを取得

constexpr void	SetPosition (const Vector2 &position) noexcept
	表示位置の設定

constexpr void	SetPosition (float x, float y) noexcept
	表示位置の設定

constexpr const Vector2 &	GetPosition () const noexcept
	表示位置の取得

constexpr void	SetScale (const Vector2 &scale) noexcept
	スケール値の設定

constexpr void	SetScale (float scaleX, float scaleY) noexcept
	スケール値の設定

constexpr void	SetScale (float scale) noexcept
	スケール値の設定

constexpr const Vector2 &	GetScale () const noexcept
	スケール値の取得

constexpr void	SetHorizontalAlignment (Alignment::Horizontal alignment) noexcept
	水平方向の配置情報の設定

constexpr Alignment::Horizontal	GetHorizontalAlignment () const noexcept
	水平方向の配置情報の取得

constexpr void	SetMaskColor (const Color &color) noexcept
	マスクカラーの設定

constexpr const Color &	GetMaskColor () const noexcept
	マスクカラーの取得

constexpr void	SetSamplerType (SamplerType samplerType) noexcept
	サンプラータイプの設定

constexpr SamplerType	GetSamplerType () const noexcept
	サンプラータイプの取得

constexpr void	SetTransparency (float transparency) noexcept
	透過値の設定

constexpr float	GetTransparency () const noexcept
	透過値の取得

constexpr void	SetMargin (const Vector2 &margin) noexcept
	字間と行間の設定

constexpr const Vector2 &	GetMargin () const noexcept
	字間と行間の取得

bool	IsValid () const noexcept
	フォントの有効状態を取得

	operator bool () const noexcept
	bool型にキャストした際に有効状態を取得

bool	operator! () const noexcept
	有効状態を否定演算子で取得

bool	Print (const char *text, const Text::FormatArgs &args=Text::FormatArgs()) noexcept
	文字の表示

bool	Print (const Text::IndexedCharacter *indexedString, const Text::FormatArgs &args=Text::FormatArgs()) noexcept
	インデックス化した文字の表示

template<class... Args>
constexpr bool	Print (const char *text, const Args &...args) noexcept
	文字の表示

template<class... Args>
constexpr bool	Print (const Text::IndexedCharacter *indexedString, const Args &...args) noexcept
	インデックス化した文字の表示

constexpr bool	IsEnabled (FontFeature feature) const noexcept
	このフォントが扱える機能を取得

constexpr bool	HasFontFace (FontFaceType faceType) const noexcept
	指定したフェイスを保持しているかを取得

STL::unique_ptr< Text::IndexedCharacter[]>	ToIndexedString (const char *text, bool enableFormat, bool enableTag) const noexcept
	文字列をこのフォント用のインデックス文字列に変換

Text::IndexedCharacter	ToIndexedCharacter (char32_t character, FontFaceType faceType=FontFaceType::Default) const noexcept
	UTF-32文字をこのフォント用のインデックス文字に変換

constexpr FontOrigin	GetOriginType () const noexcept
	フォントの原点タイプを取得

constexpr const FontGlyph *	GetGlyph (char32_t character, FontFaceType faceType=FontFaceType::Default) const noexcept
	グリフ情報の取得

constexpr const FontGlyph *	GetGlyph (Text::IndexedCharacter character, FontFaceType faceType=FontFaceType::Default) const noexcept
	グリフ情報の取得

constexpr void	SetLimits (int32_t limitCount, bool isOnce) noexcept
	表示上限数の設定

constexpr void	ClearLimits () noexcept
	表示上限数をクリア

constexpr int32_t	GetLimits () const noexcept
	表示上限数の取得

STL::vector< Text::IndexedCharacter >	Format (const Text::IndexedCharacter *text, const Text::FormatArgs &args) const noexcept
	インデックス文字列の整形

template<class... Args>
STL::vector< Text::IndexedCharacter >	Format (const Text::IndexedCharacter *text, const Args &...args) noexcept
	インデックス文字列の整形

静的公開メンバ関数
static Font	AddStorage (FontKey key, const SharedFontResource &resource) noexcept
	フォントをフォントストレージに追加

template<class FontResourceClass , class... Args>
static Font	Create (FontKey key, Args... args) noexcept
	フォント生成用テンプレート

static void	Remove (FontKey key) noexcept
	フォントの削除

詳解

MGL フォントクラス

構築子と解体子

◆ Font()

MGL::Render::Font::Font ( FontKey key )

inlinenoexcept

コンストラクタ

引数

[in] key フォントキー

関数詳解

◆ AddStorage()

Font MGL::Render::Font::AddStorage	(	FontKey	key,
		const SharedFontResource &	resource )

staticnoexcept

フォントをフォントストレージに追加

引数

[in]	key	関連付けるフォントキー
[in]	resource	追加するフォントリソース

戻り値: フォントクラス

◆ Create()

template<class FontResourceClass , class... Args>

static Font MGL::Render::Font::Create	(	FontKey	key,
		Args...	args )

inlinestaticnoexcept

フォント生成用テンプレート

テンプレート引数

FontResourceClass 追加するフォントリソースのクラス

引数

[in]	key	関連付けるフォントキー
[in]	args	コンストラクタに渡す引数

戻り値: フォントクラス

◆ Format() [1/2]

template<class... Args>

STL::vector< Text::IndexedCharacter > MGL::Render::Font::Format	(	const Text::IndexedCharacter *	text,
		const Args &...	args )

inlinenoexcept

インデックス文字列の整形

引数

[in]	text	インデックス文字列
[in]	args	フォーマット引数

戻り値: 整形後のインデックス文字列の配列

◆ Format() [2/2]

STL::vector< Text::IndexedCharacter > MGL::Render::Font::Format	(	const Text::IndexedCharacter *	text,
		const Text::FormatArgs &	args ) const

inlinenoexcept

インデックス文字列の整形

引数

[in]	text	インデックス文字列
[in]	args	フォーマット引数

戻り値: 整形後のインデックス文字列の配列

◆ GetFontKey()

FontKey MGL::Render::Font::GetFontKey ( ) const

inlinenodiscardconstexprnoexcept

このフォントのキーを取得

戻り値: フォントキー

◆ GetGlyph() [1/2]

const FontGlyph * MGL::Render::Font::GetGlyph	(	char32_t	character,
		FontFaceType	faceType = FontFaceType::Default ) const

inlinenodiscardconstexprnoexcept

グリフ情報の取得

引数

[in]	character	UTF-32文字
[in]	faceType	書体

戻り値: 引数に対応するグリフ情報．見つからない場合はnullptr

◆ GetGlyph() [2/2]

const FontGlyph * MGL::Render::Font::GetGlyph	(	Text::IndexedCharacter	character,
		FontFaceType	faceType = FontFaceType::Default ) const

inlinenodiscardconstexprnoexcept

グリフ情報の取得

引数

[in]	character	インデックス文字
[in]	faceType	書体

戻り値: 引数に対応するグリフ情報．見つからない場合はnullptr

◆ GetHorizontalAlignment()

Alignment::Horizontal MGL::Render::Font::GetHorizontalAlignment ( ) const

inlinenodiscardconstexprnoexcept

水平方向の配置情報の取得

戻り値: 現在の配置情報

◆ GetLimits()

int32_t MGL::Render::Font::GetLimits ( ) const

inlinenodiscardconstexprnoexcept

表示上限数の取得

戻り値: 表示上限数

◆ GetMargin()

const Vector2 & MGL::Render::Font::GetMargin ( ) const

inlinenodiscardconstexprnoexcept

字間と行間の取得

戻り値: 現在の字間と行間

◆ GetMaskColor()

const Color & MGL::Render::Font::GetMaskColor ( ) const

inlinenodiscardconstexprnoexcept

マスクカラーの取得

戻り値: 現在のマスクカラー

◆ GetOriginType()

FontOrigin MGL::Render::Font::GetOriginType ( ) const

inlinenodiscardconstexprnoexcept

フォントの原点タイプを取得

戻り値: 原点タイプ

◆ GetPosition()

const Vector2 & MGL::Render::Font::GetPosition ( ) const

inlinenodiscardconstexprnoexcept

表示位置の取得

戻り値: 現在の表示位置

◆ GetSamplerType()

SamplerType MGL::Render::Font::GetSamplerType ( ) const

inlinenodiscardconstexprnoexcept

サンプラータイプの取得

戻り値: 現在のサンプラータイプ

◆ GetScale()

const Vector2 & MGL::Render::Font::GetScale ( ) const

inlinenodiscardconstexprnoexcept

スケール値の取得

戻り値: 現在のスケール値

◆ GetTransparency()

float MGL::Render::Font::GetTransparency ( ) const

inlinenodiscardconstexprnoexcept

透過値の取得

戻り値: 現在の透過値

覚え書き: マスクカラーのアルファ値を返す

◆ HasFontFace()

bool MGL::Render::Font::HasFontFace ( FontFaceType faceType ) const

inlinenodiscardconstexprnoexcept

指定したフェイスを保持しているかを取得

引数

[in] faceType フェイスタイプ

戻り値

true	保持している
false	保持していない

◆ IsEnabled()

bool MGL::Render::Font::IsEnabled ( FontFeature feature ) const

inlinenodiscardconstexprnoexcept

このフォントが扱える機能を取得

引数

[in] feature 取得する機能

戻り値

true	扱える
false	扱えない

◆ IsValid()

bool MGL::Render::Font::IsValid ( ) const

inlinenodiscardnoexcept

フォントの有効状態を取得

戻り値

true	有効
false	無効

◆ Load()

bool MGL::Render::Font::Load ( FontKey key )

noexcept

フォントストレージからフォントを読み込み

引数

[in] key 読み込むフォントのキー

戻り値

true	成功
false	キーに対応したフォントが見つからなかった

◆ operator bool()

MGL::Render::Font::operator bool ( ) const

inlineexplicitnoexcept

bool型にキャストした際に有効状態を取得

戻り値

true	有効
false	無効

◆ operator!()

bool MGL::Render::Font::operator! ( ) const

inlinenoexcept

有効状態を否定演算子で取得

戻り値

true	無効
false	有効

◆ Print() [1/4]

template<class... Args>

bool MGL::Render::Font::Print	(	const char *	text,
		const Args &...	args )

inlineconstexprnoexcept

文字の表示

引数

[in]	text	表示する文字
[in]	args	フォーマット引数

◆ Print() [2/4]

bool MGL::Render::Font::Print	(	const char *	text,
		const Text::FormatArgs &	args = Text::FormatArgs() )

noexcept

文字の表示

引数

[in]	text	表示する文字
[in]	args	フォーマット引数

戻り値

true	文字列を最後まで表示した
false	文字列の表示を途中で中断した

◆ Print() [3/4]

template<class... Args>

bool MGL::Render::Font::Print	(	const Text::IndexedCharacter *	indexedString,
		const Args &...	args )

inlineconstexprnoexcept

インデックス化した文字の表示

引数

[in]	indexedString	表示する文字
[in]	args	フォーマット引数

◆ Print() [4/4]

bool MGL::Render::Font::Print	(	const Text::IndexedCharacter *	indexedString,
		const Text::FormatArgs &	args = Text::FormatArgs() )

noexcept

インデックス化した文字の表示

引数

[in]	indexedString	表示する文字
[in]	args	フォーマット引数

戻り値

true	文字列を最後まで表示した
false	文字列の表示を途中で中断した

◆ SetHorizontalAlignment()

void MGL::Render::Font::SetHorizontalAlignment ( Alignment::Horizontal alignment )

inlineconstexprnoexcept

水平方向の配置情報の設定

引数

[in] alignment 設定する配置情報

◆ SetLimits()

void MGL::Render::Font::SetLimits	(	int32_t	limitCount,
		bool	isOnce )

inlineconstexprnoexcept

表示上限数の設定

引数

[in]	limitCount	表示上限数
[in]	isOnce	直後のPrint()にのみ適用するかのフラグ

◆ SetMargin()

void MGL::Render::Font::SetMargin ( const Vector2 & margin )

inlineconstexprnoexcept

字間と行間の設定

引数

[in] margin 設定する字間と行間

◆ SetMaskColor()

void MGL::Render::Font::SetMaskColor ( const Color & color )

inlineconstexprnoexcept

マスクカラーの設定

引数

[in] color 設定するマスクカラー

◆ SetPosition() [1/2]

void MGL::Render::Font::SetPosition ( const Vector2 & position )

inlineconstexprnoexcept

表示位置の設定

引数

[in] position 設定する表示位置

◆ SetPosition() [2/2]

void MGL::Render::Font::SetPosition	(	float	x,
		float	y )

inlineconstexprnoexcept

表示位置の設定

引数

[in]	x	X座標
[in]	y	Y座標

◆ SetSamplerType()

void MGL::Render::Font::SetSamplerType ( SamplerType samplerType )

inlineconstexprnoexcept

サンプラータイプの設定

引数

[in] samplerType 設定するサンプラータイプ

◆ SetScale() [1/3]

void MGL::Render::Font::SetScale ( const Vector2 & scale )

inlineconstexprnoexcept

スケール値の設定

引数

[in] scale 設定するスケール値

◆ SetScale() [2/3]

void MGL::Render::Font::SetScale ( float scale )

inlineconstexprnoexcept

スケール値の設定

引数

[in] scale スケール値（X,Y共通）

◆ SetScale() [3/3]

void MGL::Render::Font::SetScale	(	float	scaleX,
		float	scaleY )

inlineconstexprnoexcept

スケール値の設定

引数

[in]	scaleX	X方向のスケール値
[in]	scaleY	Y方向のスケール値

◆ SetTransparency()

void MGL::Render::Font::SetTransparency ( float transparency )

inlineconstexprnoexcept

透過値の設定

引数

[in] transparency 透過値(0.0fから1.0f)

覚え書き: マスクカラーのアルファ値に書き込む

◆ ToIndexedCharacter()

Text::IndexedCharacter MGL::Render::Font::ToIndexedCharacter	(	char32_t	character,
		FontFaceType	faceType = FontFaceType::Default ) const

inlinenodiscardnoexcept

UTF-32文字をこのフォント用のインデックス文字に変換

引数

[in]	character	変換元の文字（UTF-32）
[in]	faceType	フェイスタイプ

戻り値: インデックス文字

◆ ToIndexedString()

STL::unique_ptr< Text::IndexedCharacter[]> MGL::Render::Font::ToIndexedString	(	const char *	text,
		bool	enableFormat,
		bool	enableTag ) const

inlinenoexcept

文字列をこのフォント用のインデックス文字列に変換

引数

[in]	text	変換する文字列
[in]	enableFormat	テキスト整形を有効にするかのフラグ
[in]	enableTag	タグを有効にするかのフラグ

戻り値: インデックス文字列

このクラス詳解は次のファイルから抽出されました:

/Users/acerola/work/mgl-work/mgl/include/mgl/render/font/mgl_font.h
/Users/acerola/work/mgl-work/mgl/src/render/font/mgl_font.cc

公開メンバ関数

静的公開メンバ関数

詳解

構築子と解体子

◆ Font()

関数詳解

◆ AddStorage()

◆ Create()

◆ Format() [1/2]

◆ Format() [2/2]

◆ GetFontKey()

◆ GetGlyph() [1/2]

◆ GetGlyph() [2/2]

◆ GetHorizontalAlignment()

◆ GetLimits()

◆ GetMargin()

◆ GetMaskColor()

◆ GetOriginType()

◆ GetPosition()

◆ GetSamplerType()

◆ GetScale()

◆ GetTransparency()

◆ HasFontFace()

◆ IsEnabled()

◆ IsValid()

◆ Load()

◆ operator bool()

◆ operator!()

◆ Print() [1/4]

◆ Print() [2/4]

◆ Print() [3/4]

◆ Print() [4/4]

◆ SetHorizontalAlignment()

◆ SetLimits()

◆ SetMargin()

◆ SetMaskColor()

◆ SetPosition() [1/2]

◆ SetPosition() [2/2]

◆ SetSamplerType()

◆ SetScale() [1/3]

◆ SetScale() [2/3]

◆ SetScale() [3/3]

◆ SetTransparency()

◆ ToIndexedCharacter()

◆ ToIndexedString()