zune-core 0.2.1

Core utilities for image processing in the zune family of crates
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//! Decoder and Encoder Options
//!
//! This module exposes a struct for which all implemented
//! decoders get shared options for decoding
//!
//! All supported options are put into one _Options to allow for global configurations
//! options e.g the same  `DecoderOption` can be reused for all other decoders
//!
pub use decoder::DecoderOptions;

use crate::bit_depth::BitDepth;
use crate::colorspace::ColorSpace;

mod decoder;

#[derive(Debug, Copy, Clone)]
pub struct EncoderOptions
{
    /// The image width
    ///
    /// This is the width the image will be encoded in
    ///
    ///
    /// # Note
    /// Images have different width and height limit,
    /// encoding an image larger than that limit is an error.
    ///
    /// Consult with your favourite image codec on its limit
    pub width:      usize,
    /// The image height
    ///
    /// This is the height the image will be encoded in.
    ///
    /// # Note
    /// Images have different width and height limit,
    /// encoding an image larger than that limit is an error.
    ///
    /// Consult with your favourite image codec on its limit
    pub height:     usize,
    /// The colorspace the pixels are in.
    ///
    /// # Note
    /// Each encoder has different set of supported colorspaces.
    ///
    /// Check with your favourite image codec on its limit.
    pub colorspace: ColorSpace,
    /// The quality expected for the image
    ///
    /// This has different results depending on encoder.
    ///
    /// - lossy encoders: Higher values, good visual quality/larger file, lower values bad visual quality/smaller file.
    /// - lossless encoders: Higher values, more encoding time/smaller image, lower value, less encoding time/image.
    ///
    ///
    /// Though this is not respected by some encoders, e.g `ppm` doesn't have a notion of quality.
    pub quality:    u8,
    /// The bit depth of the data
    ///
    ///
    /// The data is expected in native endian
    /// the encoder will convert the data to whatever endian
    /// is needed by the format.
    ///
    /// - Respected by: `png`,`ppm`
    pub depth:      BitDepth
}

impl Default for EncoderOptions
{
    fn default() -> Self
    {
        Self {
            width:      0,
            height:     0,
            colorspace: ColorSpace::RGB,
            quality:    100,
            depth:      BitDepth::Eight
        }
    }
}

impl EncoderOptions
{
    pub const fn get_width(&self) -> usize
    {
        self.width
    }

    pub const fn get_height(&self) -> usize
    {
        self.height
    }
    pub const fn get_depth(&self) -> BitDepth
    {
        self.depth
    }
    pub const fn get_quality(&self) -> u8
    {
        self.quality
    }
    pub const fn get_colorspace(&self) -> ColorSpace
    {
        self.colorspace
    }
}