Struct nannou::image::dxt::DxtDecoder

pub struct DxtDecoder<R> where
    R: Read,  { /* fields omitted */ }

DXT decoder

Implementations

impl<R> DxtDecoder<R> where
    R: Read, 

pub fn new(
    r: R,
    width: u32,
    height: u32,
    variant: DXTVariant
) -> Result<DxtDecoder<R>, ImageError>

Create a new DXT decoder that decodes from the stream r. As DXT is often stored as raw buffers with the width/height somewhere else the width and height of the image need to be passed in width and height, as well as the DXT variant in variant. width and height are required to be powers of 2 and at least 4. otherwise an error will be returned

Trait Implementations

impl<'a, R> ImageDecoder<'a> for DxtDecoder<R> where
    R: 'a + Read, 

type Reader = DxtReader<R>

The type of reader produced by into_reader.

pub fn dimensions(&self) -> (u32, u32)

Returns a tuple containing the width and height of the image

pub fn color_type(&self) -> ColorType

Returns the color type of the image data produced by this decoder

pub fn scanline_bytes(&self) -> u64

Returns the minimum number of bytes that can be efficiently read from this decoder. This may be as few as 1 or as many as total_bytes().

pub fn into_reader(
    self
) -> Result<<DxtDecoder<R> as ImageDecoder<'a>>::Reader, ImageError>

Returns a reader that can be used to obtain the bytes of the image. For the best performance, always try to read at least scanline_bytes from the reader at a time. Reading fewer bytes will cause the reader to perform internal buffering.

pub fn read_image(self, buf: &mut [u8]) -> Result<(), ImageError>

Returns all the bytes in the image.

pub fn original_color_type(&self) -> ExtendedColorType

Retuns the color type of the image file before decoding

pub fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image.

pub fn read_image_with_progress<F>(
    self,
    buf: &mut [u8],
    progress_callback: F
) -> Result<(), ImageError> where
    F: Fn(Progress), 

Same as read_image but periodically calls the provided callback to give updates on loading progress.

impl<'a, R> ImageDecoderExt<'a> for DxtDecoder<R> where
    R: 'a + Read + Seek, 

pub fn read_rect_with_progress<F>(
    &mut self,
    x: u32,
    y: u32,
    width: u32,
    height: u32,
    buf: &mut [u8],
    progress_callback: F
) -> Result<(), ImageError> where
    F: Fn(Progress), 

Decode a rectangular section of the image, periodically reporting progress.

pub fn read_rect(
    &mut self,
    x: u32,
    y: u32,
    width: u32,
    height: u32,
    buf: &mut [u8]
) -> Result<(), ImageError>

Decode a rectangular section of the image; see read_rect_with_progress().