Edit

XMColorModulate function (directxmath.h)

  • Article

Blends two colors by multiplying corresponding components together.

Syntax

XMVECTOR XM_CALLCONV XMColorModulate(
  [in] FXMVECTOR C1,
  [in] FXMVECTOR C2
) noexcept;

Parameters

[in] C1

XMVECTOR describing the first color.

[in] C2

XMVECTOR describing the second color.

Return value

Returns an XMVECTOR describing the color resulting from the modulation.

Remarks

The following pseudocode demonstrates the operation of the function.

XMVECTOR colorOut;

colorOut.x = C1.x * C2.x;
colorOut.y = C1.y * C2.y;
colorOut.z = C1.z * C2.z;
colorOut.w = C1.w * C2.w;

return colorOut;

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 Color Functions