IDWriteTextLayout::SetDrawingEffect メソッド

アプリケーション定義の描画効果を設定します。

構文

virtual HRESULT SetDrawingEffect(
    IUnknown * drawingEffect,
    DWRITE_TEXT_RANGE  textRange
) = 0;

パラメーター

• drawingEffect
  範囲に適用するアプリケーション定義の描画効果。このデータ オブジェクトは、最終的なレンダリングのためにアプリケーションの描画コールバックに戻されます。

• textRange
  この変更を適用するテキスト範囲。

戻り値

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

解説

ID2D1Brush (色ブラシやグラデーション ブラシなど) は、ID2D1RenderTarget::DrawTextLayout を使用してテキストを描画し、そのブラシが指定された範囲のテキストの描画に使用される場合、描画効果として設定できます。

この描画効果は指定された範囲に関連付けられているため、その範囲が描画時に描画されるときにコールバックによってアプリケーションに戻されます。

要件

参照

IDWriteTextLayout