Share via

ClipPlane.SetSingleArray(Single[]) Method (Microsoft.DirectX.Direct3D)

  • Article

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

Definition

Visual Basic Public Sub SetSingleArray( _
    ByVal value() As Single _
)
C# public void SetSingleArray(
    float[] value
);
C++ public:
void SetSingleArray(
    array<float>^ value
);
JScript public function SetSingleArray(
    value : float[]
);

Parameters

value System.Single[]
A four-element array of values that represent the clipping plane coefficients to set, in the form of the general plane equation. See Remarks.

Remarks

The coefficients that this method sets take the form of the general plane equation. If the values in the array are labeled A, B, C, and D in the order in which they appear in the array, they will 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 to be set. To enable a clipping plane, set ClipPlane.Enabled to true.

Exceptions

ArgumentExceptionLeave Site

value cannot be null or 0.

IndexOutOfRangeExceptionLeave Site

value must be a four-element array.

See Also