verdant 0.4.7

A WIP windowing and rendering library, built on a modern foundation, aiming to be lightweight, performant, and powerful.
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236

use std::{fs, path::{Path, PathBuf}, sync::atomic::{AtomicUsize, Ordering}};

use bytemuck::{Pod, Zeroable};

use crate::{RendererResult, rgb, rgba, vec::Vec4};

static NEXT_ID: AtomicUsize = AtomicUsize::new(0);
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct WindowId(pub(crate) usize);

impl WindowId {
    pub(crate) fn new() -> Self {
        Self(NEXT_ID.fetch_add(1, Ordering::Relaxed))
    }
}

// TODO: windows have quite a few more properties than this
#[derive(Debug, Clone, Default)]
pub struct WindowProperties {
    pub width: u32,
    pub height: u32,

    pub title: String,

    pub resizable: bool,

    pub transparent: bool,
}

#[repr(C)]
#[derive(Debug, Clone, Copy, Default, Pod, Zeroable, PartialEq)]
pub struct Color {
    /// Red component of the color
    pub r: f32,
    /// Green component of the color
    pub g: f32,
    /// Blue component of the color
    pub b: f32,
    /// Alpha component of the color
    pub a: f32,
}

impl Color {
    /// Returns the color with its RGB channels multiplied by its alpha to be used in contexts that
    /// expect premultiplied color.
    pub fn premultiplied(self) -> Self {
        Self {
            r: self.r * self.a,
            g: self.g * self.a,
            b: self.b * self.a,
            a: self.a,
        }
    }

    /// Converts the color from linear to sRGB color space using a 2.2 gamma.
    pub fn to_srgb(self) -> Self {
        Self {
            r: self.r.powf(1. / 2.2),
            g: self.g.powf(1. / 2.2),
            b: self.b.powf(1. / 2.2),
            a: self.a,
        }
    }

    /// Returns the color with its RGB channels inverted, preserving the alpha.
    pub fn inverted(self) -> Self {
        Self {
            r: 1. - self.r,
            g: 1. - self.g,
            b: 1. - self.b,
            a: self.a,
        }
    }

    /// Returns the color with all channels inverted, including alpha.
    pub fn fully_inverted(self) -> Self {
        Self {
            r: 1. - self.r,
            g: 1. - self.g,
            b: 1. - self.b,
            a: 1. - self.a,
        }
    }
}

impl From<Color> for wgpu::Color {
    fn from(v: Color) -> Self {
        Self { r: v.r as f64, g: v.g as f64, b: v.b as f64, a: v.a as f64 }
    }
}

impl From<[f32; 4]> for Color {
    fn from(v: [f32; 4]) -> Self {
        Self { r: v[0], g: v[1], b: v[2], a: v[3] }
    }
}

impl From<Vec4> for Color {
    fn from(v: Vec4) -> Self {
        Self { r: v.x, g: v.y, b: v.z, a: v.w }
    }
}

impl From<Color> for [f32; 4] {
    fn from(v: Color) -> Self {
        [v.r, v.g, v.b, v.a]
    }
}

// based on web/CSS conventions
impl Color {
    pub const TRANSPARENT: Self = rgba(0., 0., 0., 0.);

    // Neutrals
    pub const BLACK:       Self = rgb(0.,    0.,    0.   );
    pub const WHITE:       Self = rgb(1.,    1.,    1.   );
    pub const DARK_GRAY:   Self = rgb(0.25,  0.25,  0.25 );
    pub const GRAY:        Self = rgb(0.5,   0.5,   0.5  );
    pub const LIGHT_GRAY:  Self = rgb(0.75,  0.75,  0.75 );
    pub const SILVER:      Self = rgb(0.753, 0.753, 0.753);

    // Reds
    pub const RED:         Self = rgb(1.,    0.,    0.   );
    pub const DARK_RED:    Self = rgb(0.545, 0.,    0.   );
    pub const CRIMSON:     Self = rgb(0.863, 0.078, 0.235);
    pub const TOMATO:      Self = rgb(1.,    0.388, 0.278);
    pub const SALMON:      Self = rgb(0.980, 0.502, 0.447);

    // Pinks & Magentas
    pub const PINK:        Self = rgb(1.,    0.753, 0.796);
    pub const HOT_PINK:    Self = rgb(1.,    0.412, 0.706);
    pub const DEEP_PINK:   Self = rgb(1.,    0.078, 0.576);
    pub const MAGENTA:     Self = rgb(1.,    0.,    1.   );

    // Oranges
    pub const ORANGE_RED:  Self = rgb(1.,    0.271, 0.   );
    pub const ORANGE:      Self = rgb(1.,    0.647, 0.   );
    pub const GOLD:        Self = rgb(1.,    0.843, 0.   );

