DirectX 9関数:IDirect 3 DDevice 9::Clearメソッド

1558 ワード

ビューポートをクリアするか、ビューポートの長方形を設定し、指定したRGBA色に対して、深度バッファをクリアし、テンプレートバッファを消去します.
 
 
構文
HRESULT Clear(      

    DWORD Count,     const D3DRECT *pRects,     DWORD Flags,     D3DCOLOR Color,     float Z,     DWORD Stencil );

パラメータ
Count
[in] 
pRectsにおける矩形の数.設定すると
pRectsはNULLで、このパラメータは0に設定する必要があります.
pRects
クリアすべき矩形のD 3 DRECT構造ポインタを全て記述する.除去対象の矩形を定義表面全体を除去する.各矩形はスクリーン座標を用いる、座標はレンダリング対象の表面の点に対応する.座標はビューポートの矩形のエッジによって切り取る.また、このパラメータをNULLに設定ことで、ビューポートのすべての矩形をクリアすることを示すこともできる.
Flags
除去する表面を示す.少なくとも次の1つまたは複数の結合をとる.
D3DCLEAR_STENCIL
テンプレートバッファをクリアするには
Stencilパラメータで指定する値.
D3DCLEAR_TARGET
レンダーするターゲットのカラーをクリア
Colorパラメータの値
D3DCLEAR_ZBUFFER
クリア深度バッファの値は
Zパラメータの値
Color
[in]32はARGBの色値である.
Z
深さバッファの値を設定.このパラメータの値は0.0から1.0(for z-based or w-based depth buffers)です.0.0は視点の最も近い距離を表し、1.0は最も遠い距離を表す.
Stencil
[in]各テンプレートバッファ入口において、長整数型.パラメータの値は0から2まで
n–1, 
nはテンプレートバッファのビット深さである.
戻り値
 
実行に成功した場合、戻り値はD 3 D_OK.
実行に失敗した場合、戻り値はD 3 DERR_です.INVALIDCALL.
コメント
This method fails if you specify the D3DCLEAR_ZBUFFER or D3DCLEAR_STENCIL flags when the render target does not have an attached depth buffer. Similarly, if you specify the D3DCLEAR_STENCIL flag when the depth-buffer format does not contain stencil buffer information, this method fails.