Microsoft DirectX 8.0 (Visual Basic)

Direct3DDevice8.Clear

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

object.Clear( _ 
    Count As Long, _ 
    ClearD3DRect As Any,
    Flags As CONST_D3DCLEARFLAGS, _ 
    Color As Long, _ 
    Z As Single, _ 
    Stencil As Long)

指定項目

object
Direct3DDevice8 オブジェクトを表すオブジェクト式。
Count
ClearD3DRect の配列にある矩形の数。ClearD3DRect を ByVal 0 に設定した場合、このパラメータは 0 に設定しなければならない。
ClearD3DRect
クリアする矩形が記述されている D3DRECT 型配列の最初の要素。矩形をレンダリング ターゲットのディメンジョンに設定すると、サーフェス全体がクリアされる。各矩形は、レンダリング ターゲット サーフェス上のポイントに対応するスクリーン座標を使用する。座標はビューポートの矩形の境界でクリップされる。このパラメータを ByVal 0 に設定すると、ビューポート矩形全体がクリアされる。
Flags
クリアするサーフェスを示す、CONST_D3DCLEARFLAGS 列挙で定義されたフラグの組み合わせ。少なくとも 1 つのフラグを使用しなければならない。
Color
レンダリング ターゲット サーフェスのクリアに使用する 32 ビットの ARGB カラー値。
Z
このメソッドが深度バッファに保存する新しい z 値。このパラメータには 0.0 から 1.0 までの値を使用できる (Z ベースまたは W ベースの深度バッファの場合)。0.0 はビューアに最も近い距離、1.0 は最も遠い距離を表す。
Stencil
各ステンシル バッファのエントリに保存する整数値。このパラメータには 0 から 2n-1 までの値を使用できる。n はステンシル バッファのビット深度。

エラー コード

失敗した場合はエラーが発生し、Err.NumberD3DERR_INVALIDCALL が設定される。

エラー トラッピングの詳細については、Microsoft® Visual Basic® の「エラー処理」を参照すること。

注意

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

以下に示すコードは、Clear をデフォルトの指定で呼び出す方法である。

Dim Device As Direct3DDevice8

' Flags、Color、Z、および Stencil には
' 有効な値が設定されていると仮定する。
Device.Clear 0, ByVal 0, Flags, Color, Z, Stencil

次のコードは、クリアする矩形の配列を指定して Clear を呼び出す方法を示している。

Dim clearD3dRects(10)
device.Clear 10, clearD3dRects(0), Flags, Color, Z, Stencil

クリアする矩形の配列の先頭要素だけを渡すことに注意すること。