Struct Vector2i

#[repr(C)]
pub struct Vector2i {
    pub x: i32,
    pub y: i32,
}

Vector used for 2D math using integer coordinates.

2-element structure that can be used to represent discrete positions or directions in 2D space, as well as any other pair of numeric values.

Vector2i uses integer coordinates and is therefore preferable to Vector2 when exact precision is required. Note that the values are limited to 32 bits, and unlike Vector2 this cannot be configured with an engine build option. Use i64 or PackedInt64Array if 64-bit values are needed.

Conversions are provided via various from_* and to_* functions, not via the From trait. This encourages new() as the main way to construct vectors, is explicit about the conversion taking place, needs no type inference, and works in const contexts.

Navigation to impl blocks within this page

• Constants
• Constructors and general vector functions
• Specialized Vector2i functions
• 2D functions
• Trait impls + operators

All vector types

Dimension	Floating-point	Integer
2D	Vector2	Vector2i
3D	Vector3	Vector3i
4D	Vector4	Vector4i

You can convert to 3D vectors using to_3d(z), and to Vector2 using cast_float().

Godot docs

Vector2i (stable)

Fields

x: i32

The vector’s X component.

y: i32

The vector’s Y component.

Implementations

impl Vector2i

Constants

pub const ZERO: Vector2i = _

Zero vector, a vector with all components set to 0.

pub const ONE: Vector2i = _

One vector, a vector with all components set to 1.

pub const MIN: Vector2i = _

Min vector, a vector with all components equal to i32::MIN. Can be used as a negative integer equivalent of real::INF.

pub const MAX: Vector2i = _

Max vector, a vector with all components equal to i32::MAX. Can be used as an integer equivalent of real::INF.

pub const LEFT: Vector2i = _

Left unit vector. Represents the direction of left.

pub const RIGHT: Vector2i = _

Right unit vector. Represents the direction of right.

pub const UP: Vector2i = _

Up unit vector. Y is down in 2D, so this vector points -Y.

pub const DOWN: Vector2i = _

Down unit vector. Y is down in 2D, so this vector points +Y.

impl Vector2i

Specialized Vector2i functions

pub fn snapped(self, step: Vector2i) -> Vector2i

A new vector with each component snapped to the closest multiple of the corresponding component in step.

Panics

On under- or overflow:

• If any component of self is i32::MIN while the same component on step is -1.
• If any component of self plus half of the same component of step is not in range on i32.

pub const fn cast_float(self) -> Vector2

Converts to a vector with floating-point real components, using as casts.

pub const fn from_vector2(v: Vector2) -> Vector2i

👎Deprecated: Moved to Vector2::cast_int()

impl Vector2i

Constructors and general vector functions

The following associated functions and methods are available on all vectors (2D, 3D, 4D; float and int).

pub const fn new(x: i32, y: i32) -> Vector2i

Creates a vector with the given components.

pub const fn splat(v: i32) -> Vector2i

Creates a vector with all components set to v.

pub const fn from_tuple(tuple: (i32, i32)) -> Vector2i

Creates a vector from the given tuple.

pub const fn from_array(array: [i32; 2]) -> Vector2i

Creates a vector from the given array.

pub const fn to_tuple(&self) -> (i32, i32)

Returns a tuple with the components of the vector.

pub const fn to_array(&self) -> [i32; 2]

Returns an array with the components of the vector.

pub fn abs(self) -> Vector2i

Returns a new vector with all components in absolute values (i.e. positive or zero).

pub fn clamp(self, min: Vector2i, max: Vector2i) -> Vector2i

Returns a new vector with all components clamped between the components of min and max.

Panics

If min > max, min is NaN, or max is NaN.

pub fn length(self) -> f32

Returns the length (magnitude) of this vector.

pub fn length_squared(self) -> i32

Squared length (squared magnitude) of this vector.

Runs faster than length(), so prefer it if you need to compare vectors or need the squared distance for some formula.

pub fn coord_min(self, other: Vector2i) -> Vector2i

Returns a new vector containing the minimum of the two vectors, component-wise.

You may consider using the fully-qualified syntax Vector2i::coord_min(a, b) for symmetry.

pub fn coord_max(self, other: Vector2i) -> Vector2i

Returns a new vector containing the maximum of the two vectors, component-wise.

You may consider using the fully-qualified syntax Vector2i::coord_max(a, b) for symmetry.

pub fn sign(self) -> Vector2i

Returns a new vector with each component set to 1 if the component is positive, -1 if negative, and 0 if zero.

impl Vector2i

2D functions

The following methods are only available on 2D vectors (for both float and int).

pub fn to_3d(self, z: i32) -> Vector3i

Increases dimension to 3D, accepting a new value for the Z component.

pub fn aspect(self) -> f32

Returns the aspect ratio of this vector, the ratio of Self::x to Self::y.

pub fn max_axis(self) -> Option<Vector2Axis>

Returns the axis of the vector’s highest value. See Vector2Axis enum. If all components are equal, this method returns None.

To mimic Godot’s behavior, unwrap this function’s result with unwrap_or(Vector2Axis::X).

pub fn min_axis(self) -> Option<Vector2Axis>

Returns the axis of the vector’s lowest value. See Vector2Axis enum. If all components are equal, this method returns None.

To mimic Godot’s behavior, unwrap this function’s result with unwrap_or(Vector2Axis::Y).

Trait Implementations

impl Add for Vector2i

type Output = Vector2i

The resulting type after applying the + operator.

