D3DXColorScale

The D3DXColorScale function scales a color value.

D3DXCOLOR* D3DXColorScale( 
  D3DXCOLOR* pOut,
  const D3DXCOLOR* pC,
  float s 
); 

Parameters

pOut

A pointer to a D3DXCOLOR structure that is the result of the operation.

pC

A pointer to a source D3DXCOLOR structure.

s

The scale factor. It just scales the color, treating it like a 4-D vector. There are no limits on the value of s. If s is 1, then the resulting color is the original color.

Return Values

The function returns a pointer to a D3DXCOLOR structure that is the scaled color value.

Remarks

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

This function computes the scaled color value by multiplying the color components of the given D3DXCOLOR structure by the specified scale factor:

    pOut->r = pC->r * s;

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, D3DXColorModulate, D3DXColorNegative