Skip to content

Latest commit

 

History

History
90 lines (67 loc) · 3.78 KB

nf-d3d9helper-idirect3ddevice9-setclipplane.md

File metadata and controls

90 lines (67 loc) · 3.78 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.SetClipPlane
IDirect3DDevice9::SetClipPlane (d3d9helper.h)
The IDirect3DDevice9::SetClipPlane method (d3d9.h) sets the coefficients of a user-defined clipping plane for the device.
IDirect3DDevice9 interface [Direct3D 9]
SetClipPlane method
IDirect3DDevice9.SetClipPlane
IDirect3DDevice9::SetClipPlane
SetClipPlane
SetClipPlane method [Direct3D 9]
SetClipPlane method [Direct3D 9]
IDirect3DDevice9 interface
b1eeda9e-38a1-4dea-dab6-04754538861d
d3d9helper/IDirect3DDevice9::SetClipPlane
direct3d9.idirect3ddevice9__setclipplane
direct3d9\idirect3ddevice9__setclipplane.htm
direct3d9
VS|directx_sdk|~\idirect3ddevice9__setclipplane.htm
08/11/2022
IDirect3DDevice9 interface [Direct3D 9],SetClipPlane method, IDirect3DDevice9.SetClipPlane, IDirect3DDevice9::SetClipPlane, SetClipPlane, SetClipPlane method [Direct3D 9], SetClipPlane method [Direct3D 9],IDirect3DDevice9 interface, b1eeda9e-38a1-4dea-dab6-04754538861d, d3d9helper/IDirect3DDevice9::SetClipPlane, direct3d9.idirect3ddevice9__setclipplane
d3d9helper.h
D3D9.h
Windows
D3D9.lib
Windows
19H1
IDirect3DDevice9::SetClipPlane
d3d9helper/IDirect3DDevice9::SetClipPlane
c++
APIRef
kbSyntax
COM
D3D9.lib
D3D9.dll
IDirect3DDevice9.SetClipPlane

IDirect3DDevice9::SetClipPlane

-description

Sets the coefficients of a user-defined clipping plane for the device.

-parameters

-param Index [in]

Type: DWORD

Index of the clipping plane for which the plane equation coefficients are to be set.

-param pPlane [in]

Type: const float*

Pointer to an address of a four-element array of values that represent the clipping plane coefficients to be set, in the form of the general plane equation. See Remarks.

-returns

Type: HRESULT

If the method succeeds, the return value is D3D_OK. If the method fails, the return value is D3DERR_INVALIDCALL. This error indicates that the value in Index exceeds the maximum clipping plane index supported by the device or that the array at pPlane is not large enough to contain four floating-point values.

-remarks

The coefficients that this method sets take the form of the general plane equation. If the values in the array at pPlane were labeled A, B, C, and D in the order that they appear in the array, they would fit into the general plane equation so that Ax + By + Cz + Dw = 0. A point with homogeneous coordinates (x, y, z, w) is visible in the half space of the plane if Ax + By + Cz + Dw >= 0. Points that exist behind the clipping plane are clipped from the scene.

When the fixed function pipeline is used the plane equations are assumed to be in world space. When the programmable pipeline is used the plane equations are assumed to be in the clipping space (the same space as output vertices).

This method does not enable the clipping plane equation being set. To enable a clipping plane, set the corresponding bit in the DWORD value applied to the D3DRS_CLIPPLANEENABLE render state.

-see-also

IDirect3DDevice9

IDirect3DDevice9::GetClipPlane