Partager via


ClipStatus Structure (Microsoft.DirectX.Direct3D)

Describes the current clip status.

Definition

Visual Basic Public Structure ClipStatus
C# public struct ClipStatus 
C++ public value class ClipStatus sealed 
JScript In JScript, you can use structures, but you cannot define your own.

Members Table

The following table lists the members exposed by the object.

Methods

Method Description
ClipStatus Initializes a new instance of the ClipStatus class.
ToString Obtains a string representation of the current instance.

Properties

Property Description
ClipIntersection Retrieves or sets a value that is the bitwise intersection of all current clip status flags.
ClipUnion Retrieves or sets a value that is the bitwise union of all current clip status flags.

Remarks

When clipping is enabled during vertex processing (by Device.ProcessVertices, Device.DrawPrimitives, or other drawing functions), Microsoft Direct3D computes a clip code for each vertex. When a vertex is outside of a particular clipping plane, the corresponding bit is set in the clipping code. Direct3D maintains the clip status using ClipStatus, 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 RenderStateManager 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 values and continue drawing.

Clip status is not updated by Device.DrawRectanglePatch and Device.DrawTrianglePatch because there is no software emulation for them.

Structure Information

Namespace Microsoft.DirectX.Direct3D
Assembly Microsoft.DirectX.Direct3D (microsoft.directx.direct3d.dll)
Strong Name Microsoft.DirectX.Direct3D,  Version=1.0.900.0,  Culture=neutral,  PublicKeyToken=d3231b57b74a1492