D3DXColorModulate Function

Blends two colors.

Syntax

D3DXCOLOR *D3DXColorModulate(      

    D3DXCOLOR *pOut,
    CONST D3DXCOLOR *pC1,
    CONST D3DXCOLOR *pC2
);

Parameters

pOut

[in, out] Pointer to a D3DXCOLOR structure that is the result of the operation.

pC1

[in] Pointer to a source D3DXCOLOR structure.

pC2

[in] Pointer to a source D3DXCOLOR structure.

Return Value

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;

Function Information

Header	d3dx9math.h
Import library	d3dx9.lib
Minimum operating systems	Windows 98

See Also

D3DXColorLerp, D3DXColorNegative, D3DXColorScale