Microsoft DirectX 8.0 (C++)

IDirect3DDevice8::Clear

ビューポートまたはビューポート内の矩形セットを指定した RGBA 色にクリアし、深度バッファをクリアし、ステンシル バッファを削除する。

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

パラメータ

Count
[in] pRects の配列にある矩形の数。pRects を NULL に設定する場合は、このパラメータを 0 に設定する。
pRects
[in] クリアする矩形を記述する D3DRECT 構造体の配列へのポインタ。矩形をレンダリング ターゲットの寸法に設定すると、サーフェス全体がクリアされる。各矩形は、レンダリング ターゲット サーフェス上の点に対応するスクリーン座標を使用する。座標はビューポートの矩形の境界でクリップされる。このパラメータを NULL に設定すると、ビューポート矩形全体をクリアすることになる。
Flags
[in] クリアするサーフェスを示すフラグ。このパラメータでは、次のフラグの任意の組み合わせを指定できるが、少なくとも 1 つのフラグを使わなければならない。
D3DCLEAR_STENCIL
ステンシル バッファをクリアして、Stencil パラメータの値にする。
D3DCLEAR_TARGET
レンダリング ターゲットをクリアして、Color パラメータの色にする。
D3DCLEAR_ZBUFFER
深度バッファをクリアして、Z パラメータの値にする。
Color
[in] レンダリング ターゲット サーフェスをクリアする 32 ビット ARGB カラー値。
Z
[in] このメソッドが深度バッファに保存する新しい z 値。このパラメータには 0.0 から 1.0 までの値を使用できる (Z ベースまたは W ベースの深度バッファの場合)。0.0 はビューアに最も近い距離、1.0 は最も遠い距離を表す。
Stencil
[in] 各ステンシル バッファのエントリに保存する整数値。このパラメータには 0 から 2n-1 までの値を使用できる。n はステンシル バッファのビット深度。

戻り値

成功した場合は、D3D_OK を返す。

失敗した場合は、D3DERR_INVALIDCALL を返す。

注意

このメソッドは、レンダリング ターゲットに深度バッファがアタッチされていないときに D3DCLEAR_ZBUFFER または D3DCLEAR_STENCIL フラグを指定すると失敗する。同様に、深度バッファ フォーマットにステンシル バッファ情報が含まれていない場合、D3DCLEAR_STENCIL フラグを指定すると、このメソッドは失敗する。

動作環境

  ヘッダー : d3d8.h で宣言。
  インポート ライブラリ : D3d8.lib を使用。