Win32 API 日本語リファレンス
ホーム › Graphics.DirectWrite › IDWriteTextLayout3

IDWriteTextLayout3

COM
📘 Microsoft Learn (日本語) · English
IID07ddcd52-020e-4de8-ac33-6c953d83f92d継承元IDWriteTextLayout2自前メソッド開始 vtbl80

公式ドキュメント

テキストが完全に解析および整形された後のテキストブロックを表します。(IDWriteTextLayout3)

メソッド 4

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

vtbl 80 HRESULT InvalidateLayout()

レイアウトを無効化し、メトリクス関数や描画関数を呼び出す前にレイアウトを強制的に再計測させます。これは、フォントのローカリティが変化してレイアウトを再描画すべき場合や、クライアントが実装した IDWriteInlineObject のサイズが変化した場合に役立ちます。

戻り値

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

vtbl 81 HRESULT SetLineSpacing(DWRITE_LINE_SPACING* lineSpacingOptions)

行間を設定します。(IDWriteTextLayout3.SetLineSpacing)

lineSpacingOptionsDWRITE_LINE_SPACING*in行間の管理方法。

戻り値

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

vtbl 82 HRESULT GetLineSpacing(DWRITE_LINE_SPACING* lineSpacingOptions)

行間の情報を取得します。

lineSpacingOptionsDWRITE_LINE_SPACING*out行間の管理方法。

戻り値

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

vtbl 83 HRESULT GetLineMetrics(DWRITE_LINE_METRICS1* lineMetrics, DWORD maxLineCount, DWORD* actualLineCount)

各行のプロパティを取得します。

lineMetricsDWRITE_LINE_METRICS1*outoptional行情報を格納する配列。
maxLineCountDWORDinlineMetrics 配列の最大サイズ。
actualLineCountDWORD*out実際に必要となる lineMetrics 配列のサイズ。

戻り値

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

解説(Remarks)

maxLineCount が十分な大きさでない場合、E_NOT_SUFFICIENT_BUFFER(HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) と同等)が返され、actualLineCount には必要な行数が設定されます。

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

HSP用 COM定義

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

出力引数: 
#define global IID_IDWriteTextLayout3 "{07DDCD52-020E-4DE8-AC33-6C953D83F92D}"
#usecom global IDWriteTextLayout3 IID_IDWriteTextLayout3 "{}"
#comfunc global IDWriteTextLayout3_InvalidateLayout  80
#comfunc global IDWriteTextLayout3_SetLineSpacing    81 var
#comfunc global IDWriteTextLayout3_GetLineSpacing    82 var
#comfunc global IDWriteTextLayout3_GetLineMetrics    83 var,int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。