MGL(Win32)
読み取り中…
検索中…
一致する文字列を見つけられません
公開メンバ関数 | 限定公開メンバ関数 | 全メンバ一覧
MGL::Render::FontResource クラスabstract

フォントリソースクラス [詳解]

#include <mgl_font_resource.h>

MGL::Render::FontResource の継承関係図
MGL::Render::IndexedFontResource MGL::Render::AsciiFont

公開メンバ関数

constexpr FontResource (FontOrigin originType) noexcept
 コンストラクタ
 
virtual bool Print (FontWorkdata &workdata, const FontOption &option, const char *text, const Text::FormatArgs &formatArgs) noexcept
 文字の表示
 
virtual bool Print (FontWorkdata &workdata, const FontOption &option, const Text::IndexedCharacter *indexedString, const Text::FormatArgs &formatArgs) noexcept
 インデックス化した文字を表示
 
virtual Text::IndexedCharacter ToIndexedCharacter (char32_t character, FontFaceType faceType) const noexcept
 文字をインデックス文字に変換
 
virtual char32_t ToUTF32 (Text::IndexedCharacter indexedCharacter, FontFaceType faceType) const noexcept
 インデックス文字をUTF-32の文字に変換
 
virtual const FontGlyph * GetGlyph (char32_t character, FontFaceType faceType, const FontOption &option) const noexcept
 グリフの取得
 
virtual const FontGlyph * GetGlyph (Text::IndexedCharacter character, FontFaceType faceType, const FontOption &option) const noexcept
 グリフの取得
 
virtual bool HasFontFace (FontFaceType faceType) const noexcept=0
 指定したフェイスを保持しているかを取得
 
virtual bool IsValid () const noexcept=0
 このフォントリソースが有効かどうかを取得
 
constexpr const Text::IndexConverter & GetIndexConverter () const noexcept
 インデックス文字列のコンバータを取得
 
constexpr bool IsEnabled (FontFeature feature) const noexcept
 フォント機能の有効状態を取得
 
constexpr FontOrigin GetOriginType () const noexcept
 フォントの原点タイプを取得
 

限定公開メンバ関数

constexpr void SetEnabled (FontFeature feature, bool isEnabled) noexcept
 フォント機能の有効状態を設定
 

詳解

フォントリソースクラス

関数詳解

◆ GetGlyph() [1/2]

virtual const FontGlyph * MGL::Render::FontResource::GetGlyph ( char32_t character,
FontFaceType faceType,
const FontOption & option ) const
inlinenodiscardvirtualnoexcept

グリフの取得

引数
[in]character取得するグリフの文字（UTF-32）
[in]faceTypeフェイスタイプ
[in]option描画オプション
戻り値
対応するグリフ情報．見つからない場合はnullptr

◆ GetGlyph() [2/2]

virtual const FontGlyph * MGL::Render::FontResource::GetGlyph ( Text::IndexedCharacter character,
FontFaceType faceType,
const FontOption & option ) const
inlinenodiscardvirtualnoexcept

グリフの取得

引数
[in]character取得するグリフの文字（インデックス文字）
[in]faceTypeフェイスタイプ
[in]option描画オプション
戻り値
対応するグリフ情報．見つからない場合はnullptr

◆ GetIndexConverter()

const Text::IndexConverter & MGL::Render::FontResource::GetIndexConverter ( ) const
inlinenodiscardconstexprnoexcept

インデックス文字列のコンバータを取得

戻り値
インデックス文字列のコンバータ

◆ GetOriginType()

FontOrigin MGL::Render::FontResource::GetOriginType ( ) const
inlinenodiscardconstexprnoexcept

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

戻り値
原点タイプ

◆ HasFontFace()

virtual bool MGL::Render::FontResource::HasFontFace ( FontFaceType faceType) const
nodiscardpure virtualnoexcept

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

引数
[in]faceTypeフェイスタイプ
戻り値
true保持している
false保持していない

MGL::Render::AsciiFont, MGL::Render::IndexedFontResourceで実装されています。

◆ IsEnabled()

bool MGL::Render::FontResource::IsEnabled ( FontFeature feature) const
inlinenodiscardconstexprnoexcept

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

引数
[in]featureフォントの機能
戻り値
true有効
false無効

◆ IsValid()

virtual bool MGL::Render::FontResource::IsValid ( ) const
nodiscardpure virtualnoexcept

このフォントリソースが有効かどうかを取得

戻り値
true有効
false無効

MGL::Render::AsciiFont, MGL::Render::IndexedFontResourceで実装されています。

◆ Print() [1/2]

virtual bool MGL::Render::FontResource::Print ( FontWorkdata & workdata,
const FontOption & option,
const char * text,
const Text::FormatArgs & formatArgs )
inlinevirtualnoexcept

文字の表示

引数
[in,out]workdataフォント描画のワークデータ
[in]option表示オプション
[in]text表示する文字列
[in]formatArgsフォーマット引数
戻り値
true文字列を最後まで表示した
false文字列の表示を途中で中断した

◆ Print() [2/2]

virtual bool MGL::Render::FontResource::Print ( FontWorkdata & workdata,
const FontOption & option,
const Text::IndexedCharacter * indexedString,
const Text::FormatArgs & formatArgs )
inlinevirtualnoexcept

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

引数
[in,out]workdataフォント描画のワークデータ
[in]option表示オプション
[in]indexedString表示する文字列
[in]formatArgsフォーマット引数
戻り値
true文字列を最後まで表示した
false文字列の表示を途中で中断した

◆ SetEnabled()

void MGL::Render::FontResource::SetEnabled ( FontFeature feature,
bool isEnabled )
inlineconstexprprotectednoexcept

フォント機能の有効状態を設定

引数
[in]featureフォントの機能
[in]isEnabled設定する有効フラグ

◆ ToIndexedCharacter()

virtual Text::IndexedCharacter MGL::Render::FontResource::ToIndexedCharacter ( char32_t character,
FontFaceType faceType ) const
inlinenodiscardvirtualnoexcept

文字をインデックス文字に変換

引数
[in]character変換元の文字（UTF-32）
[in]faceTypeフェイスタイプ
戻り値
インデックス文字．失敗時はMGL::Text::kIndexedCharacterInvalid

◆ ToUTF32()

virtual char32_t MGL::Render::FontResource::ToUTF32 ( Text::IndexedCharacter indexedCharacter,
FontFaceType faceType ) const
inlinenodiscardvirtualnoexcept

インデックス文字をUTF-32の文字に変換

引数
[in]indexedCharacterインデックス文字
[in]faceTypeフェイスタイプ
戻り値
インデックスに対応したUTF-32エンコードの文字．失敗時はNULL文字(0x00)
このクラス詳解は次のファイルから抽出されました:
構築: doxygen 1.12.0