IDirect3DDevice9::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 에서 2ⁿ–1 까지의 값을 사용할 수 있다. n 는 스텐실 버퍼의 비트 깊이.

반환값

성공했을 경우는,D3D_OK 를 돌려준다.

실패했을 경우의 반환값은 다음대로.

D3DERR_INVALIDCALL

메서드의 호출이 무효이다. 예를 들어, 메서드의 파라미터에 무효인 값이 설정되어 있는 경우 등이다.

주의

렌더링 타겟으로 깊이 버퍼가 Attach되지 않을 때에 D3DCLEAR_ZBUFFER 플래그 또는 D3DCLEAR_STENCIL 플래그를 지정 하면, 이 메서드는 실패한다. 같이 깊이 버퍼 포맷에 스텐실 버퍼 정보가 포함되지 않은 경우에 D3DCLEAR_STENCIL 플래그를 지정 하면, 이 메서드는 실패한다.