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

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

#include <mgl_ascii_font.h>

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

公開メンバ関数

 AsciiFont (TextureKey textureKey, uint32_t characterWidth, uint32_t characterHeight, const Vector2 &sourceOffset=MGL::Vector2()) noexcept
 コンストラクタ（テクスチャキーで初期化）
 
 AsciiFont (TextureWithBounds textureBounds) noexcept
 コンストラクタ（領域付きテクスチャで初期化）
 
 AsciiFont (const File::PathView &imagePath, uint32_t characterWidth, uint32_t characterHeight, const Vector2 &sourceOffset=MGL::Vector2(), TextureLoaderKey loaderKey=TextureStorage::kDefaultLoaderKey) noexcept
 コンストラクタ（ファイルから画像を読み込み）
 
 AsciiFont (const void *imageData, size_t dataSize, uint32_t characterWidth, uint32_t characterHeight, const Vector2 &sourceOffset=MGL::Vector2(), TextureLoaderKey loaderKey=TextureStorage::kDefaultLoaderKey) noexcept
 コンストラクタ（メモリ上の画像データから読み込み）
 
void Initialize () noexcept
 初期化処理
 
virtual size_t GetIndex (char32_t character, FontFaceType faceType) const noexcept override
 グリフのインデックスを取得
 
virtual const FontGlyph * GetGlyph (size_t index, FontFaceType faceType, const FontOption &option) const noexcept override
 グリフを取得
 
virtual bool HasFontFace (FontFaceType faceType) const noexcept override
 指定したフェイスを保持しているかを取得
 
virtual bool IsValid () const noexcept override
 このフォントリソースが有効かどうかを取得
 
virtual float GetLineAdvance () const noexcept override
 改行の送りサイズを取得
 
- 基底クラス MGL::Render::IndexedFontResource に属する継承公開メンバ関数
 IndexedFontResource (FontOrigin originType) noexcept
 コンストラクタ
 
virtual size_t GetIndex (char32_t character, FontFaceType faceType) const noexcept=0
 グリフのインデックスを取得
 
virtual const FontGlyph * GetGlyph (size_t index, FontFaceType faceType, const FontOption &option) const noexcept=0
 グリフを取得
 
virtual bool HasFontFace (FontFaceType faceType) const noexcept override=0
 指定した書体を保持しているかを取得
 
virtual bool IsValid () const noexcept override=0
 このフォントリソースが有効かどうかを取得
 
virtual float GetLineAdvance () const noexcept=0
 改行の送りサイズを取得
 
virtual float GetRubyOffset () const noexcept
 ルビのオフセット値を取得
 
- 基底クラス MGL::Render::FontResource に属する継承公開メンバ関数
constexpr FontResource (FontOrigin originType) noexcept
 コンストラクタ
 
virtual bool Print (FontWorkdata &workdata, const FontOption &option, const char *text, const Text::FormatArgs &formatArgs=Text::FormatArgs()) noexcept
 文字の表示
 
virtual bool Print (FontWorkdata &workdata, const FontOption &option, const Text::IndexedCharacter *indexedString, const Text::FormatArgs &formatArgs=Text::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
 フォントの原点タイプを取得
 

その他の継承メンバ

- 基底クラス MGL::Render::FontResource に属する継承限定公開メンバ関数
constexpr void SetEnabled (FontFeature feature, bool isEnabled) noexcept
 フォント機能の有効状態を設定
 

詳解

ASCIIフォントクラス

構築子と解体子

◆ AsciiFont() [1/4]

MGL::Render::AsciiFont::AsciiFont ( TextureKey  textureKey,
uint32_t  characterWidth,
uint32_t  characterHeight,
const Vector2 &  sourceOffset = MGL::Vector2() 
)
noexcept

コンストラクタ（テクスチャキーで初期化）

引数
[in]textureKeyテクスチャキー
[in]characterWidth文字の幅
[in]characterHeight文字の高さ
[in]sourceOffsetテクスチャの参照元座標のオフセット

◆ AsciiFont() [2/4]

MGL::Render::AsciiFont::AsciiFont ( TextureWithBounds  textureBounds)
noexcept

コンストラクタ（領域付きテクスチャで初期化）

引数
[in]textureBounds領域付きテクスチャ

◆ AsciiFont() [3/4]

MGL::Render::AsciiFont::AsciiFont ( const File::PathView &  imagePath,
uint32_t  characterWidth,
uint32_t  characterHeight,
const Vector2 &  sourceOffset = MGL::Vector2(),
TextureLoaderKey  loaderKey = TextureStorage::kDefaultLoaderKey 
)
noexcept

コンストラクタ（ファイルから画像を読み込み）

引数
[in]imagePath画像ファイルのパス
[in]characterWidth文字の幅
[in]characterHeight文字の高さ
[in]sourceOffsetテクスチャの参照元座標のオフセット
[in]loaderKeyテクスチャローダーのキー

◆ AsciiFont() [4/4]

MGL::Render::AsciiFont::AsciiFont ( const void *  imageData,
size_t  dataSize,
uint32_t  characterWidth,
uint32_t  characterHeight,
const Vector2 &  sourceOffset = MGL::Vector2(),
TextureLoaderKey  loaderKey = TextureStorage::kDefaultLoaderKey 
)
noexcept

コンストラクタ（メモリ上の画像データから読み込み）

引数
[in]imageData画像データのアドレス
[in]dataSize画像データのサイズ
[in]characterWidth文字の幅
[in]characterHeight文字の高さ
[in]sourceOffsetテクスチャの参照元座標のオフセット
[in]loaderKeyテクスチャローダーのキー

関数詳解

◆ GetGlyph()

const FontGlyph * MGL::Render::AsciiFont::GetGlyph ( size_t  index,
FontFaceType  faceType,
const FontOption &  option 
) const
overridevirtualnoexcept

グリフを取得

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

MGL::Render::IndexedFontResourceを実装しています。

◆ GetIndex()

size_t MGL::Render::AsciiFont::GetIndex ( char32_t  character,
FontFaceType  faceType 
) const
overridevirtualnoexcept

グリフのインデックスを取得

引数
[in]character取得するUTF-32文字
[in]faceTypeフェイスタイプ
戻り値
対応したグリフのインデックス．見つからない場合は SIZE_T_MAX

MGL::Render::IndexedFontResourceを実装しています。

◆ GetLineAdvance()

virtual float MGL::Render::AsciiFont::GetLineAdvance ( ) const
inlineoverridevirtualnoexcept

改行の送りサイズを取得

戻り値
改行の送りサイズ

MGL::Render::IndexedFontResourceを実装しています。

◆ HasFontFace()

virtual bool MGL::Render::AsciiFont::HasFontFace ( FontFaceType  faceType) const
inlineoverridevirtualnoexcept

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

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

MGL::Render::IndexedFontResourceを実装しています。

◆ IsValid()

virtual bool MGL::Render::AsciiFont::IsValid ( ) const
inlineoverridevirtualnoexcept

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

戻り値
true有効
false無効

MGL::Render::IndexedFontResourceを実装しています。

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