Struct Offset

pub struct Offset(pub i32, pub i32);

A (x, y) offset, also known as a vector

This is a relative position. It can be added to or subtracted from a Coord, and it can be added to or subtracted from itself. It can be negative. It can be multiplied by a scalar.

This may be converted to Size with from / into.

Tuple Fields

0: i32

1: i32

Implementations

impl Offset

pub const ZERO: Self

The constant (0, 0)

pub const MIN: Self

The minimum value

pub const MAX: Self

The maximum value

pub fn lt(self, rhs: Self) -> bool

True when for all components, lhs < rhs

pub fn le(self, rhs: Self) -> bool

True when for all components, lhs ≤ rhs

pub fn ge(self, rhs: Self) -> bool

True when for all components, lhs ≥ rhs

pub fn gt(self, rhs: Self) -> bool

True when for all components, lhs > rhs

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

Return the minimum, componentwise

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

Return the maximum, componentwise

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

Restrict a value to the specified interval, componentwise

pub fn transpose(self) -> Self

Return the transpose (swap x and y values)

pub fn cwise_mul(self, rhs: Self) -> Self

Return the result of component-wise multiplication

pub fn cwise_div(self, rhs: Self) -> Self

Return the result of component-wise division

pub fn distance_l1(self) -> i32

Return the L1 (rectilinear / taxicab) distance

pub fn distance_l_inf(self) -> i32

Return the L-inf (max) distance

pub fn extract<D: Directional>(self, dir: D) -> i32

Extract one component, based on a direction

This merely extracts the horizontal or vertical component. It never negates it, even if the axis is reversed.

pub fn set_component<D: Directional>(&mut self, dir: D, value: i32)

Set one component of self, based on a direction

This does not negate components when the direction is reversed.

impl Offset

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

Construct

pub const fn splat(n: i32) -> Self

Construct, using the same value on all axes

Trait Implementations

impl Add<Offset> for Coord

type Output = Coord

The resulting type after applying the + operator.

fn add(self, other: Offset) -> Self

Performs the + operation.

impl Add<Offset> for Event

type Output = Event

The resulting type after applying the + operator.

fn add(self, offset: Offset) -> Event

Performs the + operation.

impl Add<Offset> for Rect

type Output = Rect

The resulting type after applying the + operator.

fn add(self, offset: Offset) -> Self

Performs the + operation.

impl Add for Offset

type Output = Offset

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Offset> for Coord

fn add_assign(&mut self, rhs: Offset)

Performs the += operation.

impl AddAssign<Offset> for Event

fn add_assign(&mut self, offset: Offset)

Performs the += operation.

impl AddAssign<Offset> for Rect

fn add_assign(&mut self, offset: Offset)

Performs the += operation.

impl AddAssign for Offset

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Offset

fn clone(&self) -> Offset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Conv<(i32, i32)> for Offset

fn conv(v: (i32, i32)) -> Self

Convert from T to Self

fn try_conv(v: (i32, i32)) -> Result<Self>

Try converting from T to Self

impl Conv<Coord> for Offset

fn try_conv(v: Coord) -> Result<Self>

Try converting from T to Self

fn conv(v: T) -> Self

Convert from T to Self

impl Conv<Offset> for Coord

Convert an Offset into a Coord

In debug mode this asserts that the result is non-negative.

fn try_conv(v: Offset) -> Result<Self>

Try converting from T to Self

fn conv(v: T) -> Self

Convert from T to Self

impl Conv<Offset> for DVec2

fn try_conv(arg: Offset) -> Result<Self>

Try converting from T to Self

fn conv(v: T) -> Self

Convert from T to Self

impl Conv<Offset> for Size

Convert an Offset into a Size

In debug mode this asserts that the result is non-negative.

fn try_conv(v: Offset) -> Result<Self>

Try converting from T to Self

fn conv(v: T) -> Self

Convert from T to Self

impl Conv<Offset> for Vec2

fn try_conv(arg: Offset) -> Result<Self>

Try converting from T to Self

fn conv(v: T) -> Self

Convert from T to Self

impl Conv<Offset> for Vec2

fn try_conv(v: Offset) -> Result<Self>

Try converting from T to Self

fn conv(v: T) -> Self

Convert from T to Self

impl Conv<Size> for Offset

fn try_conv(v: Size) -> Result<Self>

Try converting from T to Self

fn conv(v: T) -> Self

Convert from T to Self

impl ConvApprox<DVec2> for Offset

fn try_conv_approx(arg: DVec2) -> Result<Self>

Try converting from T to Self, allowing approximation of value

fn conv_approx(x: T) -> Self

Converting from T to Self, allowing approximation of value

impl ConvApprox<Vec2> for Offset

fn try_conv_approx(arg: Vec2) -> Result<Self>

Try converting from T to Self, allowing approximation of value

fn conv_approx(x: T) -> Self

Converting from T to Self, allowing approximation of value

impl ConvFloat<DVec2> for Offset

fn try_conv_trunc(x: DVec2) -> Result<Self>

Try converting to integer with truncation

fn try_conv_nearest(x: DVec2) -> Result<Self>

Try converting to the nearest integer

fn try_conv_floor(x: DVec2) -> Result<Self>

Try converting the floor to an integer

fn try_conv_ceil(x: DVec2) -> Result<Self>

Try convert the ceiling to an integer

fn conv_trunc(x: T) -> Self

Convert to integer with truncatation

fn conv_nearest(x: T) -> Self

Convert to the nearest integer

fn conv_floor(x: T) -> Self

Convert the floor to an integer

fn conv_ceil(x: T) -> Self

Convert the ceiling to an integer

impl ConvFloat<Vec2> for Offset

fn try_conv_trunc(x: Vec2) -> Result<Self>

Try converting to integer with truncation

fn try_conv_nearest(x: Vec2) -> Result<Self>

Try converting to the nearest integer

fn try_conv_floor(x: Vec2) -> Result<Self>

Try converting the floor to an integer

fn try_conv_ceil(x: Vec2) -> Result<Self>

Try convert the ceiling to an integer

fn conv_trunc(x: T) -> Self

Convert to integer with truncatation

fn conv_nearest(x: T) -> Self

Convert to the nearest integer

fn conv_floor(x: T) -> Self

Convert the floor to an integer

fn conv_ceil(x: T) -> Self

Convert the ceiling to an integer

impl Debug for Offset

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

Formats the value using the given formatter.

impl Default for Offset

fn default() -> Offset

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Offset

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div<i32> for Offset

type Output = Offset

The resulting type after applying the / operator.

fn div(self, x: i32) -> Self

Performs the / operation.

impl From<(i32, i32)> for Offset

fn from(v: (i32, i32)) -> Self

Converts to this type from the input type.

impl Hash for Offset

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

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 Mul<i32> for Offset

type Output = Offset

The resulting type after applying the * operator.

fn mul(self, x: i32) -> Self

Performs the * operation.

impl PartialEq for Offset

fn eq(&self, other: &Offset) -> 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 Serialize for Offset

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<Offset> for Coord

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, other: Offset) -> Self

Performs the - operation.

impl Sub<Offset> for Rect

type Output = Rect

The resulting type after applying the - operator.

fn sub(self, offset: Offset) -> Self

Performs the - operation.

impl Sub for Offset

type Output = Offset

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Offset> for Coord

fn sub_assign(&mut self, rhs: Offset)

Performs the -= operation.

impl SubAssign<Offset> for Rect

fn sub_assign(&mut self, offset: Offset)

Performs the -= operation.

impl SubAssign for Offset

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Offset

impl Eq for Offset

impl StructuralPartialEq for Offset