Struct gfx_hal::image::Offset

pub struct Offset {
    pub x: TexelCoordinate,
    pub y: TexelCoordinate,
    pub z: TexelCoordinate,
}

An offset into an Image used for image-to-image copy operations. All offsets are in texels, and specifying offsets other than 0 for dimensions that do not exist is undefined behavior -- for example, specifying a z offset of 1 in a two-dimensional image.

Fields

x: TexelCoordinate

X offset.

y: TexelCoordinate

Y offset.

z: TexelCoordinate

Z offset.

Methods

impl Offset

pub const ZERO: Self

Zero offset shortcut.

pub fn into_bounds(self, extent: &Extent) -> Range<Offset>

Convert the offset into 2-sided bounds given the extent.

Trait Implementations

impl PartialEq<Offset> for Offset

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

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

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

This method tests for !=.

impl Clone for Offset

fn clone(&self) -> Offset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Offset

impl Copy for Offset

impl Debug for Offset

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

Formats the value using the given formatter.

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, 

Feeds a slice of this type into the given [Hasher].