Struct image::dxt::DXTDecoder

pub struct DXTDecoder<R: Read> { /* fields omitted */ }

DXT decoder

Methods

impl<R: Read> DXTDecoder<R>

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<R: Read> ImageDecoder for DXTDecoder<R>

Note that, due to the way that DXT compression works, a scanline is considered to consist out of 4 lines of pixels.

fn dimensions(&mut self) -> ImageResult<(u32, u32)>

Returns a tuple containing the width and height of the image

fn colortype(&mut self) -> ImageResult<ColorType>

Returns the color type of the image e.g. RGB(8) (8bit RGB)

fn row_len(&mut self) -> ImageResult<usize>

Returns the length in bytes of one decoded row of the image

fn read_scanline(&mut self, buf: &mut [u8]) -> ImageResult<u32>

Reads one row from the image into buf and returns the row index

fn read_image(&mut self) -> ImageResult<DecodingResult>

Decodes the entire image and return it as a Vector

fn is_animated(&mut self) -> ImageResult<bool>

Returns true if the image is animated

fn into_frames(self) -> ImageResult<Frames>

Returns the frames of the image

fn load_rect(
    &mut self,
    x: u32,
    y: u32,
    length: u32,
    width: u32
) -> ImageResult<Vec<u8>>

Decodes a specific region of the image, represented by the rectangle starting from x and y and having length and width