ContainedBy

Tests whether a triangle is contained within six planes (typically a frustum).

Syntax

ContainmentType ContainedBy(
         XMVECTOR V0,
         XMVECTOR V1,
         XMVECTOR V2,
         GXMVECTOR Plane0,
         XMVECTOR Plane1,
         XMVECTOR Plane2,
         XMVECTOR Plane3,
         XMVECTOR Plane4,
         XMVECTOR Plane5
)  

Parameters

V0
Type: XMVECTOR 

[in] A vector defining the triangle.

V1
Type: XMVECTOR 

[in] A vector defining the triangle.

V2
Type: XMVECTOR 

[in] A vector defining the triangle.

Plane0
Type: GXMVECTOR 

[in] A vector defining a plane.

Plane1
Type: XMVECTOR 

[in] A vector defining a plane.

Plane2
Type: XMVECTOR 

[in] A vector defining a plane.

Plane3
Type: XMVECTOR 

[in] A vector defining a plane.

Plane4
Type: XMVECTOR 

[in] A vector defining a plane.

Plane5
Type: XMVECTOR 

[in] A vector defining a plane.

Return value

Type: ContainmentType 

A ContainmentType value indicating whether the triangle is contained within the planes.

Remarks

Note

TriangleTests::ContainedBy is new for DirectXMath. This functionality is not available in XNAMath 2.x. Similar functionality for XNAMath can be found in the DirectX SDK Collision sample.

Requirements

Header: Declared in directxcollision.h.