BoundingSphere::ContainedBy function (directxcollision.h)

  • Article

Tests whether the BoundingSphere is contained by the specified frustum.

Syntax

ContainmentType XM_CALLCONV ContainedBy(
  [in] FXMVECTOR Plane0,
  [in] FXMVECTOR Plane1,
  [in] FXMVECTOR Plane2,
  [in] GXMVECTOR Plane3,
  [in] HXMVECTOR Plane4,
  [in] HXMVECTOR Plane5
) noexcept;

Parameters

[in] Plane0

A plane describing the frustum.

[in] Plane1

A plane describing the frustum.

[in] Plane2

A plane describing the frustum.

[in] Plane3

A plane describing the frustum.

[in] Plane4

A plane describing the frustum.

[in] Plane5

A plane describing the frustum.

Return value

A ContainmentType value indicating whether the frustum contains the BoundingSphere.

Remarks

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

BoundingSphere

Methods

Reference