Struct image::codecs::dxt::DxtDecoder

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

👎Deprecated: DXT support will be removed or reworked in a future version. Prefer the squish crate instead. See https://github.com/image-rs/image/issues/1623

DXT decoder

Fields

inner: R

👎Deprecated: DXT support will be removed or reworked in a future version. Prefer the squish crate instead. See https://github.com/image-rs/image/issues/1623

width_blocks: u32

👎Deprecated: DXT support will be removed or reworked in a future version. Prefer the squish crate instead. See https://github.com/image-rs/image/issues/1623

height_blocks: u32

👎Deprecated: DXT support will be removed or reworked in a future version. Prefer the squish crate instead. See https://github.com/image-rs/image/issues/1623

variant: DxtVariant

👎Deprecated: DXT support will be removed or reworked in a future version. Prefer the squish crate instead. See https://github.com/image-rs/image/issues/1623

row: u32

👎Deprecated: DXT support will be removed or reworked in a future version. Prefer the squish crate instead. See https://github.com/image-rs/image/issues/1623

Implementations

impl<R: Read> DxtDecoder<R>

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

👎Deprecated: DXT support will be removed or reworked in a future version. Prefer the squish crate instead. See https://github.com/image-rs/image/issues/1623

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 read_scanline(&mut self, buf: &mut [u8]) -> Result<usize>

👎Deprecated: DXT support will be removed or reworked in a future version. Prefer the squish crate instead. See https://github.com/image-rs/image/issues/1623

Trait Implementations

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

type Reader = DxtReader<R>

The type of reader produced by into_reader.

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 scanline_bytes(&self) -> u64

👎Deprecated: Planned for removal. See https://github.com/image-rs/image/issues/1989

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().

fn into_reader(self) -> ImageResult<Self::Reader>

👎Deprecated: Planned for removal. See https://github.com/image-rs/image/issues/1989

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.

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

Returns all the bytes in the image.

fn original_color_type(&self) -> ExtendedColorType

Returns the color type of the image file before decoding

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

Returns the ICC color profile embedded in the image

fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image.

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

👎Deprecated: Use read_image instead. See https://github.com/image-rs/image/issues/1989

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

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

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

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

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

👎Deprecated: Use read_image instead. See https://github.com/image-rs/image/issues/1989

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

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

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