picolo 0.3.7

A simple crate for breaking down images into its bareboned data. Uses the fantastic image crate.
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

//! Picolo is a simple libary for reading all the data prescribed in an image: The dimensions of the image and all pixels
//!
//! [`with_capacity`]: #method.with_capacity
//!
//! # Example
//!
//! Basic usage for reading and translating a complete
//! Image and translating it to a comprehensive table:  
//! ```
//! use picolo::readimg::load_picture;
//! // Function takes in image path and precision variable:
//! // 100 = 100% of all pixels, 50 = 50% ...:
//! let pixl_struct = load_picture("icon.png", 50);
//!
//! for i in pixl_struct {
//!     println!("{:?}", i); 
//! }
//! ```

use image::GenericImageView;

/// Rgba struct
#[derive(Debug)]
pub struct Color {
    pub red: u8,
    pub blue: u8,
    pub green: u8,
    pub alpha: u8,
}

/// Pixel struct that also derives Color struct
#[derive(Debug)]
pub struct Pixel {
    pub x: u32,
    pub y: u32,
    pub color: Color,
}

/// Returns the width of image as u32
pub fn get_width(img: &str) -> u32 {
    let img = image::open(img).unwrap();
    img.width()
}

/// Returns height of the image as u32
pub fn get_height(img: &str) -> u32 {
    let img = image::open(img).unwrap();
    img.width()
}

/// Takes a borrowed string slice `Str` as its path and usize for precision.
///
/// [`with_capacity`]: #method.with_capacity
///
/// # Example
///
/// A more practical example generating a full table 
/// consisting of each and every pixel
/// from a map called images next to src:
/// ```
/// use picolo::readimg::load_picture;
/// let foo = "icon.png"; 
/// let bar_str = &foo;
/// let pixl_struct = load_picture(bar_str, 100);
///
/// for i in pixl_struct {
///     println!("x {} y {} red {} green {} blue: {}", i[0].x, i[0].y, 
///     i[0].color.red, i[0].color.green, i[0].color.blue);
/// }
/// ```

/// Public function that loads a picture
/// @params: img as &str, precision as <u32>
pub fn load_picture(img: &str, precision: u32) -> Vec<[Pixel; 1]> {

    let mut vec_struct = Vec::new();
    let img = image::open(img).unwrap();

    if precision < 0 || precision > 100 {
        panic!("Precision cannot be value {} because it's either under 0%
        or above 100%",
        precision); 
    };

    for i in 0..(img.height() * precision / 100) {
        for j in 0..(img.width() * precision / 100) {
            let img_pixel = img.get_pixel(j, i);
            let pxl = [
                Pixel {
                    x: i,
                    y: j,
                    color: Color {
                                red: img_pixel[0], 
                                green: img_pixel[1], 
                                blue: img_pixel[2], 
                                alpha: img_pixel[3]
                            },
                },
            ];
            vec_struct.push(pxl);
        }
    };
    vec_struct
}