Struct sfml::system::Vector2

#[repr(C)]
pub struct Vector2<T> {
    pub x: T,
    pub y: T,
}

Utility type for manipulating 2-dimensional vectors.

Vector2 is a simple type that defines a mathematical vector with two coordinates (x and y).

It can be used to represent anything that has two dimensions: a size, a point, a velocity, etc.

The type parameter T is the type of the coordinates.

You generally don't have to care about the generic form (Vector2<T>), the most common specializations have special type aliases:

• Vector2<f32> is Vector2f
• Vector2<i32> is Vector2i
• Vector2<u32> is Vector2u

The Vector2 type has a small and simple interface, its x and y members can be accessed directly (there are no accessors like set_x(), get_x()) and it contains no mathematical function like dot product, cross product, length, etc.

Usage example

let mut v1 = Vector2f::new(16.5, 24.0);
v1.x = 18.2;
let y = v1.y;

let v2 = v1 * 5.0;
let v3 = v1 + v2;
assert_ne!(v2, v3);

Note: for 3-dimensional vectors, see Vector3.

Fields

x: T

X coordinate of the vector.

y: T

Y coordinate of the vector.

Methods

impl<T> Vector2<T>

pub fn new(x: T, y: T) -> Self

Creates a new vector from its coordinates.

Trait Implementations

impl<T> From<(T, T)> for Vector2<T>

fn from(src: (T, T)) -> Self

Constructs a Vector2 from (x, y).

impl<T: Clone> Clone for Vector2<T>

fn clone(&self) -> Vector2<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Vector2<T>

impl<T: Default> Default for Vector2<T>

fn default() -> Vector2<T>

Returns the "default value" for a type.

impl<T: Eq> Eq for Vector2<T>

impl<T: Ord> Ord for Vector2<T>

fn cmp(&self, other: &Vector2<T>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Vector2<T>> for Vector2<T>

fn eq(&self, other: &Vector2<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Vector2<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Vector2<T>> for Vector2<T>

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

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

fn lt(&self, other: &Vector2<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Vector2<T>) -> bool

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

fn gt(&self, other: &Vector2<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Vector2<T>) -> bool

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

impl<T: Debug> Debug for Vector2<T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Div + Copy> Div<T> for Vector2<T>

type Output = Vector2<T::Output>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Vector2<T::Output>

Performs the / operation.

impl Div<Vector2<i32>> for i32

type Output = Vector2<i32>

The resulting type after applying the / operator.

fn div(self, rhs: Vector2<i32>) -> Vector2<i32>

Performs the / operation.

impl Div<Vector2<u32>> for u32

type Output = Vector2<u32>

The resulting type after applying the / operator.

fn div(self, rhs: Vector2<u32>) -> Vector2<u32>

Performs the / operation.

impl Div<Vector2<f32>> for f32

type Output = Vector2<f32>

The resulting type after applying the / operator.

fn div(self, rhs: Vector2<f32>) -> Vector2<f32>

Performs the / operation.

impl<T: Div> Div<Vector2<T>> for Vector2<T>

type Output = Vector2<T::Output>

The resulting type after applying the / operator.

fn div(self, rhs: Vector2<T>) -> Vector2<T::Output>

Performs the / operation.

impl<T: Sub + Copy> Sub<T> for Vector2<T>

type Output = Vector2<T::Output>

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Vector2<T::Output>

Performs the - operation.

impl Sub<Vector2<i32>> for i32

type Output = Vector2<i32>

The resulting type after applying the - operator.

fn sub(self, rhs: Vector2<i32>) -> Vector2<i32>

Performs the - operation.

impl Sub<Vector2<u32>> for u32

type Output = Vector2<u32>

The resulting type after applying the - operator.

fn sub(self, rhs: Vector2<u32>) -> Vector2<u32>

Performs the - operation.

impl Sub<Vector2<f32>> for f32

type Output = Vector2<f32>

The resulting type after applying the - operator.

fn sub(self, rhs: Vector2<f32>) -> Vector2<f32>

Performs the - operation.

impl<T: Sub> Sub<Vector2<T>> for Vector2<T>

type Output = Vector2<T::Output>

The resulting type after applying the - operator.

fn sub(self, rhs: Vector2<T>) -> Vector2<T::Output>

Performs the - operation.

impl<T: Add + Copy> Add<T> for Vector2<T>

type Output = Vector2<T::Output>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Vector2<T::Output>

Performs the + operation.

impl Add<Vector2<i32>> for i32

type Output = Vector2<i32>

The resulting type after applying the + operator.

fn add(self, rhs: Vector2<i32>) -> Vector2<i32>

Performs the + operation.

impl Add<Vector2<u32>> for u32

type Output = Vector2<u32>

The resulting type after applying the + operator.

fn add(self, rhs: Vector2<u32>) -> Vector2<u32>

Performs the + operation.

impl Add<Vector2<f32>> for f32

type Output = Vector2<f32>

The resulting type after applying the + operator.

fn add(self, rhs: Vector2<f32>) -> Vector2<f32>

Performs the + operation.

impl<T: Add> Add<Vector2<T>> for Vector2<T>

type Output = Vector2<T::Output>

The resulting type after applying the + operator.

fn add(self, rhs: Vector2<T>) -> Vector2<T::Output>

Performs the + operation.

impl<T: Mul + Copy> Mul<T> for Vector2<T>

type Output = Vector2<T::Output>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Vector2<T::Output>

Performs the * operation.

impl Mul<Vector2<i32>> for i32

type Output = Vector2<i32>

The resulting type after applying the * operator.

fn mul(self, rhs: Vector2<i32>) -> Vector2<i32>

Performs the * operation.

impl Mul<Vector2<u32>> for u32

type Output = Vector2<u32>

The resulting type after applying the * operator.

fn mul(self, rhs: Vector2<u32>) -> Vector2<u32>

Performs the * operation.

impl Mul<Vector2<f32>> for f32

type Output = Vector2<f32>

The resulting type after applying the * operator.

fn mul(self, rhs: Vector2<f32>) -> Vector2<f32>

Performs the * operation.

impl<T: Mul> Mul<Vector2<T>> for Vector2<T>

type Output = Vector2<T::Output>

The resulting type after applying the * operator.

fn mul(self, rhs: Vector2<T>) -> Vector2<T::Output>

Performs the * operation.

impl<T: Neg<Output = T>> Neg for Vector2<T>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: AddAssign> AddAssign<Vector2<T>> for Vector2<T>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T: SubAssign> SubAssign<Vector2<T>> for Vector2<T>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<T: MulAssign + Copy> MulAssign<T> for Vector2<T>

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T: DivAssign + Copy> DivAssign<T> for Vector2<T>

fn div_assign(&mut self, rhs: T)

Performs the /= operation.