Device.ClipStatus Property

Language:

Retrieves or sets a ClipStatus object.

Definition

Visual Basic Public Property ClipStatus As ClipStatus

C# public ClipStatus ClipStatus { get; set; }

C++ public:
property ClipStatus ClipStatus {
ClipStatus get();
void set(ClipStatus value);
}

JScript public function get ClipStatus() : ClipStatus
public function set ClipStatus(ClipStatus);

Visual Basic	Public Property ClipStatus As ClipStatus
C#	public ClipStatus ClipStatus { get; set; }
C++	public: property ClipStatus ClipStatus { ClipStatus get(); void set(ClipStatus value); }
JScript	public function get ClipStatus() : ClipStatus public function set ClipStatus(ClipStatus);

Property Value

Microsoft.DirectX.Direct3D.ClipStatus
A ClipStatus object that describes the current clip status.
This property is read/write.

Remarks

Clip status is used during software vertex processing; therefore, this method is not supported on hardware processing devices, whether or not they are pure. For more information about pure devices, see CreateFlags.

When clipping is enabled during vertex processing (by Device.ProcessVertices, Device.DrawPrimitives, or other drawing functions), Microsoft DirectX 9.0 computes a clip code for every vertex. The clip code is a combination of ClipStatusFlags values. When a vertex is outside of a particular clipping plane, the corresponding bit is set in the clip code. Microsoft Direct3D maintains the clip status using ClipStatus, which has ClipUnion and ClipIntersection members. ClipUnion is a bitwise OR of all vertex clip codes and has an initial value of 0; ClipIntersection is a bitwise AND of all vertex clip codes and has an initial value of 0xFFFFFFFF. When RenderStateManager.Clipping is set to false, ClipUnion and ClipIntersection are set to 0. 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.

Exceptions

InvalidCallException One of the arguments is invalid.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center