Struct image_texel::layout::TexelLayout

pub struct TexelLayout { /* private fields */ }

Describes the byte layout of an texture element, untyped.

This is not so different from Texel and Layout but is a combination of both. It has the same invariants on alignment as the former which being untyped like the latter. The alignment of an element must be at most that of MaxAligned and the size must be a multiple of its alignment.

This type is a lower semi lattice. That is, given two elements the type formed by taking the minimum of size and alignment individually will always form another valid element. This operation is implemented in the Self::infimum method.

Implementations

impl TexelLayout

pub fn from_pixel<P: AsTexel>() -> Self

Construct an element from a self-evident pixel.

pub const MAX_SIZE: Self = { TexelLayout { size: isize::MAX as usize, align: 1, } }

An element with maximum size and no alignment requirements.

This constructor is mainly useful for the purpose of using it as a modifier. When used with Self::infimum it will only shrink the alignment and keep the size unchanged.

pub fn with_layout(layout: Layout) -> Option<Self>

Create an element for a fictional type with specific layout.

It’s up to the caller to define or use an actual type with that same layout later. This skips the check that such a type must not contain any padding and only performs the layout related checks.

pub fn layout(self) -> Layout

Convert this into a type layout.

This can never fail as TexelLayout refines the standard library layout type.

pub fn packed(self, align: usize) -> TexelLayout

Reduce the alignment of the element.

This will perform the same modification as repr(packed) on the element’s type.

Panics

This method panics if align is not a valid alignment.

pub fn infimum(self, other: Self) -> TexelLayout

Create an element having the smaller of both sizes and alignments.

pub const fn size(self) -> usize

Get the size of the element.

pub const fn align(self) -> usize

Get the minimum required alignment of the element.

pub const fn superset_of(&self, other: TexelLayout) -> bool

Trait Implementations

impl Clone for TexelLayout

fn clone(&self) -> TexelLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TexelLayout

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

Formats the value using the given formatter.

impl<P> From<Texel<P>> for TexelLayout

Convert a pixel to an element, discarding the exact type information.

fn from(pix: Texel<P>) -> Self

Converts to this type from the input type.

impl Hash for TexelLayout

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for TexelLayout

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<TexelLayout> for TexelLayout

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

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

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

This method tests for !=.

impl PartialOrd<TexelLayout> for TexelLayout

The partial order of elements is defined by comparing size and alignment.

This turns it into a semi-lattice structure, with infimum implementing the meet operation. For example, the following comparison all hold:

let u8 = TexelLayout::from(U8);
let u8x2 = TexelLayout::from(U8.array::<2>());
let u8x3 = TexelLayout::from(U8.array::<3>());
let u16 = TexelLayout::from(U16);

assert!(u8 < u16, "due to size and alignment");
assert!(u8x2 < u16, "due to its alignment");
assert!(!(u8x3 < u16) && !(u16 < u8x3), "not comparable");

let meet = u8x3.infimum(u16);
assert!(meet <= u8x3);
assert!(meet <= u16);
assert!(meet == u16.packed(1), "We know it precisely here {:?}", meet);

fn partial_cmp(&self, other: &Self) -> 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 Copy for TexelLayout

impl Eq for TexelLayout

impl StructuralEq for TexelLayout

impl StructuralPartialEq for TexelLayout