Platform SDK: DirectX

ID3DXContext::Clear

ID3DXContext::Clear メソッドは、カレント ビューポートの指定されたサーフェスをクリアする。

HRESULT Clear(
  DWORD ClearFlags
); 

パラメータ

ClearFlags
クリアするサーフェスを示すフラグ。このパラメータは、次のパラメータのいくつかを組み合わせて指定できるが、必ず 1 つは指定する必要がある。
D3DCLEAR_TARGET
レンダリング ターゲットをクリアする。
D3DCLEAR_STENCIL
ステンシル バッファをクリアする。
D3DCLEAR_ZBUFFER
深度バッファをクリアする。

戻り値

成功すれば、S_OK を返す。

失敗すれば、次いずれかの値を返す。

D3DERR_STENCILBUFFER_NOTPRESENT
D3DERR_VIEWPORTHASNODEVICE
D3DERR_ZBUFFER_NOTPRESENT
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS

注意

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

このメソッドは、カレント ビューポートに対してクリアを行う。ID3DXContext::SetClearColor メソッドにはビューポートをクリアして設定する色を、ID3DXContext::SetClearDepth メソッドには深度バッファをクリアして設定する値を、ID3DXContext::SetClearStencil メソッドにはステンシル バッファをクリアして設定する値を指定する。

動作環境

  Windows NT/2000 : Windows 2000 が必要。
  Windows 95/98 : Windows 95 以上が必要。Windows 95 用に再配布可能な形で使用可能。
  バージョン : DirectX 7.0 が必要。
  ヘッダー : d3dxcore.h で宣言。
  ライブラリ : d3dx.lib を使用。

参照

ID3DXContext::SetClearColorID3DXContext::SetClearDepthID3DXContext::SetClearStencil