Type Alias DataWindow

pub type DataWindow = IntegerBounds;

The integer rectangle describing where an layer is placed on the infinite 2D global space.

Aliased Type

struct DataWindow {
    pub position: Vec2<i32>,
    pub size: Vec2<usize>,
}

Fields

position: Vec2<i32>

The top left corner of this rectangle. The Box2I32 includes this pixel if the size is not zero.

size: Vec2<usize>

How many pixels to include in this Box2I32. Extends to the right and downwards. Does not include the actual boundary, just like Vec::len().

Implementations

impl IntegerBounds

pub fn zero() -> Self

Create a box with no size located at (0,0).

pub fn from_dimensions(size: impl Into<Vec2<usize>>) -> Self

Create a box with a size starting at zero.

pub fn new(start: impl Into<Vec2<i32>>, size: impl Into<Vec2<usize>>) -> Self

Create a box with a size and an origin point.

pub fn end(self) -> Vec2<i32>

Returns the top-right coordinate of the rectangle. The row and column described by this vector are not included in the rectangle, just like Vec::len().

pub fn max(self) -> Vec2<i32>

Returns the maximum coordinate that a value in this rectangle may have.

pub fn validate(&self, max_size: Option<Vec2<usize>>) -> UnitResult

Validate this instance.

pub fn byte_size() -> usize

Number of bytes this would consume in an exr file.

pub fn write<W: Write>(&self, write: &mut W) -> UnitResult

Without validation, write this instance to the byte stream.

pub fn read<R: Read>(read: &mut R) -> Result<Self>

Read the value without validating.

pub fn with_origin(self, origin: Vec2<i32>) -> Self

Create a new rectangle which is offset by the specified origin.

pub fn contains(self, subset: Self) -> bool

Returns whether the specified rectangle is equal to or inside this rectangle.

Trait Implementations

impl Clone for IntegerBounds

fn clone(&self) -> IntegerBounds

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IntegerBounds

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

Formats the value using the given formatter.

impl Default for IntegerBounds

fn default() -> IntegerBounds

Returns the “default value” for a type.

impl Hash for IntegerBounds

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 PartialEq for IntegerBounds

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

impl Eq for IntegerBounds

impl StructuralPartialEq for IntegerBounds