Legacy Documentation: Version 2017.2 (Go to current version)
LanguageEnglish
• C#
• JS

## Script language

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

# Vector2Int

struct in UnityEngine

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

## Submission failed

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

Close

## Description

Representation of 2D vectors and points using integers.

This structure is used in some places to represent 2D positions and vectors that don't require the precision of floating-point.

## Static Properties

 down Shorthand for writing Vector2Int (0, -1). left Shorthand for writing Vector2Int (-1, 0). one Shorthand for writing Vector2Int (1, 1). right Shorthand for writing Vector2Int (1, 0). up Shorthand for writing Vector2Int (0, 1). zero Shorthand for writing Vector2Int (0, 0).

## Properties

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

## Public Methods

 Clamp Clamps the Vector2Int to the bounds given by min and max. Equals Returns true if the objects are equal. GetHashCode Gets the hash code for the Vector2Int. Set Set x and y components of an existing Vector2Int. ToString Returns a nicely formatted string for this vector.

## Static Methods

 CeilToInt Converts a Vector2 to a Vector2Int by doing a Ceiling to each value. Distance Returns the distance between a and b. FloorToInt Converts a Vector2 to a Vector2Int by doing a Floor to each value. 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. RoundToInt Converts a Vector2 to a Vector2Int by doing a Round to each value. Scale Multiplies two vectors component-wise.

## Operators

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