D3DXColorLerp function
Note
The D3DX utility library is deprecated. We recommend that you use DirectXMath instead.
Uses linear interpolation to create a color value.
Syntax
D3DXCOLOR* D3DXColorLerp(
_Inout_ D3DXCOLOR *pOut,
_In_ const D3DXCOLOR *pC1,
_In_ const D3DXCOLOR *pC2,
_In_ FLOAT s
);
Parameters
-
pOut [in, out]
-
Type: D3DXCOLOR*
Pointer to a D3DXCOLOR structure that is the result of the operation.
-
pC1 [in]
-
Type: const D3DXCOLOR*
Pointer to a source D3DXCOLOR structure.
-
pC2 [in]
-
Type: const D3DXCOLOR*
Pointer to a source D3DXCOLOR structure.
-
s [in]
-
Type: FLOAT
Parameter that linearly interpolates between the colors, pC1 and pC2, treating them both as 4D vectors. There are no limits on the value of s.
Return value
Type: D3DXCOLOR*
This function returns a pointer to a D3DXCOLOR structure that is the result of the linear interpolation.
Remarks
The return value for this function is the same value returned in the pOut parameter. In this way, the D3DXColorLerp function can be used as a parameter for another function.
This function interpolates the red, green, blue, and alpha components of a D3DXCOLOR structure between two colors, as shown in the following example.
pOut->r = pC1->r + s * (pC2->r - pC1->r);
If you are linearly interpolating between the colors A and B, and s is 0, the resulting color is A. If s is 1, the resulting color is color B.
Requirements
| Requirement | Value |
|---|---|
| Header |
|
| Library |
|
See also