IDCompositionVisual::SetClip(constD2D_RECT_F&) メソッド (dcomp.h)

  • [アーティクル]

このビジュアルの Clip プロパティを、指定した四角形に設定します。 Clip プロパティは、このビジュアルをルートとするビジュアル サブツリーのレンダリングを、指定された四角形の領域に制限します。

構文

HRESULT SetClip(
  [in, ref] const D2D_RECT_F & rect
);

パラメーター

[in, ref] rect

型: const D2D_RECT_F

このビジュアルのクリップに使用する四角形。 rect パラメーターのすべてのプロパティには、-2^21 から 2^21 までの数値の制限があります。 API は、この範囲外の数値を受け入れますが、常にこの範囲に固定されます。

戻り値

型: HRESULT

関数が成功した場合は、S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。 エラー コードの一覧については、「 DirectComposition エラー コード 」を参照してください。

注釈

Clip プロパティを設定すると、このビジュアルと、このビジュアルにルート化されたサブツリー内のすべてのビジュアルがクリップされます。 クリップは、OffsetX、OffsetY、および Transform プロパティによって変換されます。

Clip プロパティでクリップ オブジェクトが以前に指定されている場合は、新しく指定したクリップ四角形によってクリップ オブジェクトが置き換えられます。

rect 構造体のメンバーが NaN、正の無限大、または負の無限大である場合、このメソッドは失敗します。

クリップの四角形が空の場合、ビジュアルは完全にクリップされます。つまり、ビジュアルはビジュアル ツリーに含まれていますが、何もレンダリングされません。 コンポジションから特定のビジュアルを除外するには、空のクリップ四角形を設定するのではなく、ビジュアル ツリーからビジュアルを削除します。 ビジュアルを削除すると、パフォーマンスが向上します。

要件

   
サポートされている最小のクライアント Windows 8 [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2012 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー dcomp.h
Library Dcomp.lib
[DLL] Dcomp.dll

こちらもご覧ください

クリッピング

IDCompositionRectangleClip

IDCompositionVisual