Skip to content

Latest commit

 

History

History
85 lines (65 loc) · 4.19 KB

nf-d3d9helper-idirect3ddevice9-setclipstatus.md

File metadata and controls

85 lines (65 loc) · 4.19 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:d3d9helper.IDirect3DDevice9.SetClipStatus
IDirect3DDevice9::SetClipStatus (d3d9helper.h)
The IDirect3DDevice9::SetClipStatus method (d3d9.h) sets the clip status.
7c296c17-f98d-8458-efa7-95bbfde39651
IDirect3DDevice9 interface [Direct3D 9]
SetClipStatus method
IDirect3DDevice9.SetClipStatus
IDirect3DDevice9::SetClipStatus
SetClipStatus
SetClipStatus method [Direct3D 9]
SetClipStatus method [Direct3D 9]
IDirect3DDevice9 interface
d3d9helper/IDirect3DDevice9::SetClipStatus
direct3d9.idirect3ddevice9__setclipstatus
direct3d9\idirect3ddevice9__setclipstatus.htm
direct3d9
VS|directx_sdk|~\idirect3ddevice9__setclipstatus.htm
08/11/2022
7c296c17-f98d-8458-efa7-95bbfde39651, IDirect3DDevice9 interface [Direct3D 9],SetClipStatus method, IDirect3DDevice9.SetClipStatus, IDirect3DDevice9::SetClipStatus, SetClipStatus, SetClipStatus method [Direct3D 9], SetClipStatus method [Direct3D 9],IDirect3DDevice9 interface, d3d9helper/IDirect3DDevice9::SetClipStatus, direct3d9.idirect3ddevice9__setclipstatus
d3d9helper.h
D3D9.h
Windows
D3D9.lib
Windows
19H1
IDirect3DDevice9::SetClipStatus
d3d9helper/IDirect3DDevice9::SetClipStatus
c++
APIRef
kbSyntax
COM
D3D9.lib
D3D9.dll
IDirect3DDevice9.SetClipStatus

IDirect3DDevice9::SetClipStatus

-description

Sets the clip status.

-parameters

-param pClipStatus [in]

Type: const D3DCLIPSTATUS9*

Pointer to a D3DCLIPSTATUS9 structure, describing the clip status settings to be set.

-returns

Type: HRESULT

If the method succeeds, the return value is D3D_OK. If one of the arguments is invalid, the return value is D3DERR_INVALIDCALL.

-remarks

Clip status is used during software vertex processing. Therefore, this method is not supported on pure or nonpure hardware processing devices. For more information about pure devices, see D3DCREATE.

When clipping is enabled during vertex processing (by IDirect3DDevice9::ProcessVertices, IDirect3DDevice9::DrawPrimitive, or other drawing functions), Direct3D computes a clip code for every vertex. The clip code is a combination of D3DCS_* bits. When a vertex is outside a particular clipping plane, the corresponding bit is set in the clipping code. Direct3D maintains the clip status using D3DCLIPSTATUS9, which has ClipUnion and ClipIntersection members. ClipUnion is a bitwise "OR" of all vertex clip codes and ClipIntersection is a bitwise "AND" of all vertex clip codes. Initial values are zero for ClipUnion and 0xFFFFFFFF for ClipIntersection. When D3DRS_CLIPPING is set to FALSE, ClipUnion and ClipIntersection are set to zero. Direct3D updates the clip status during drawing calls. To compute clip status for a particular object, set ClipUnion and ClipIntersection to their initial value and continue drawing.

Clip status is not updated by IDirect3DDevice9::DrawRectPatch and IDirect3DDevice9::DrawTriPatch because there is no software emulation for them.

-see-also

IDirect3DDevice9

IDirect3DDevice9::GetClipStatus