ID2D1RenderTarget::D rawTextLayout メソッド (d2d1.h)

指定した IDWriteTextLayout オブジェクトによって記述された書式設定されたテキストを描画します。

構文

void DrawTextLayout(
       D2D1_POINT_2F          origin,
  [in] IDWriteTextLayout      *textLayout,
  [in] ID2D1Brush             *defaultFillBrush,
       D2D1_DRAW_TEXT_OPTIONS options
);

パラメーター

origin

種類: D2D1_POINT_2F

デバイスに依存しないピクセルで説明されているポイント。 textLayout によって記述されたテキストの左上隅が描画されます。

[in] textLayout

型: IDWriteTextLayout*

描画する書式設定されたテキスト。 ID2D1Resource から継承されない描画効果は無視されます。 ブラシではない ID2D1Resource を継承する描画効果がある場合、このメソッドは失敗し、レンダー ターゲットはエラー状態になります。

[in] defaultFillBrush

種類: ID2D1Brush*

描画効果として関連付けられていない textLayout 内のテキストを描画するために使用されるブラシ ( IDWriteTextLayout::SetDrawingEffect メソッドで指定)。

options

種類: D2D1_DRAW_TEXT_OPTIONS

テキストをピクセル境界にスナップするかどうか、およびレイアウト四角形にテキストをクリップするかどうかを示す 値です。 既定値は D2D1_DRAW_TEXT_OPTIONS_NONE です。これは、テキストをピクセル境界にスナップし、レイアウト四角形にクリップしないことを示します。

戻り値

なし

解説

同じテキストを繰り返し描画する場合、 DrawTextLayout メソッドを使用する方が 、DrawText メソッドを使用するよりも効率的です。テキストを書式設定する必要はありません。また、各呼び出しでレイアウトを処理する必要はありません。

失敗した場合、このメソッドはエラー コードを返しません。 描画操作 (DrawTextLayout など) が失敗したかどうかを判断するには、ID2D1RenderTarget::EndDraw メソッドまたは ID2D1RenderTarget::Flush メソッドによって返される結果をチェックします。

要件

こちらもご覧ください

ID2D1RenderTarget

テキストの書式設定とレイアウト