D3DXVec3Lerp function

Note

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

Performs a linear interpolation between two 3D vectors.

Syntax

D3DXVECTOR3* D3DXVec3Lerp(
  _Inout_       D3DXVECTOR3 *pOut,
  _In_    const D3DXVECTOR3 *pV1,
  _In_    const D3DXVECTOR3 *pV2,
  _In_          FLOAT       s
);

Parameters

pOut [in, out]

Type: D3DXVECTOR3*

Pointer to the D3DXVECTOR3 structure that is the result of the operation.

pV1 [in]

Type: const D3DXVECTOR3*

Pointer to a source D3DXVECTOR3 structure.

pV2 [in]

Type: const D3DXVECTOR3*

Pointer to a source D3DXVECTOR3 structure.

s [in]

Type: FLOAT

Parameter that linearly interpolates between the vectors.

Return value

Type: D3DXVECTOR3*

Pointer to a D3DXVECTOR3 structure that is the result of the linear interpolation.

Remarks

This function performs the linear interpolation based on the following formula: V1 + s(V2-V1).

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

Requirements

Requirement Value
Header
D3dx9math.h
Library
D3dx9.lib

See also

Math Functions