D3DXColorNegative function

Note

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

Creates the negative color value of a color value.

Syntax

D3DXCOLOR* D3DXColorNegative(
  _Inout_       D3DXCOLOR *pOut,
  _In_    const D3DXCOLOR *pC
);

Parameters

pOut [in, out]

Type: D3DXCOLOR*

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

pC [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 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;

Requirements

Requirement	Value
Header	D3dx9math.h
Library	D3dx9.lib

See also

Math Functions

D3DXColorLerp

D3DXColorModulate

D3DXColorScale