Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Vector2

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Representation of 2D vectors and points.

This structure is used in some places to represent 2D positions and vectors (e.g. texture coordinates in a Mesh or texture offsets in Material). In the majority of other cases a Vector3 is used.

Static Variables

one Shorthand for writing Vector2(1, 1).
right Shorthand for writing Vector2(1, 0).
up Shorthand for writing Vector2(0, 1).
zero Shorthand for writing Vector2(0, 0).

Variables

magnitude Returns the length of this vector (Read Only).
normalized Returns this vector with a magnitude of 1 (Read Only).
sqrMagnitude Returns the squared length of this vector (Read Only).
this[int] Access the x or y component using [0] or [1] respectively.
x X component of the vector.
y Y component of the vector.

Constructors

Vector2 Constructs a new vector with given x, y components.

Functions

Normalize Makes this vector have a magnitude of 1.
Set Set x and y components of an existing Vector2.
ToString Returns a nicely formatted string for this vector.

Static Functions

Angle Returns the angle in degrees between from and to.
ClampMagnitude Returns a copy of vector with its magnitude clamped to maxLength.
Distance Returns the distance between a and b.
Dot Dot Product of two vectors.
Lerp Linearly interpolates between two vectors.
Max Returns a vector that is made from the largest components of two vectors.
Min Returns a vector that is made from the smallest components of two vectors.
MoveTowards Moves a point current towards target.
Scale Multiplies two vectors component-wise.
SmoothDamp Gradually changes a vector towards a desired goal over time.

Operators

operator - Subtracts one vector from another.
operator != Returns true if vectors different.
operator * Multiplies a vector by a number.
operator / Divides a vector by a number.
operator + Adds two vectors.
operator == Returns true if the vectors are equal.
Vector2 Converts a Vector3 to a Vector2.
Vector3 Converts a Vector2 to a Vector3.