XMPlaneEqual function (directxmath.h)

Article
02/22/2024

Determines if two planes are equal.

Syntax

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

Parameters

[in] P1

XMVECTOR describing the plane coefficients (A, B, C, D) for the plane equation

return (P1.x == P2.x && P1.y == P2.y && P1.z == P2.z && P1.w == P2.w);

[in] P2

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

Return value

Returns true if the two planes are equal and false otherwise.

Remarks

The following pseudocode demonstrates the operation of the function.

Ax+By+Cz+D=0

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

Share via