Struct Footprint

pub struct Footprint { /* private fields */ }

Configuration for ASTC block footprint size

This struct provides predefined constants for supported footprint in the specification, as well as a constructor for custom footprint. It is recommended to use only the predefined constants. The constructor can be used when you want to pass in dimensions defined numerically in other file formats.

Implementations

impl Footprint

pub const ASTC_4X4: Footprint

pub const ASTC_5X4: Footprint

pub const ASTC_5X5: Footprint

pub const ASTC_6X5: Footprint

pub const ASTC_6X6: Footprint

pub const ASTC_8X5: Footprint

pub const ASTC_8X6: Footprint

pub const ASTC_10X5: Footprint

pub const ASTC_10X6: Footprint

pub const ASTC_8X8: Footprint

pub const ASTC_10X8: Footprint

pub const ASTC_10X10: Footprint

pub const ASTC_12X10: Footprint

pub const ASTC_12X12: Footprint

pub fn new(block_width: u32, block_height: u32) -> Footprint

Constructs custom footprint. Panic if any of the dimensions is zero.

pub fn block_width(&self) -> u32

Returns the block width.

pub fn block_height(&self) -> u32

Returns the block height.

Trait Implementations

impl Clone for Footprint

fn clone(&self) -> Footprint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Footprint

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

Formats the value using the given formatter.

impl Hash for Footprint

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 Ord for Footprint

fn cmp(&self, other: &Footprint) -> 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,

Restrict a value to a certain interval.

impl PartialEq for Footprint

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Footprint

impl Eq for Footprint

impl StructuralPartialEq for Footprint