XMColorEqual function (directxmath.h)

Article
02/22/2024

Tests for the equality of two colors.

Syntax

bool XM_CALLCONV XMColorEqual(
  [in] FXMVECTOR C1,
  [in] FXMVECTOR C2
) noexcept;

Parameters

[in] C1

XMVECTOR describing the first color to compare.

[in] C2

XMVECTOR describing the second color to compare.

Return value

Returns true if each of the components of the two colors are equal, or false otherwise.

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

Share via