Edit

D3DXColorModulate function

  • Article

Note

The D3DX utility library is deprecated. We recommend that you use DirectXMath instead.

Blends two colors.

Syntax

D3DXCOLOR* D3DXColorModulate(
  _Inout_       D3DXCOLOR *pOut,
  _In_    const D3DXCOLOR *pC1,
  _In_    const D3DXCOLOR *pC2
);

Parameters

pOut [in, out]

Type: D3DXCOLOR*

Pointer to a D3DXCOLOR structure that is the result of the operation.

pC1 [in]

Type: const D3DXCOLOR*

Pointer to a source D3DXCOLOR structure.

pC2 [in]

Type: const D3DXCOLOR*

Pointer to a source D3DXCOLOR structure.

Return value

Type: D3DXCOLOR*

This function returns a pointer to a D3DXCOLOR structure that is the result of the blending operation.

Remarks

The return value for this function is the same value returned in the pOut parameter. In this way, the D3DXColorModulate function can be used as a parameter for another function.

This function blends together two colors by multiplying matching color components, as shown in the following example.

pOut->r = pC1->r * pC2->r;

Requirements

Requirement Value
Header
D3dx9math.h
Library
D3dx9.lib

See also

Math Functions

D3DXColorLerp

D3DXColorNegative

D3DXColorScale