ID2D1RenderTarget::DrawTextLayout メソッド
IDWriteTextLayout オブジェクトで示される書式付きテキストを描画します。
構文
virtual void DrawTextLayout(
D2D1_POINT_2F origin,
[in] IDWriteTextLayout *textLayout,
[in] ID2D1Brush *defaultForegroundBrush,
D2D1_DRAW_TEXT_OPTIONS options = D2D1_DRAW_TEXT_OPTIONS_NONE
) = 0;
パラメーター
- origin
D2D1_POINT_2F デバイス非依存ピクセルで示される点。textLayout で示されるテキストの左上隅が描かれます。 - textLayout [in]
IDWriteTextLayout 描画する書式付きテキスト。ID2D1Resource から継承していない描画効果はすべて無視されます。ブラシ以外に ID2D1Resource から継承する描画効果がある場合、このメソッドは失敗し、レンダー ターゲットはエラー状態になります。 - defaultForegroundBrush [in]
ID2D1Brush 描画効果として関連付けられたブラシをまだ所有していない textLayout でテキストの描画に使用するブラシ (描画効果は IDWriteTextLayout::SetDrawingEffect メソッドで指定) - options
D2D1_DRAW_TEXT_OPTIONS テキストをピクセル境界に対してスナップする必要があるかどうか、およびテキストをレイアウト四角形にクリップする必要があるかどうかを示す値。既定値は D2D1_DRAW_TEXT_OPTIONS_NONE で、テキストをピクセル境界に対してスナップする必要があるかどうか、およびテキストをレイアウト四角形にクリップしないようにする必要があるかどうかを示します。
戻り値
This は値を返しません。
解説
同じテキストを繰り返し描画する場合、DrawTextLayout メソッドを使用する方が、DrawText メソッドを使用するより効率的です。これは、呼び出すたびにテキストを書式設定する必要なくレイアウトを処理するためです。
このメソッドは失敗した場合でも、エラー コードが返されません。描画操作 (DrawTextLayout など) が失敗したかどうかを判断するには、ID2D1RenderTarget::EndDraw メソッドまたは ID2D1RenderTarget::Flush メソッドによって返された結果を確認します。
要件
クライアントの最小要件 |
Windows 7, Windows Vista SP2 および Windows Vista 用のプラットフォーム更新プログラム |
サーバーの最小要件 |
Windows Server 2008 R2, Windows Server 2008 SP2 および Windows Server 2008 用のプラットフォーム更新プログラム |
ヘッダー |
D2d1.h |
ライブラリ |
D2d1.lib |
DLL |
D2d1.dll |