ホーム › Graphics.DirectWrite › IDWriteFont

IDWriteFont

COM

📘 Microsoft Learn (日本語) · English

IIDacd16696-8c14-4f5d-877e-fe3fc1d32737継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

フォントコレクション内の物理フォントを表します。このインターフェイスは、物理フォントからフォントフェイスを作成したり、既存のフォントフェイスからフォントフェイスメトリックやフェイス名などの情報を取得したりするために使用されます。

メソッド 11

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetFontFamily(IDWriteFontFamily** fontFamily)

指定したフォントが属するフォントファミリを取得します。

fontFamily

IDWriteFontFamily**

out

このメソッドが返るとき、指定したフォントが属するフォントファミリオブジェクトへのポインターのアドレスが格納されます。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 4 DWRITE_FONT_WEIGHT GetWeight()

指定したフォントの太さ(ウェイト、すなわちストロークの太さ)を取得します。

戻り値

型: DWRITE_FONT_WEIGHT

指定したフォントのウェイトを示す値。

vtbl 5 DWRITE_FONT_STRETCH GetStretch()

指定したフォントのストレッチ(すなわち幅)を取得します。

戻り値

型: DWRITE_FONT_STRETCH

指定したフォントに適用されているストレッチ(すなわち幅)の種類を示す値。

vtbl 6 DWRITE_FONT_STYLE GetStyle()

指定したフォントのスタイル(すなわち傾き)を取得します。

戻り値

型: DWRITE_FONT_STYLE

指定したフォントのスタイル(すなわち傾き)の種類を示す値。

vtbl 7 BOOL IsSymbolFont()

フォントがシンボルフォントかどうかを判定します。(IDWriteFont.IsSymbolFont)

戻り値

型: BOOL

フォントがシンボルフォントの場合は TRUE、それ以外の場合は FALSE。

vtbl 8 HRESULT GetFaceNames(IDWriteLocalizedStrings** names)

フォントのフェイス名(Regular や Bold など)を含むローカライズ文字列コレクションを、ロケール名でインデックス付けして取得します。

names

IDWriteLocalizedStrings**

out

このメソッドが返るとき、新しく作成されたローカライズ文字列オブジェクトへのポインターのアドレスが格納されます。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 9 HRESULT GetInformationalStrings(DWRITE_INFORMATIONAL_STRING_ID informationalStringID, IDWriteLocalizedStrings** informationalStrings, BOOL* exists)

指定した情報文字列を含むローカライズ文字列コレクションを、ロケール名でインデックス付けして取得します。

informationalStringID	DWRITE_INFORMATIONAL_STRING_ID	in	取得する情報文字列を識別する値。たとえば DWRITE_INFORMATIONAL_STRING_DESCRIPTION は、フォントの説明を含む文字列を指定します。
informationalStrings	IDWriteLocalizedStrings**	out	このメソッドが返るとき、新しく作成されたローカライズ文字列オブジェクトへのポインターのアドレスが格納されます。
exists	BOOL*	out	このメソッドが返るとき、フォントが指定した文字列 ID を含む場合は TRUE、それ以外の場合は FALSE。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

フォントが informationalStringID で指定された文字列を含まない場合、戻り値は S_OK ですが、 informationalStrings には NULL ポインターが、exists には値 FALSE が返されます。

vtbl 10 DWRITE_FONT_SIMULATIONS GetSimulations()

指定したフォントに適用されているシミュレーションを示す値を取得します。

戻り値

型: DWRITE_FONT_SIMULATIONS

指定したフォントに適用されているシミュレーション(なし、太字、または斜体)の種類を 1 つ以上示す値。

vtbl 11 void GetMetrics(DWRITE_FONT_METRICS* fontMetrics)

フォントフェイスのデザインユニットと共通メトリックを取得します。これらのメトリックはフォントフェイス内のすべてのグリフに適用され、アプリケーションがレイアウト計算に使用します。(IDWriteFont.GetMetrics)

fontMetrics

DWRITE_FONT_METRICS*

out

このメソッドが返るとき、現在のフォントフェイスのフォントメトリックを保持する構造体が格納されます。この関数が返すメトリックは、フォントデザインユニット単位です。

vtbl 12 HRESULT HasCharacter(DWORD unicodeValue, BOOL* exists)

フォントが指定した文字をサポートするかどうかを判定します。

unicodeValue	DWORD	in	このメソッドが検査する Unicode(UCS-4)文字値。
exists	BOOL*	out	このメソッドが返るとき、フォントが指定した文字をサポートする場合は TRUE、それ以外の場合は FALSE。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 13 HRESULT CreateFontFace(IDWriteFontFace** fontFace)

フォントのフォントフェイスオブジェクトを作成します。(IDWriteFont.CreateFontFace)

fontFace

IDWriteFontFace**

out

このメソッドが返るとき、新しく作成されたフォントフェイスオブジェクトへのポインターのアドレスが格納されます。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IDWriteFont "{ACD16696-8C14-4F5D-877E-FE3FC1D32737}"
#usecom global IDWriteFont IID_IDWriteFont "{}"
#comfunc global IDWriteFont_GetFontFamily            3 sptr
#comfunc global IDWriteFont_GetWeight                4
#comfunc global IDWriteFont_GetStretch               5
#comfunc global IDWriteFont_GetStyle                 6
#comfunc global IDWriteFont_IsSymbolFont             7
#comfunc global IDWriteFont_GetFaceNames             8 sptr
#comfunc global IDWriteFont_GetInformationalStrings  9 int,sptr,var
#comfunc global IDWriteFont_GetSimulations           10
#comfunc global IDWriteFont_GetMetrics               11 var
#comfunc global IDWriteFont_HasCharacter             12 int,var
#comfunc global IDWriteFont_CreateFontFace           13 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IDWriteFont "{ACD16696-8C14-4F5D-877E-FE3FC1D32737}"
#usecom global IDWriteFont IID_IDWriteFont "{}"
#comfunc global IDWriteFont_GetFontFamily            3 sptr
#comfunc global IDWriteFont_GetWeight                4
#comfunc global IDWriteFont_GetStretch               5
#comfunc global IDWriteFont_GetStyle                 6
#comfunc global IDWriteFont_IsSymbolFont             7
#comfunc global IDWriteFont_GetFaceNames             8 sptr
#comfunc global IDWriteFont_GetInformationalStrings  9 int,sptr,sptr
#comfunc global IDWriteFont_GetSimulations           10
#comfunc global IDWriteFont_GetMetrics               11 sptr
#comfunc global IDWriteFont_HasCharacter             12 int,sptr
#comfunc global IDWriteFont_CreateFontFace           13 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。