Enum all_is_cubes::block::Resolution

#[non_exhaustive]
#[repr(u8)]
pub enum Resolution {
    R1 = 0,
    R2 = 1,
    R4 = 2,
    R8 = 3,
    R16 = 4,
    R32 = 5,
    R64 = 6,
    R128 = 7,
}

Scale factor between a Block and its component voxels.

This resolution cubed is the number of voxels making up a block.

Resolutions are always powers of 2. This ensures that the arithmetic is well-behaved (no division by zero, exact floating-point representation, and the potential of fixed-point representation), and that it is always possible to subdivide a block further (up to the limit) without shifting the existing voxel boundaries.

Note that while quite high resolutions are permitted, this does not mean that it is practical to routinely use full blocks at that resolution. For example, 64 × 64 × 64 = 262,144 voxels, occupying several megabytes just for color data. High resolutions are permitted for special purposes that do not necessarily use the full cube volume:

• Thin blocks (e.g. 128 × 128 × 1) can display high resolution text and other 2D images.
• Multi-block structures can be defined using Modifier::Zoom; their total size is limited by the resolution limit.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

R1 = 0

R2 = 1

R4 = 2

R8 = 3

R16 = 4

R32 = 5

R64 = 6

R128 = 7

Implementations

impl Resolution

pub const MAX: Resolution = Resolution::R128

The maximum available resolution.

pub const fn double(self) -> Option<Resolution>

Returns the Resolution that’s twice this one, or None at the limit.

pub const fn halve(self) -> Option<Resolution>

Returns the Resolution that’s half this one, or None if self is R1.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for Resolution

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Resolution, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Resolution, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for Resolution

fn clone(&self) -> Resolution

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Resolution

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Resolution

fn deserialize<D>( deserializer: D, ) -> Result<Resolution, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Resolution

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

Formats the value using the given formatter.

impl Div for Resolution

type Output = Option<Resolution>

The resulting type after applying the / operator.

fn div(self, rhs: Resolution) -> <Resolution as Div>::Output

Performs the / operation.

impl Exhaust for Resolution

type Iter = ExhaustResolution

Type of iterator returned by Self::exhaust().

fn exhaust() -> <Resolution as Exhaust>::Iter

Returns an iterator over all values of this type.

impl Hash for Resolution

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 Mul for Resolution

type Output = Option<Resolution>

The resulting type after applying the * operator.

fn mul(self, rhs: Resolution) -> <Resolution as Mul>::Output

Performs the * operation.

impl Ord for Resolution

fn cmp(&self, other: &Resolution) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Resolution

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Resolution

fn partial_cmp(&self, other: &Resolution) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Resolution

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<i128> for Resolution

type Error = IntoResolutionError<i128>

The type returned in the event of a conversion error.

fn try_from( value: i128, ) -> Result<Resolution, <Resolution as TryFrom<i128>>::Error>

Performs the conversion.

impl TryFrom<i16> for Resolution

type Error = IntoResolutionError<i16>

The type returned in the event of a conversion error.

fn try_from( value: i16, ) -> Result<Resolution, <Resolution as TryFrom<i16>>::Error>

Performs the conversion.

impl TryFrom<i32> for Resolution

type Error = IntoResolutionError<i32>

The type returned in the event of a conversion error.

fn try_from( value: i32, ) -> Result<Resolution, <Resolution as TryFrom<i32>>::Error>

Performs the conversion.

impl TryFrom<i64> for Resolution

type Error = IntoResolutionError<i64>

The type returned in the event of a conversion error.

fn try_from( value: i64, ) -> Result<Resolution, <Resolution as TryFrom<i64>>::Error>

Performs the conversion.

impl TryFrom<isize> for Resolution

type Error = IntoResolutionError<isize>

The type returned in the event of a conversion error.

fn try_from( value: isize, ) -> Result<Resolution, <Resolution as TryFrom<isize>>::Error>

Performs the conversion.

impl TryFrom<u128> for Resolution

type Error = IntoResolutionError<u128>

The type returned in the event of a conversion error.

fn try_from( value: u128, ) -> Result<Resolution, <Resolution as TryFrom<u128>>::Error>

Performs the conversion.

impl TryFrom<u16> for Resolution

type Error = IntoResolutionError<u16>

The type returned in the event of a conversion error.

fn try_from( value: u16, ) -> Result<Resolution, <Resolution as TryFrom<u16>>::Error>

Performs the conversion.

impl TryFrom<u32> for Resolution

type Error = IntoResolutionError<u32>

The type returned in the event of a conversion error.

fn try_from( value: u32, ) -> Result<Resolution, <Resolution as TryFrom<u32>>::Error>

Performs the conversion.

impl TryFrom<u64> for Resolution

type Error = IntoResolutionError<u64>

The type returned in the event of a conversion error.

fn try_from( value: u64, ) -> Result<Resolution, <Resolution as TryFrom<u64>>::Error>

Performs the conversion.

impl TryFrom<usize> for Resolution

type Error = IntoResolutionError<usize>

The type returned in the event of a conversion error.

fn try_from( value: usize, ) -> Result<Resolution, <Resolution as TryFrom<usize>>::Error>

Performs the conversion.

impl Copy for Resolution

impl Eq for Resolution

impl StructuralPartialEq for Resolution