Struct DdsDecoder 

pub struct DdsDecoder<R> { /* private fields */ }

DDS decoder.

This decoder supports decoding DDS files with a single texture, including cube maps. Texture arrays and volumes are not supported.

It’s possible to set the color type the image is decoded as using DdsDecoder::set_color_type.

Implementations

impl<R: Read> DdsDecoder<R>

pub fn new(r: R) -> ImageResult<Self>

Create a new decoder that decodes from the stream r

pub fn set_color_type(&mut self, color: ColorType) -> ImageResult<()>

Set the color type for the decoder.

The DDS decoder supports decoding images not just in their native color format, but any user-defined color format. This is useful for decoding images that do not cleanly fit into the native formats. E.g. the DDS format B5G6R5_UNORM is decoded as ColorType::Rgb8 by default, but you may want to decode it as ColorType::Rgb32F instead to avoid the rounding error when converting to u8. Similarly, your application may only support 8-bit images, while the DDS file is in a 16/32-bit format. Decoding directly into the final color type is more efficient than decoding into the native format and then converting.

Errors

Currently, ColorType::La8 and ColorType::La16 are not supported for decoding DDS files. If these color types (or other unsupported types) are provided, this function will return ImageError::Unsupported with UnsupportedErrorKind::Color.

Trait Implementations

impl<R: Read + Seek> ImageDecoder for DdsDecoder<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 original_color_type(&self) -> ExtendedColorType

Returns the color type of the image file before decoding

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.

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 icc_profile(&mut self) -> Result<Option<Vec<u8>>, ImageError>

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

fn exif_metadata(&mut self) -> Result<Option<Vec<u8>>, ImageError>

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

fn xmp_metadata(&mut self) -> Result<Option<Vec<u8>>, ImageError>

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

fn iptc_metadata(&mut self) -> Result<Option<Vec<u8>>, ImageError>

Returns the raw IPTC chunk, if it is present.

fn orientation(&mut self) -> Result<Orientation, ImageError>

Returns the orientation of the image.

fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image.

impl<R: Read + Seek> ImageDecoderRect for DdsDecoder<R>

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

Decode a rectangular section of the image.