Skip to main content

Offset

Struct Offset 

Source
pub struct Offset {
    pub dx: i16,
    pub dy: i16,
}
Expand description

A sub-cell pixel offset (dx, dy), distinct from Pos so a caller can’t transpose a position and an offset in a call like Surface::put_offset.

Visual only: an offset shifts where a glyph is painted within its cell on backends that support sub-cell placement (e.g. retroglyph-software); it never changes which cell a glyph occupies, and cell-mode backends (e.g. retroglyph-crossterm) ignore it entirely.

This crate’s serde feature adds Serialize/Deserialize impls for Offset directly (unlike Size/Pos/Rect, which forward to ixy’s own serde feature).

§Examples

use retroglyph_core::grid::Offset;

let offset = Offset::new(3, -2);
assert_eq!(offset.dx, 3);
assert_eq!(offset.dy, -2);

Fields§

§dx: i16

Horizontal pixel offset.

§dy: i16

Vertical pixel offset.

Implementations§

Source§

impl Offset

Source

pub const fn new(dx: i16, dy: i16) -> Self

Creates a new offset from (dx, dy).

Trait Implementations§

Source§

impl Clone for Offset

Source§

fn clone(&self) -> Offset

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Offset

Source§

impl Debug for Offset

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Offset

Source§

fn default() -> Offset

Returns the “default value” for a type. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Offset

Source§

impl From<(i16, i16)> for Offset

Source§

fn from((dx, dy): (i16, i16)) -> Self

Converts to this type from the input type.
Source§

impl From<Offset> for (i16, i16)

Source§

fn from(offset: Offset) -> Self

Converts to this type from the input type.
Source§

impl Hash for Offset

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Offset

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Offset

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Offset

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<C> WithAlpha for C
where C: Copy,

Source§

fn with_alpha_first<A>(self, alpha: A) -> AlphaFirst<A, Self>

Wraps self with alpha, storing alpha before the color in memory (see AlphaFirst).
Source§

fn with_alpha_last<A>(self, alpha: A) -> AlphaLast<A, Self>

Wraps self with alpha, storing alpha after the color in memory (see AlphaLast).