Struct Offset 

pub struct Offset {
    pub dx: i16,
    pub dy: i16,
}

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

impl Offset

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

Creates a new offset from (dx, dy).

Trait Implementations

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 Copy for Offset

impl Debug for Offset

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

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<Offset, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Offset

impl From<(i16, i16)> for Offset

fn from(_: (i16, i16)) -> Offset

Converts to this type from the input type.

impl Hash for Offset

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 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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Offset