Enum squish::Format

pub enum Format {
    Bc1,
    Bc2,
    Bc3,
}

Defines a compression format

Variants

Bc1Bc2Bc3

Methods

impl Format

pub fn decompress(     self,     data: &[u8],     width: usize,     height: usize,     output: &mut [u8] )

Decompresses an image in memory

• data - The compressed image data
• width - The width of the source image
• height - The height of the source image
• output - Space to store the decompressed image

pub fn compressed_size(self, width: usize, height: usize) -> usize

Computes the amount of space in bytes needed for an image of given size, accounting for padding to a multiple of 4x4 pixels

• width - Width of the uncompressed image
• height - Height of the uncompressed image

pub fn compress(     self,     rgba: &[u8],     width: usize,     height: usize,     params: Params,     output: &mut [u8] )

Compresses an image in memory

• rgba - The uncompressed pixel data
• width - The width of the source image
• height - The height of the source image
• params - Additional compressor parameters
• output - Output buffer for the compressed image. Ensure that this has at least as much space available as compute_compressed_size suggests.

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Format

impl Debug for Format

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

Formats the value using the given formatter.

impl Eq for Format

impl PartialEq for Format

fn eq(&self, other: &Format) -> 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 !=.

impl FromStr for Format

type Err = ParseFormatError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Format, ParseFormatError>

Parses a string s to return a value of this type.