Platform SDK: DirectX

D3DXColorModulate

The D3DXColorModulate function blends two given colors.

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

Parameters

pOut
A pointer to a D3DXCOLOR structure that is the result of the operation.
pC1
A pointer to a source D3DXCOLOR structure.
pC2
A pointer to a source D3DXCOLOR structure.

Return Values

The 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 given colors by multiplying matching color components:

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

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Version: Requires DirectX 7.0.
  Header: Declared in d3dxmath.h.
  Library: Use d3dx.lib.

See Also

D3DXColorLerp, D3DXColorNegative, D3DXColorScale