ContainedBy function (directxcollision.h)

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

Syntax

ContainmentType XM_CALLCONV ContainedBy(
  FXMVECTOR V0,
  FXMVECTOR V1,
  FXMVECTOR V2,
  GXMVECTOR Plane0,
  HXMVECTOR Plane1,
  HXMVECTOR Plane2,
  CXMVECTOR Plane3,
  CXMVECTOR Plane4,
  CXMVECTOR Plane5
) noexcept;

Parameters

V0

A vector defining the triangle.

V1

A vector defining the triangle.

V2

A vector defining the triangle.

Plane0

A vector defining a plane.

Plane1

A vector defining a plane.

Plane2

A vector defining a plane.

Plane3

A vector defining a plane.

Plane4

A vector defining a plane.

Plane5

A vector defining a plane.

Return value

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.

 

Platform Requirements

Microsoft Visual Studio 2010 or Microsoft Visual Studio 2012 with the Windows SDK for Windows 8. Supported for Win32 desktop apps, Windows Store apps, and Windows Phone 8 apps.

Requirements

Requirement	Value
Target Platform	Windows
Header	directxcollision.h

See also

DirectXMath Triangle Test Functions