Skip to main content

Plan

Struct Plan 

Source
pub struct Plan {
    pub mode: Mode,
    pub width: u32,
    pub height: u32,
    pub input_bytes: u64,
    pub output_bytes: u64,
    pub scratch: u64,
}
Expand description

What decoding a texture of a format and a size, from data of a given length, will need and give, worked out before the data is read (plan()).

Fields§

§mode: Mode

The image’s mode: the format’s, or RGBA for a side of 0.

§width: u32

The image’s width: the texture’s, or 0 for a side of 0.

§height: u32

The image’s height: the texture’s, or 0 for a side of 0.

§input_bytes: u64

The bytes of data mip 0 takes, at its padded size; 0 for a side of 0. For crunch, the minimum CRN header size (74), not its variable compressed length.

§output_bytes: u64

The image’s bytes: width x height x the mode’s bytes per pixel.

§scratch: u64

What the decode charges beside the output while it runs, and returns before it ends: an ASTC format’s tables, or a conservative bound for crunch blocks, palettes and Huffman tables; 0 for the rest.

Implementations§

Source§

impl Plan

Source

pub const fn charge(&self) -> u64

What decode() charges the meter for the output: heap_cost of Self::output_bytes (0 for the empty image). The allocator may round the allocation up past it, in which case MeteredVec charges the difference too.

Source

pub const fn peak_charge(&self) -> u64

The most decode() has charged at once: Self::charge and Self::scratch.

Trait Implementations§

Source§

impl Clone for Plan

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Plan

Source§

impl Debug for Plan

Source§

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

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

impl Eq for Plan

Source§

impl PartialEq for Plan

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Plan

Auto Trait Implementations§

§

impl Forget for Plan

§

impl Freeze for Plan

§

impl Move for Plan

§

impl RefUnwindSafe for Plan

§

impl Send for Plan

§

impl Sync for Plan

§

impl Unpin for Plan

§

impl UnsafeUnpin for Plan

§

impl UnwindSafe for Plan

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> Same for T

Source§

type Output = T

Should always be Self
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.