Share via

ClipPlane.GetSingleArray() Method (Microsoft.DirectX.Direct3D)

  • Article

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

Definition

Visual Basic Public Function GetSingleArray() As Single()
C# public float[] GetSingleArray();
C++ public:
array<float>^ GetSingleArray();
JScript public function GetSingleArray() : float[];

Return Value

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

Remarks

The coefficients that this method reports take the form of the general plane equation. If the values in the array at pPlane 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 on or behind the clipping plane are clipped from the scene.

The plane equation this method uses exists in world space and is set by a previous call to ClipPlane.SetSingleArray.