D3DXColorNegative Function

Creates the negative color value of a color value.

Syntax

D3DXCOLOR *D3DXColorNegative(      

    D3DXCOLOR *pOut,
    CONST D3DXCOLOR *pC
);

Parameters

pOut

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

pC

[in] Pointer to a source D3DXCOLOR structure.

Return Value

This function returns a pointer to a D3DXCOLOR structure that is the negative color value of the color value.

Remarks

The input alpha channel is copied, unmodified, to the output alpha channel.

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

This function returns the negative color value by subtracting 1.0 from the color components of the D3DXCOLOR structure, as shown in the following example.

pOut->r = 1.0f - pC->r;

Function Information

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

See Also

D3DXColorLerp, D3DXColorModulate, D3DXColorScale