XMColorModulate function (directxmath.h)

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

Requirements

See also

DirectXMath Library Color Functions