image_dds 0.7.2

Convert images to and from compressed DDS formats
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

use thiserror::Error;

#[cfg(feature = "ddsfile")]
use crate::DdsFormatInfo;
use crate::ImageFormat;

/// Errors that can occur while creating a decoded image.
#[derive(Debug, Error, PartialEq)]
pub enum CreateImageError {
    #[error("data length {data_length} is not valid for a {width}x{height} image")]
    InvalidSurfaceDimensions {
        width: u32,
        height: u32,
        data_length: usize,
    },

    #[error("error decompressing surface: {0}")]
    DecompressSurface(#[from] SurfaceError),

    #[error("{mipmaps} mipmaps exceeds the maximum expected mipmap count of {max_mipmaps}")]
    UnexpectedMipmapCount { mipmaps: u32, max_mipmaps: u32 },
}

/// Errors that can occur while encoding or decoding a surface.
#[derive(Debug, Error, PartialEq)]
pub enum SurfaceError {
    #[error("surface dimensions {width} x {height} x {depth} contain no pixels")]
    ZeroSizedSurface { width: u32, height: u32, depth: u32 },

    #[error("surface pixel count {width} x {height} x {depth} would overflow")]
    PixelCountWouldOverflow { width: u32, height: u32, depth: u32 },

    #[error("surface dimensions {width} x {height} x {depth} are not divisibly by the block dimensions {block_width} x {block_height}")]
    NonIntegralDimensionsInBlocks {
        width: u32,
        height: u32,
        depth: u32,
        block_width: u32,
        block_height: u32,
    },

    #[error("expected surface to have at least {expected} bytes but found {actual}")]
    NotEnoughData { expected: usize, actual: usize },

    #[error("encoding data to format {format:?} is not supported")]
    UnsupportedEncodeFormat { format: ImageFormat },

    #[error("mipmap count {mipmaps} exceeds the maximum value of {max_total_mipmaps}")]
    InvalidMipmapCount {
        mipmaps: u32,
        height: u32,
        max_total_mipmaps: u32,
    },

    #[error("failed to get image data for layer {layer} mipmap {mipmap}")]
    MipmapDataOutOfBounds { layer: u32, mipmap: u32 },

    #[cfg(feature = "ddsfile")]
    #[error("DDS image format {0:?} is not supported")]
    UnsupportedDdsFormat(DdsFormatInfo),

    #[error("{mipmaps} mipmaps exceeds the maximum expected mipmap count of {max_mipmaps}")]
    UnexpectedMipmapCount { mipmaps: u32, max_mipmaps: u32 },
}