fn add(self, rhs: Vector2i) -> <Vector2i as Add>::Output

Performs the + operation.

impl AddAssign for Vector2i

fn add_assign(&mut self, rhs: Vector2i)

Performs the += operation.

impl ArrayElement for Vector2i

fn debug_validate_elements(_array: &Array<Self>) -> Result<(), ConvertError>

impl Clone for Vector2i

fn clone(&self) -> Vector2i

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Vector2i

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Vector2i

fn default() -> Vector2i

Returns the “default value” for a type.

impl Display for Vector2i

Formats the vector like Godot: (x, y).

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Div<i32> for Vector2i

type Output = Vector2i

The resulting type after applying the / operator.

fn div(self, rhs: i32) -> <Vector2i as Div<i32>>::Output

Performs the / operation.

impl Div for Vector2i

type Output = Vector2i

The resulting type after applying the / operator.

fn div(self, rhs: Vector2i) -> <Vector2i as Div>::Output

Performs the / operation.

impl DivAssign<i32> for Vector2i

fn div_assign(&mut self, rhs: i32)

Performs the /= operation.

impl DivAssign for Vector2i

fn div_assign(&mut self, rhs: Vector2i)

Performs the /= operation.

impl Export for Vector2i

fn export_hint() -> PropertyHintInfo

The export info to use for an exported field of this type, if no other export info is specified.

fn as_node_class() -> Option<ClassName>

If this is a class inheriting Node, returns the ClassName; otherwise None.

impl FromGodot for Vector2i

fn try_from_godot( via: <Vector2i as GodotConvert>::Via, ) -> Result<Vector2i, ConvertError>

Converts the Godot representation to this type, returning Err on failure.

fn from_godot(via: Self::Via) -> Self

⚠️ Converts the Godot representation to this type.

fn try_from_variant(variant: &Variant) -> Result<Self, ConvertError>

Performs the conversion from a Variant, returning Err on failure.

fn from_variant(variant: &Variant) -> Self

⚠️ Performs the conversion from a Variant.

impl GodotConvert for Vector2i

type Via = Vector2i

The type through which Self is represented in Godot.

impl Hash for Vector2i

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<Vector2Axis> for Vector2i

type Output = i32

The returned type after indexing.

fn index(&self, axis: Vector2Axis) -> &i32

Performs the indexing (container[index]) operation.

impl IndexMut<Vector2Axis> for Vector2i

fn index_mut(&mut self, axis: Vector2Axis) -> &mut i32

Performs the mutable indexing (container[index]) operation.

impl Mul<i32> for Vector2i

type Output = Vector2i

The resulting type after applying the * operator.

fn mul(self, rhs: i32) -> <Vector2i as Mul<i32>>::Output

Performs the * operation.

impl Mul for Vector2i

type Output = Vector2i

The resulting type after applying the * operator.

fn mul(self, rhs: Vector2i) -> <Vector2i as Mul>::Output

Performs the * operation.

impl MulAssign<i32> for Vector2i

fn mul_assign(&mut self, rhs: i32)

Performs the *= operation.

impl MulAssign for Vector2i

fn mul_assign(&mut self, rhs: Vector2i)

Performs the *= operation.

impl Neg for Vector2i

type Output = Vector2i

The resulting type after applying the - operator.

fn neg(self) -> <Vector2i as Neg>::Output

Performs the unary - operation.

impl Ord for Vector2i

fn cmp(&self, other: &Vector2i) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Vector2i

fn eq(&self, other: &Vector2i) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Vector2i

fn partial_cmp(&self, other: &Vector2i) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Product<&'a Vector2i> for Vector2i

fn product<I>(iter: I) -> Vector2i

where I: Iterator<Item = &'a Vector2i>,

Element-wise product of all vectors in the iterator.

impl Product for Vector2i

fn product<I>(iter: I) -> Vector2i

where I: Iterator<Item = Vector2i>,

Element-wise product of all vectors in the iterator.

impl Sub for Vector2i

type Output = Vector2i

The resulting type after applying the - operator.

fn sub(self, rhs: Vector2i) -> <Vector2i as Sub>::Output

Performs the - operation.

impl SubAssign for Vector2i

fn sub_assign(&mut self, rhs: Vector2i)

Performs the -= operation.

impl<'a> Sum<&'a Vector2i> for Vector2i

fn sum<I>(iter: I) -> Vector2i

where I: Iterator<Item = &'a Vector2i>,

Element-wise sum of all vectors in the iterator.

impl Sum for Vector2i

fn sum<I>(iter: I) -> Vector2i

where I: Iterator<Item = Vector2i>,

Element-wise sum of all vectors in the iterator.

impl ToGodot for Vector2i

type ToVia<'v> = <Vector2i as GodotConvert>::Via

Target type of to_godot(), which differs from Via for pass-by-reference types.

fn to_godot(&self) -> <Vector2i as ToGodot>::ToVia<'_>

Converts this type to the Godot type by reference, usually by cloning.

fn to_variant(&self) -> Variant

Converts this type to a Variant.

impl Var for Vector2i

fn get_property(&self) -> <Vector2i as GodotConvert>::Via

fn set_property(&mut self, value: <Vector2i as GodotConvert>::Via)

fn var_hint() -> PropertyHintInfo

Specific property hints, only override if they deviate from GodotType::property_info, e.g. for enums/newtypes.

impl Copy for Vector2i

impl Eq for Vector2i

impl GodotType for Vector2i

impl StructuralPartialEq for Vector2i