Struct Size 

pub struct Size {
    pub x: u32,
    pub y: u32,
    pub z: u32,
}

3D size in blocks.

Used by Chunk.

Fields

x: u32

y: u32

z: u32

Implementations

impl Size

pub const fn new(x: u32, y: u32, z: u32) -> Self

pub fn contains(self, coordinate: impl Into<Coordinate>) -> bool

Returns true if the offset Coordinate is within the size.

pub const fn index_to_offset(self, index: usize) -> Coordinate

Convert a Chunk index to an offset Coordinate.

pub fn offset_to_index(self, coordinate: impl Into<Coordinate>) -> usize

Convert an offset Coordinate to a Chunk index.

pub fn volume(self) -> usize

Returns the amount of blocks in the cuboid volume.

pub fn flat(self) -> Size2D

Trait Implementations

impl Add<Size2D> for Size

type Output = Size

The resulting type after applying the + operator.

fn add(self, rhs: Size2D) -> Self::Output

Performs the + operation.

impl<T> Add<T> for Size

where T: Into<Self>,

type Output = Size

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl Clone for Size

fn clone(&self) -> Size

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Size

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

Formats the value using the given formatter.

impl Display for Size

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

Formats the value using the given formatter.

impl Div<u32> for Size

type Output = Size

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> Self::Output

Performs the / operation.

impl From<[u32; 3]> for Size

fn from(value: [u32; 3]) -> Self

Converts to this type from the input type.

impl From<(u32, u32, u32)> for Size

fn from(value: (u32, u32, u32)) -> Self

Converts to this type from the input type.

impl From<Size> for Size2D

fn from(size: Size) -> Self

Converts to this type from the input type.

impl Hash for Size

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<T> Mul<T> for Size

where T: Into<Self>,

type Output = Size

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl Mul<u32> for Size

type Output = Size

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> Self::Output

Performs the * operation.

impl PartialEq for Size

fn eq(&self, other: &Size) -> 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 Sub<Size2D> for Size

type Output = Size

The resulting type after applying the - operator.

fn sub(self, rhs: Size2D) -> Self::Output

Performs the - operation.

impl<T> Sub<T> for Size

where T: Into<Self>,

type Output = Size

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl Copy for Size

impl Eq for Size

impl StructuralPartialEq for Size