UnsafeNativeMethods.Vector2.Lerp Method

Language:

Performs a linear interpolation between two 2-D vectors.

Note: For programming in Microsoft Visual Basic .NET or Microsoft JScript .NET, use the equivalent method in the Microsoft.DirectX structures.

Definition

Visual Basic Public Shared Function Lerp( _
    ByVal pOut As Vector2, _
    ByVal pLeft As Vector2, _
    ByVal pRight As Vector2, _
    ByVal interpolater As Single _
) As Vector2

C# public static Vector2 Lerp(
    Vector2 pOut,
    Vector2 pLeft,
    Vector2 pRight,
    float interpolater
);

C++ public:
static Vector2 Lerp(
    Vector2 pOut,
    Vector2 pLeft,
    Vector2 pRight,
    float interpolater
);

JScript public static function Lerp(
    pOut : Vector2,
    pLeft : Vector2,
    pRight : Vector2,
    interpolater : float
) : Vector2;

Visual Basic	Public Shared Function Lerp( _ ByVal pOut As Vector2, _ ByVal pLeft As Vector2, _ ByVal pRight As Vector2, _ ByVal interpolater As Single _ ) As Vector2
C#	public static Vector2 Lerp( Vector2 pOut, Vector2 pLeft, Vector2 pRight, float interpolater );
C++	public: static Vector2 Lerp( Vector2 pOut, Vector2 pLeft, Vector2 pRight, float interpolater );
JScript	public static function Lerp( pOut : Vector2, pLeft : Vector2, pRight : Vector2, interpolater : float ) : Vector2;

Parameters

pOut Microsoft.DirectX.Vector2
A Vector2 structure that is the result of the linear interpolation.

pLeft Microsoft.DirectX.Vector2
Source Vector2 structure.

pRight Microsoft.DirectX.Vector2
Source Vector2 structure.

interpolater System.Single
Parameter that linearly interpolates between the vectors.

Return Value

Microsoft.DirectX.Vector2
A Vector2 structure that is the result of the linear interpolation.

Remarks

This method performs the linear interpolation based on the following formula.

pLeft + interpolater(pRight - pLeft).

The return value for this method is the same value returned in the pOut parameter. This allows you to use the Lerp method as a parameter for another method.

pOut	Microsoft.DirectX.Vector2 A Vector2 structure that is the result of the linear interpolation.
pLeft	Microsoft.DirectX.Vector2 Source Vector2 structure.
pRight	Microsoft.DirectX.Vector2 Source Vector2 structure.
interpolater	System.Single Parameter that linearly interpolates between the vectors.