Struct Region 

pub struct Region {
    pub x: u32,
    pub y: u32,
    pub width: u32,
    pub height: u32,
}

An axis-aligned rectangle of pixels, in image coordinates.

The origin is the top-left corner; x grows right and y grows down. A region with zero width or height is empty and legal to represent — it is what demand propagation produces when an op needs nothing from an input.

Edge accessors return u64 so that a region touching the far edge of the coordinate space cannot overflow during intersection math.

Fields

x: u32

Distance from the left edge of the image, in pixels.

y: u32

Distance from the top edge of the image, in pixels.

width: u32

Width in pixels; may be zero.

height: u32

Height in pixels; may be zero.

Implementations

impl Region

pub const EMPTY: Region

The empty region at the origin.

pub const fn new(x: u32, y: u32, width: u32, height: u32) -> Region

Construct a region from its origin and size.

pub const fn from_size(width: u32, height: u32) -> Region

A region covering width × height pixels at the origin.

pub const fn right(self) -> u64

The x coordinate one past the right edge.

pub const fn bottom(self) -> u64

The y coordinate one past the bottom edge.

pub const fn is_empty(self) -> bool

Whether the region contains no pixels.

pub const fn pixel_count(self) -> u64

The number of pixels in the region.

pub const fn contains(self, other: Region) -> bool

Whether other lies entirely within self.

An empty region is contained by any region, including another empty one.

pub fn intersect(self, other: Region) -> Region

The overlap between two regions, or Region::EMPTY if they are disjoint.

pub fn translate(self, dx: i64, dy: i64) -> Region

Move the region by a signed offset, clamping at the coordinate origin.

Trait Implementations

impl Clone for Region

fn clone(&self) -> Region

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Region

impl Debug for Region

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

Formats the value using the given formatter.

impl Display for Region

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

Formats the value using the given formatter.

impl Eq for Region

impl Hash for Region

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 Region

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Region