ホーム › Graphics.DirectWrite › IDWriteFontSet1
IDWriteFontSet1
COM公式ドキュメント
フォントセットを表します。(IDWriteFontSet1)
メソッド 13
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
vtbl 13 HRESULT GetMatchingFonts(DWRITE_FONT_PROPERTY* fontProperty, DWRITE_FONT_AXIS_VALUE* fontAxisValues, DWORD fontAxisValueCount, IDWriteFontSet1** matchingFonts)
要求された入力に基づいて、一致するフォントセットを取得します。より近い一致ほど先頭に並びます。
| fontProperty | DWRITE_FONT_PROPERTY* | inoptional | 対象とするフォントプロパティ。タイポグラフィックファミリーや、太さ/幅/スタイルのファミリーなど。 |
| fontAxisValues | DWRITE_FONT_AXIS_VALUE* | in | フォント軸値のリストを格納した配列へのポインター。配列は fontAxisValueCount 引数で示されるサイズ (要素数) である必要があります。 |
| fontAxisValueCount | DWORD | in | fontAxisValues 配列に格納されているフォント軸値の数。 |
| matchingFonts | IDWriteFontSet1** | out | IDWriteFontSet1 インターフェースへのポインターのアドレス。正常に完了すると、この関数はプロパティに一致するフォントの優先順位付きリストをポインターに設定します。それ以外の場合はポインターに nullptr を設定します。 |
戻り値
解説(Remarks)
このメソッドは、元のフォントセットに含まれていなかった項目を返すことがあります。これには、要求により近い一致となる場合のシミュレーションフラグ付きの項目や、フォント作者が名前を付けていないインスタンスが含まれます。同一のフォントリソースに由来する項目は、可能な限り近い一致となる 1 つにまとめられます。
vtbl 14 HRESULT GetFirstFontResources(IDWriteFontSet1** filteredFontSet)
セット内の各フォントリソースの最初の出現のみを含む、新しいフォントセットを取得します。
| filteredFontSet | IDWriteFontSet1** | out | IDWriteFontSet1 インターフェースへのポインターのアドレス。正常に完了すると、この関数はフォントリソースの単一の既定インスタンスから成る新しいフォントセットオブジェクトをポインターに設定します。それ以外の場合はポインターに nullptr を設定します。 |
戻り値
vtbl 15 HRESULT GetFilteredFonts(DWORD* indices, DWORD indexCount, IDWriteFontSet1** filteredFontSet)
| indices | DWORD* | in | 抽出するフォントのインデックス配列である。 |
| indexCount | DWORD | in | indices配列の要素数である。 |
| filteredFontSet | IDWriteFontSet1** | out | 抽出結果を含む新フォントセットを受け取る出力先である。 |
vtbl 16 HRESULT GetFilteredFonts(DWRITE_FONT_AXIS_RANGE* fontAxisRanges, DWORD fontAxisRangeCount, BOOL selectAnyRange, IDWriteFontSet1** filteredFontSet)
| fontAxisRanges | DWRITE_FONT_AXIS_RANGE* | in | 抽出条件となる軸範囲のDWRITE_FONT_AXIS_RANGE配列である。 |
| fontAxisRangeCount | DWORD | in | fontAxisRanges配列の要素数である。 |
| selectAnyRange | BOOL | in | いずれかの範囲に一致すれば選ぶか(TRUE)全範囲一致を要するか(FALSE)を示すBOOLである。 |
| filteredFontSet | IDWriteFontSet1** | out | 抽出結果を含む新フォントセットを受け取る出力先である。 |
vtbl 17 HRESULT GetFilteredFonts(DWRITE_FONT_PROPERTY* properties, DWORD propertyCount, BOOL selectAnyProperty, IDWriteFontSet1** filteredFontSet)
| properties | DWRITE_FONT_PROPERTY* | inoptional | 抽出条件となるDWRITE_FONT_PROPERTY配列である。 |
| propertyCount | DWORD | in | properties配列の要素数である。 |
| selectAnyProperty | BOOL | in | いずれかのプロパティに一致すれば選ぶか(TRUE)全一致を要するか(FALSE)を示すBOOLである。 |
| filteredFontSet | IDWriteFontSet1** | out | 抽出結果を含む新フォントセットを受け取る出力先である。 |
vtbl 18 HRESULT GetFilteredFontIndices(DWRITE_FONT_AXIS_RANGE* fontAxisRanges, DWORD fontAxisRangeCount, BOOL selectAnyRange, DWORD* indices, DWORD maxIndexCount, DWORD* actualIndexCount)
指定されたプロパティでフィルターした、すべての項目のインデックスを取得します。
| fontAxisRanges | DWRITE_FONT_AXIS_RANGE* | in | 抽出条件となる軸範囲のDWRITE_FONT_AXIS_RANGE配列である。 |
| fontAxisRangeCount | DWORD | in | fontAxisRanges配列の要素数である。 |
| selectAnyRange | BOOL | in | いずれかの範囲一致で選ぶか(TRUE)全範囲一致を要するか(FALSE)を示すBOOLである。 |
| indices | DWORD* | out | 0 から IDwriteFontSet::GetFontCount から 1 を引いた値までの範囲の、昇順のインデックス配列。 |
| maxIndexCount | DWORD | in | インデックスの数。 |
| actualIndexCount | DWORD* | out | 実際に書き込まれた、または必要となるインデックスの数。0 から IDwriteFontSet::GetFontCount から 1 を引いた値までの範囲です。 |
戻り値
型: HRESULT
関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコード を返します。
| 戻り値 | 説明 |
|---|---|
| E_NOT_SUFFICIENT_BUFFER | バッファーが小さすぎます。actualIndexCount には必要なサイズが設定されます。actualIndexCount は常に IDwriteFontSet::GetFontCount 以下になります。 |
vtbl 19 HRESULT GetFilteredFontIndices(DWRITE_FONT_PROPERTY* properties, DWORD propertyCount, BOOL selectAnyProperty, DWORD* indices, DWORD maxIndexCount, DWORD* actualIndexCount)
指定されたプロパティでフィルターした、すべての項目のインデックスを取得します。
| properties | DWRITE_FONT_PROPERTY* | in | フィルターに使用するプロパティのリスト。 |
| propertyCount | DWORD | in | フィルターするプロパティの数。 |
| selectAnyProperty | BOOL | in | GetFilteredFontIndices がいずれかのプロパティに一致する項目を選択する場合は true、すべてのプロパティの共通部分を選択する場合は false。 |
| indices | DWORD* | out | 0 から IDwriteFontSet::GetFontCount から 1 を引いた値までの範囲の、昇順のインデックス配列。 |
| maxIndexCount | DWORD | in | インデックスの数。 |
| actualIndexCount | DWORD* | out | 実際に書き込まれた、または必要となるインデックスの数。0 から IDwriteFontSet::GetFontCount から 1 を引いた値までの範囲です。 |
戻り値
型: HRESULT
関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコード を返します。
| 戻り値 | 説明 |
|---|---|
| E_NOT_SUFFICIENT_BUFFER | バッファーが小さすぎます。actualIndexCount には必要なサイズが設定されます。actualIndexCount は常に IDwriteFontSet::GetFontCount 以下になります。 |
vtbl 20 HRESULT GetFontAxisRanges(DWORD listIndex, DWRITE_FONT_AXIS_RANGE* fontAxisRanges, DWORD maxFontAxisRangeCount, DWORD* actualFontAxisRangeCount)
フォントセット内のすべての軸範囲 (含まれるすべての項目の和集合) を取得します。
| listIndex | DWORD | in | 軸範囲を取得する対象フォントのインデックスである。 |
| fontAxisRanges | DWRITE_FONT_AXIS_RANGE* | out | 取得する軸値範囲のリスト。 |
| maxFontAxisRangeCount | DWORD | in | 取得する軸値範囲の数。 |
| actualFontAxisRangeCount | DWORD* | out | 実際に書き込まれた、または必要となる軸範囲の数。 |
戻り値
型: HRESULT
関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコード を返します。
| 戻り値 | 説明 |
|---|---|
| E_NOT_SUFFICIENT_BUFFER | バッファーが小さすぎます。actualFontAxisRangeCount には必要なサイズが設定されます。 |
vtbl 21 HRESULT GetFontAxisRanges(DWRITE_FONT_AXIS_RANGE* fontAxisRanges, DWORD maxFontAxisRangeCount, DWORD* actualFontAxisRangeCount)
フォントセット内のすべての軸範囲 (含まれるすべての項目の和集合) を取得します。
| fontAxisRanges | DWRITE_FONT_AXIS_RANGE* | out | 取得する軸値範囲のリスト。 |
| maxFontAxisRangeCount | DWORD | in | 取得する軸値範囲の数。 |
| actualFontAxisRangeCount | DWORD* | out | 実際に書き込まれた、または必要となる軸範囲の数。 |
戻り値
型: HRESULT
関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコード を返します。
| 戻り値 | 説明 |
|---|---|
| E_NOT_SUFFICIENT_BUFFER | バッファーが小さすぎます。actualFontAxisRangeCount には必要なサイズが設定されます。 |
vtbl 22 HRESULT GetFontFaceReference(DWORD listIndex, IDWriteFontFaceReference1** fontFaceReference)
単一の項目のフォントフェイス参照を取得します。
| listIndex | DWORD | in | セット内のフォント項目の 0 から始まるインデックス。 |
| fontFaceReference | IDWriteFontFaceReference1** | out | IDWriteFontFaceReference1 インターフェースへのポインターのアドレス。正常に完了すると、この関数はフォントフェイス参照をポインターに設定します。 |
戻り値
vtbl 23 HRESULT CreateFontResource(DWORD listIndex, IDWriteFontResource** fontResource)
単一の項目のフォントリソースを作成します。
| listIndex | DWORD | in | セット内のフォント項目の 0 から始まるインデックス。 |
| fontResource | IDWriteFontResource** | out | IDWriteFontResource インターフェースへのポインターのアドレス。正常に完了すると、この関数は新しく作成されたフォントリソースオブジェクトをポインターに設定します。 |
戻り値
型: HRESULT
関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコード を返します。
| 戻り値 | 説明 |
|---|---|
| DWRITE_E_REMOTEFONT | ファイルがローカルにありません。 |
vtbl 24 HRESULT CreateFontFace(DWORD listIndex, IDWriteFontFace5** fontFace)
(フォントフェイス参照を経由せずに) 単一の項目のフォントフェイスを作成します。
| listIndex | DWORD | in | セット内のフォント項目の 0 から始まるインデックス。 |
| fontFace | IDWriteFontFace5** | out | IDWriteFontFace5 インターフェースへのポインターのアドレス。正常に完了すると、この関数は新しく作成されたフォントフェイスオブジェクトをポインターに設定します。 |
戻り値
型: HRESULT
関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコード を返します。
| 戻り値 | 説明 |
|---|---|
| DWRITE_E_REMOTEFONT | フォントがローカルにありません。 |
vtbl 25 DWRITE_LOCALITY GetFontLocality(DWORD listIndex)
単一の項目のローカリティを取得します。
| listIndex | DWORD | in | セット内のフォント項目の 0 から始まるインデックス。 |
戻り値
ローカリティを示す値。
解説(Remarks)
ローカリティの列挙型です。完全にローカルなファイルの場合、結果は常に DWRITE_LOCALITY_LOCAL になります。ダウンロード可能なファイルの場合、結果はファイルがどの程度ダウンロードされているかによって異なります。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
出力引数:
#define global IID_IDWriteFontSet1 "{7E9FDA85-6C92-4053-BC47-7AE3530DB4D3}" #usecom global IDWriteFontSet1 IID_IDWriteFontSet1 "{}" #comfunc global IDWriteFontSet1_GetMatchingFonts 13 var,var,int,sptr #comfunc global IDWriteFontSet1_GetFirstFontResources 14 sptr #comfunc global IDWriteFontSet1_GetFilteredFonts 15 var,int,sptr #comfunc global IDWriteFontSet1_GetFilteredFonts 16 var,int,int,sptr #comfunc global IDWriteFontSet1_GetFilteredFonts 17 var,int,int,sptr #comfunc global IDWriteFontSet1_GetFilteredFontIndices 18 var,int,int,var,int,var #comfunc global IDWriteFontSet1_GetFilteredFontIndices 19 var,int,int,var,int,var #comfunc global IDWriteFontSet1_GetFontAxisRanges 20 int,var,int,var #comfunc global IDWriteFontSet1_GetFontAxisRanges 21 var,int,var #comfunc global IDWriteFontSet1_GetFontFaceReference 22 int,sptr #comfunc global IDWriteFontSet1_CreateFontResource 23 int,sptr #comfunc global IDWriteFontSet1_CreateFontFace 24 int,sptr #comfunc global IDWriteFontSet1_GetFontLocality 25 int ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IDWriteFontSet1 "{7E9FDA85-6C92-4053-BC47-7AE3530DB4D3}" #usecom global IDWriteFontSet1 IID_IDWriteFontSet1 "{}" #comfunc global IDWriteFontSet1_GetMatchingFonts 13 sptr,sptr,int,sptr #comfunc global IDWriteFontSet1_GetFirstFontResources 14 sptr #comfunc global IDWriteFontSet1_GetFilteredFonts 15 sptr,int,sptr #comfunc global IDWriteFontSet1_GetFilteredFonts 16 sptr,int,int,sptr #comfunc global IDWriteFontSet1_GetFilteredFonts 17 sptr,int,int,sptr #comfunc global IDWriteFontSet1_GetFilteredFontIndices 18 sptr,int,int,sptr,int,sptr #comfunc global IDWriteFontSet1_GetFilteredFontIndices 19 sptr,int,int,sptr,int,sptr #comfunc global IDWriteFontSet1_GetFontAxisRanges 20 int,sptr,int,sptr #comfunc global IDWriteFontSet1_GetFontAxisRanges 21 sptr,int,sptr #comfunc global IDWriteFontSet1_GetFontFaceReference 22 int,sptr #comfunc global IDWriteFontSet1_CreateFontResource 23 int,sptr #comfunc global IDWriteFontSet1_CreateFontFace 24 int,sptr #comfunc global IDWriteFontSet1_GetFontLocality 25 int ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。