Skip to main content

Region

Struct Region 

Source
#[repr(C, packed(1))]
pub struct Region { pub origin: Origin, pub size: Size, }
Expand description

3D rectangular region (origin + size).

C++ equivalent: MTL::Region

Fields§

§origin: Origin§size: Size

Implementations§

Source§

impl Region

Source

pub const fn new(origin: Origin, size: Size) -> Self

Create a new Region from origin and size.

Source

pub const fn new_1d(x: UInteger, width: UInteger) -> Self

Create a 1D region.

C++ equivalent: Region(NS::UInteger x, NS::UInteger width)

Source

pub const fn new_2d( x: UInteger, y: UInteger, width: UInteger, height: UInteger, ) -> Self

Create a 2D region.

C++ equivalent: Region(NS::UInteger x, NS::UInteger y, NS::UInteger width, NS::UInteger height)

Source

pub const fn new_3d( x: UInteger, y: UInteger, z: UInteger, width: UInteger, height: UInteger, depth: UInteger, ) -> Self

Create a 3D region.

C++ equivalent: Region(NS::UInteger x, NS::UInteger y, NS::UInteger z, NS::UInteger width, NS::UInteger height, NS::UInteger depth)

Source

pub const fn make_1d(x: UInteger, width: UInteger) -> Self

Create a 1D region (C++ style factory method).

C++ equivalent: static Region Make1D(NS::UInteger x, NS::UInteger width)

Source

pub const fn make_2d( x: UInteger, y: UInteger, width: UInteger, height: UInteger, ) -> Self

Create a 2D region (C++ style factory method).

C++ equivalent: static Region Make2D(NS::UInteger x, NS::UInteger y, NS::UInteger width, NS::UInteger height)

Source

pub const fn make_3d( x: UInteger, y: UInteger, z: UInteger, width: UInteger, height: UInteger, depth: UInteger, ) -> Self

Create a 3D region (C++ style factory method).

C++ equivalent: static Region Make3D(NS::UInteger x, NS::UInteger y, NS::UInteger z, NS::UInteger width, NS::UInteger height, NS::UInteger depth)

Trait Implementations§

Source§

impl Clone for Region

Source§

fn clone(&self) -> Region

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Region

Source§

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

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

impl Default for Region

Source§

fn default() -> Region

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

impl Hash for Region

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 Region

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Region

Source§

impl Eq for Region

Source§

impl StructuralPartialEq for Region

Auto Trait Implementations§

§

impl Freeze for Region

§

impl RefUnwindSafe for Region

§

impl Send for Region

§

impl Sync for Region

§

impl Unpin for Region

§

impl UnwindSafe for Region

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> 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.