Struct DxtDecoder

pub(crate) struct DxtDecoder<R: Read> {
    inner: R,
    width_blocks: u32,
    height_blocks: u32,
    variant: DxtVariant,
    row: u32,
}

DXT decoder

Fields

inner: R

width_blocks: u32

height_blocks: u32

variant: DxtVariant

row: u32

Implementations

impl<R: Read> DxtDecoder<R>

pub(crate) 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

fn scanline_bytes(&self) -> u64

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

Trait Implementations

impl<R: Read> ImageDecoder for DxtDecoder<R>

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

Returns a tuple containing the width and height of the image

fn color_type(&self) -> ColorType

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

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

Returns all the bytes in the image.

fn read_image_boxed(self: Box<Self>, buf: &mut [u8]) -> ImageResult<()>

Use read_image instead; this method is an implementation detail needed so the trait can be object safe.

fn original_color_type(&self) -> ExtendedColorType

Returns the color type of the image file before decoding

fn icc_profile(&mut self) -> ImageResult<Option<Vec<u8>>>

Returns the ICC color profile embedded in the image, or Ok(None) if the image does not have one.

fn exif_metadata(&mut self) -> ImageResult<Option<Vec<u8>>>

Returns the raw Exif chunk, if it is present. A third-party crate such as kamadak-exif is required to actually parse it.

fn orientation(&mut self) -> ImageResult<Orientation>

Returns the orientation of the image.

fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image.

fn set_limits(&mut self, limits: Limits) -> ImageResult<()>

Set the decoder to have the specified limits. See Limits for the different kinds of limits that is possible to set.