Article
11/17/2011

Vector3.Lerp Method (Vector3%, Vector3%, Single, Vector3%)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Performs a linear interpolation between two vectors.

Namespace: Microsoft.Xna.Framework
Assembly: Microsoft.Xna.Framework.Math (in Microsoft.Xna.Framework.Math.dll)

Syntax

'Declaration
Public Shared Sub Lerp ( _
    ByRef value1 As Vector3, _
    ByRef value2 As Vector3, _
    amount As Single, _
    <OutAttribute> ByRef result As Vector3 _
)

public static void Lerp(
    ref Vector3 value1,
    ref Vector3 value2,
    float amount,
    out Vector3 result
)

Parameters

value1
Type: Microsoft.Xna.Framework.Vector3%
Source vector.

value2
Type: Microsoft.Xna.Framework.Vector3%
Source vector.

amount
Type: System.Single
Value between 0 and 1 indicating the weight of value2.

result
Type: Microsoft.Xna.Framework.Vector3%
[OutAttribute] The result of the interpolation.

Remarks

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

value1 + (value2 - value1) * amount

Passing amount a value of 0 will cause value1 to be returned; a value of 1 will cause value2 to be returned.

Version Information

Silverlight

Supported in: 5

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Share via