IDirect3DDevice9::Clear

  • [アーティクル]

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

HRESULT 
Clear(
  DWORD Count,
  CONST D3DRECT * pRects,
  DWORD Flags,
  D3DCOLOR Color,
  float Z,
  DWORD Stencil
);

パラメータ

  • Count
    配列の pRects にある矩形の数です。pRects が NULL の場合、0 に設定する必要があります。pRects が有効なポインターである場合は、0 であってはなりません。
  • pRects
    クリアする矩形を示す D3DRECT 構造体の配列へのポインター。サーフェス全体をクリアするには、矩形をレンダー ターゲットのサイズに設定します。各矩形は、レンダー ターゲット上の点に対応するスクリーン座標を使用します。座標はビューポートの矩形の境界でクリップされます。ビューポートの矩形全体がクリアされるように指定するには、このパラメーターを NULL に、Count を 0 に設定します。
  • Flags
    クリアされるサーフェスを指定する、1 つ以上の D3DCLEAR フラグの組み合わせです。
  • Color
    レンダー ターゲットをこの ARGB カラーにクリアします。
  • Z
    深度バッファーをこの新しい z 値 (範囲は 0 ～ 1) にクリアします。「解説」を参照してください。
  • Stencil
    ステンシル バッファーをこの新しい値 (範囲は 0 ～ 2n - 1、n はステンシルバッファーのビット深度です) にクリアします。「解説」を参照してください。

戻り値

メソッドが成功した場合は、D3D_OK を返します。失敗した場合、次のいずれかを返します。D3DERR_INVALIDCALL

解説　

このメソッドを使用して、次のサーフェスをクリアします。レンダー ターゲット、MRT のすべてのレンダー ターゲット、ステンシル バッファー、または深度バッファー。Flags は、クリアされるサーフェスの数を指定します。矩形の配列により定義されるサーフェスのサブセットをクリアするには、pRects を使用します。

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

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

要件

ヘッダー: D3D9.h 宣言

ライブラリ: D3D9.lib 内容