Edit

XMPlaneNearEqual function (directxmath.h)

  • Article

Determines whether two planes are nearly equal.

Syntax

bool XM_CALLCONV XMPlaneNearEqual(
  [in] FXMVECTOR P1,
  [in] FXMVECTOR P2,
  [in] FXMVECTOR Epsilon
) noexcept;

Parameters

[in] P1

XMVECTOR describing the plane coefficients (A, B, C, D) for the plane equation Ax+By+Cz+D=0.

[in] P2

XMVECTOR describing the plane coefficients (A, B, C, D) for the plane equation Ax+By+Cz+D=0.

[in] Epsilon

An XMVECTOR that gives the component-wise tolerance to use when comparing P1 and P2.

Return value

Returns true if P1 is nearly equal to P2 and false otherwise.

Remarks

The XMPlaneNearEqual function normalizes the P1 and P2 parameters before passing them, and the Epsilon parameter, to the XMVector4NearEqual function. For more information about how the calculation is performed, see the XMVector4NearEqual function.

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 directxmath.h

See also

DirectXMath Library Plane Functions