Platform SDK: DirectX

Direct3DDevice7.Clear

Direct3DDevice7.Clear メソッドは、ビューポート (あるいはビューポート内の矩形のセット) をクリアして特定の RGBA 色にしたり、深度バッファをクリアしたり、ステンシル バッファを削除したりする。

object.Clear( _ 
    count As Long, _ 
    recs() As D3DRECT, _ 
    flags As CONST_D3DCLEARFLAGS, _ 
    color As Long, _ 
    z As Single, _ 
    stencil As Long)

パラメータ

object
Direct3DDevice7 オブジェクトを表すオブジェクト式。
count
recs の配列にある矩形の数。
recs()
クリアする矩形を記述する D3DRECT 型の配列。矩形をレンダリング ターゲットの寸法に設定すると、サーフェス全体がクリアされる。各矩形は、レンダリング ターゲット サーフェス上の点に対応するスクリーン座標を使用する。座標はビューポートの矩形の境界でクリップされる。
flags
クリアするサーフェスを示すフラグ。このパラメータは、次のフラグの任意の組み合わせを取ることができるが、フラグを最低 1 つは使わなければならない。
D3DCLEAR_TARGET
レンダリング ターゲットをクリアして、color パラメータの色にする。
D3DCLEAR_STENCIL
ステンシル バッファをクリアして、stencil パラメータの値にする。
D3DCLEAR_ZBUFFER
深度バッファをクリアして、z パラメータの値にする。
color
レンダリング ターゲット サーフェスをクリアするのに使う、RGBA カラー値。DirectX7.CreateColorRGBA メソッドを呼び出して適切な値を作成することができる。
z
このメソッドが深度バッファに保存する新しい z 値。このパラメータには、0.0 から 1.0 までの値 (両端の値を含む) を使用できる (z または w 深度バッファの場合)。0.0 はビューアに最も近い距離、1.0 は最も遠い距離を表す。
stencil
各ステンシル バッファのエントリに保存する整数値。このパラメータには 0 から 2n-1 までの値 (両端の値を含む) を使用できる。n は、ステンシル バッファのビット深度である。

エラー コード

メソッドが失敗するとエラーが発生し、Err.Number に次のいずれかのエラー コードが設定される。

D3DERR_STENCILBUFFER_NOTPRESENT
D3DERR_VIEWPORTHASNODEVICE
D3DERR_ZBUFFER_NOTPRESENT
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS

注意

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