    // Yellows
    pub const YELLOW:      Self = rgb(1.,    1.,    0.   );
    pub const KHAKI:       Self = rgb(0.941, 0.902, 0.549);

    // Greens
    pub const LIME:        Self = rgb(0.,    1.,    0.   );
    pub const GREEN:       Self = rgb(0.,    0.502, 0.   );
    pub const DARK_GREEN:  Self = rgb(0.,    0.392, 0.   );
    pub const FOREST_GREEN:Self = rgb(0.133, 0.545, 0.133);
    pub const OLIVE:       Self = rgb(0.502, 0.502, 0.   );
    pub const YELLOW_GREEN:Self = rgb(0.604, 0.804, 0.196);
    pub const SPRING_GREEN:Self = rgb(0.,    1.,    0.498);

    // Cyans & Teals
    pub const CYAN:        Self = rgb(0.,    1.,    1.   );
    pub const TEAL:        Self = rgb(0.,    0.502, 0.502);
    pub const TURQUOISE:   Self = rgb(0.251, 0.878, 0.816);
    pub const AQUAMARINE:  Self = rgb(0.498, 1.,    0.831);

    // Blues
    pub const BLUE:        Self = rgb(0.,    0.,    1.   );
    pub const DARK_BLUE:   Self = rgb(0.,    0.,    0.545);
    pub const NAVY:        Self = rgb(0.,    0.,    0.502);
    pub const ROYAL_BLUE:  Self = rgb(0.255, 0.412, 0.882);
    pub const STEEL_BLUE:  Self = rgb(0.275, 0.510, 0.706);
    pub const SKY_BLUE:    Self = rgb(0.529, 0.808, 0.922);
    pub const CORNFLOWER:  Self = rgb(0.392, 0.584, 0.929);
    pub const DODGER_BLUE: Self = rgb(0.118, 0.565, 1.   );

    // Purples & Violets
    pub const PURPLE:      Self = rgb(0.502, 0.,    0.502);
    pub const VIOLET:      Self = rgb(0.933, 0.510, 0.933);
    pub const INDIGO:      Self = rgb(0.294, 0.,    0.510);
    pub const LAVENDER:    Self = rgb(0.902, 0.902, 0.980);
    pub const ORCHID:      Self = rgb(0.855, 0.439, 0.839);
    pub const PLUM:        Self = rgb(0.867, 0.627, 0.867);

    // Browns
    pub const BROWN:       Self = rgb(0.647, 0.165, 0.165);
    pub const SIENNA:      Self = rgb(0.627, 0.322, 0.176);
    pub const SADDLE_BROWN:Self = rgb(0.545, 0.271, 0.075);
    pub const TAN:         Self = rgb(0.824, 0.706, 0.549);
    pub const BEIGE:       Self = rgb(0.961, 0.961, 0.863);
}

pub trait IntoArray<T, const N: usize> {
    fn into_array(self) -> [T; N];
}

impl<T, U, const N: usize> IntoArray<U, N> for [T; N]
where
    U: From<T>,
{
    fn into_array(self) -> [U; N] {
        self.map(U::from)
    }
}

/// A source of raw bytes, either from a file path or existing byte data.
/// Accepts strings and paths (read from disk) and byte slices, arrays, and vecs (used directly).
/// This means you can pass either a file path or `include_bytes!(...)` anywhere this is accepted.
pub trait ByteSource {
    /// Returns the bytes from this source.
    fn load(self) -> RendererResult<Vec<u8>>;
}

impl ByteSource for &str {
    fn load(self) -> RendererResult<Vec<u8>> { Ok(fs::read(self)?) }
}

impl ByteSource for String {
    fn load(self) -> RendererResult<Vec<u8>> { Ok(fs::read(self)?) }
}

impl ByteSource for &Path {
    fn load(self) -> RendererResult<Vec<u8>> { Ok(fs::read(self)?) }
}

impl ByteSource for PathBuf {
    fn load(self) -> RendererResult<Vec<u8>> { Ok(fs::read(self)?) }
}

impl ByteSource for &[u8] {
    fn load(self) -> RendererResult<Vec<u8>> { Ok(self.to_vec()) }
}

impl<const N: usize> ByteSource for [u8; N] {
    fn load(self) -> RendererResult<Vec<u8>> { Ok(self.to_vec()) }
}

impl<const N: usize> ByteSource for &[u8; N] {
    fn load(self) -> RendererResult<Vec<u8>> { Ok(self.to_vec()) }
}

impl ByteSource for Vec<u8> {
    fn load(self) -> RendererResult<Vec<u8>> { Ok(self) }
}