IDirect3DDevice9::Clear メソッド (d3d9helper.h)

レンダー ターゲット、 複数のレンダー ターゲット、ステンシル バッファー、深度バッファーなどの 1 つ以上のサーフェスをクリアします。

構文

HRESULT Clear(
  [in] DWORD         Count,
  [in] const D3DRECT *pRects,
  [in] DWORD         Flags,
  [in] D3DCOLOR      Color,
  [in] float         Z,
  [in] DWORD         Stencil
);

パラメーター

[in] Count

型: DWORD

pRects の配列内の四角形の数。 pRects が NULL の場合は、0 に設定する必要があります。 pRects が有効なポインターである場合は、0 ではない可能性があります。

[in] pRects

型: const D3DRECT*

クリアする四角形を記述する D3DRECT 構造体の配列へのポインター。 レンダリング ターゲットの寸法に四角形を設定して、サーフェス全体をクリアします。 各四角形は、レンダー ターゲット上のポイントに対応する画面座標を使用します。 座標はビューポートの四角形の境界にクリップされます。 ビューポートの四角形全体をクリアすることを示すには、このパラメーターを NULL に設定し、Count を 0 に設定します。

[in] Flags

型: DWORD

クリアされるサーフェスを指定する 1 つ以上の D3DCLEAR フラグの組み合わせ。

[in] Color

種類: D3DCOLOR

この ARGB 色のレンダー ターゲットをクリアします。

[in] Z

型: float

0 ~ 1 の範囲のこの新しい z 値に対して深度バッファーをクリアします。 「解説」を参照してください。

[in] Stencil

型: DWORD

ステンシル バッファーを、0 ~ 2ⁿ-1 の範囲のこの新しい値にクリアします (n はステンシル バッファーのビット深度です)。 「解説」を参照してください。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値はD3D_OK。 メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

解説

レンダリング ターゲット、MRT 内のすべてのレンダー ターゲット、ステンシル バッファー、深度バッファーなど、サーフェスをクリアするには、このメソッドを使用します。 フラグは、クリアされるサーフェスの数を決定します。 四角形の配列によって定義されたサーフェスのサブセットをクリアするには、pRects を使用します。

次の場合、IDirect3DDevice9::Clear は失敗します。

• 深度バッファーがアタッチされていないレンダー ターゲットの深度バッファーまたはステンシル バッファーをクリアしてみてください。
• 深度バッファーにステンシル データが含まれていない場合は、ステンシル バッファーをクリアしてみてください。

要件

関連項目

IDirect3DDevice9