devela/lang/glsl/
types.rs

Help
1// devela::lang::glsl
2//
3//! GLSL types.
4//
5// TOC
6// - data types definitions
7// - impl_matrix_methods! macro
8// - tests
9
10#![allow(non_camel_case_types, missing_docs)]
11
12pub use data_types::*;
13
14#[rustfmt::skip]
15mod data_types {
16    use crate::TAG_PRIMITIVE;
17
18    /* scalars */
19
20    #[doc = TAG_PRIMITIVE!()] /// A GLSL boolean.
21    pub type g_bool = bool;
22
23    #[doc = TAG_PRIMITIVE!()] /// A GLSL single-precision floating-point number.
24    pub type g_float = f32;
25    #[doc = TAG_PRIMITIVE!()] /// A GLSL double-precision floating-point number.
26    pub type g_double = f64;
27
28    #[doc = TAG_PRIMITIVE!()] /// A GLSL signed 32-bit integer.
29    pub type g_int = i32;
30    #[doc = TAG_PRIMITIVE!()] /// A GLSL unsigned 32-bit integer.
31    pub type g_uint = u32;
32
33    /* vectors */
34
35    /// Equivalent to GLSL `bvec2`, a vector of 2×[`g_bool`]s.
36    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
37    pub struct g_bvec2 { pub x: bool, pub y: bool }
38    /// Equivalent to GLSL `bvec3`, a vector of 3×[`g_bool`]s.
39    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
40    pub struct g_bvec3 { pub x: bool, pub y: bool, pub z: bool }
41    /// Equivalent to GLSL `bvec4`, a vector of 4×[`g_bool`]s.
42    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
43    pub struct g_bvec4 { pub x: bool, pub y: bool, pub z: bool, pub w: bool }
44
45    /// Equivalent to GLSL `vec2`, a vector of 2×[`g_float`]s.
46    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
47    pub struct g_vec2 { pub x: g_float, pub y: g_float }
48    /// Equivalent to GLSL `vec3`, a vector of 3×[`g_float`]s.
49    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
50    pub struct g_vec3 { pub x: g_float, pub y: g_float, pub z: g_float }
51    /// Equivalent to GLSL `vec4`, a vector of 4×[`g_float`]s.
52    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
53    pub struct g_vec4 { pub x: g_float, pub y: g_float, pub z: g_float, pub w: g_float }
54
55    /// Equivalent to GLSL `dvec2`, a vector of 2×[`g_double`]s.
56    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
57    pub struct g_dvec2 { pub x: g_double, pub y: g_double }
58    /// Equivalent to GLSL `dvec3`, a vector of 3×[`g_double`]s.
59    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
60    pub struct g_dvec3 { pub x: g_double, pub y: g_double, pub z: g_double }
61    /// Equivalent to GLSL `dvec4`, a vector of 4×[`g_double`]s.
62    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
63    pub struct g_dvec4 { pub x: g_double, pub y: g_double, pub z: g_double, pub w: g_double }
64
65    /// Equivalent to GLSL `ivec2`, a vector of 2×[`g_int`]s.
66    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
67    pub struct g_ivec2 { pub x: g_int, pub y: g_int }
68    /// Equivalent to GLSL `ivec3`, a vector of 3×[`g_int`]s.
69    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
70    pub struct g_ivec3 { pub x: g_int, pub y: g_int, pub z: g_int }
71    /// Equivalent to GLSL `ivec4`, a vector of 4×[`g_int`]s.
72    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
73    pub struct g_ivec4 { pub x: g_int, pub y: g_int, pub z: g_int, pub w: g_int }
74
75    /// Equivalent to GLSL `ivec2`, a vector of 2×[`g_uint`]s.
76    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
77    pub struct g_uvec2 { pub x: g_uint, pub y: g_uint }
78    /// Equivalent to GLSL `ivec3`, a vector of 3×[`g_uint`]s.
79    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
80    pub struct g_uvec3 { pub x: g_uint, pub y: g_uint, pub z: g_uint }
81    /// Equivalent to GLSL `ivec4`, a vector of 4×[`g_uint`]s.
82    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
83    pub struct g_uvec4 { pub x: g_uint, pub y: g_uint, pub z: g_uint, pub w: g_uint }
84
85    /* matrices */
86
87    /// Equivalent to GLSL `mat2`, a column-major 2×2 matrix of [`g_float`]s.
88    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
89    pub struct g_mat2(pub [g_float; 2 * 2]);
90    /// Equivalent to GLSL `mat2x3`, a column-major 2×3 matrix of [`g_float`]s.
91    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
92    pub struct g_mat2x3(pub [g_float; 2 * 3]);
93    /// Equivalent to GLSL `mat2x4`, a column-major 2×4 matrix of [`g_float`]s.
94    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
95    pub struct g_mat2x4(pub [g_float; 2 * 4]);
96
97    /// Equivalent to GLSL `mat3x2`, a column-major 3×2 matrix of [`g_float`]s.
98    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
99    pub struct g_mat3x2(pub [g_float; 3 * 2]);
100    /// Equivalent to GLSL `mat3x3`, a column-major 3×3 matrix of [`g_float`]s.
101    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
102    pub struct g_mat3(pub [g_float; 3 * 3]);
103    /// Equivalent to GLSL `mat3x4`, a column-major 3×4 matrix of [`g_float`]s.
104    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
105    pub struct g_mat3x4(pub [g_float; 3 * 4]);
106
107    /// Equivalent to GLSL `mat4x2`, a column-major 4×2 matrix of [`g_float`]s.
108    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
109    pub struct g_mat4x2(pub [g_float; 4 * 2]);
110    /// Equivalent to GLSL `mat4x3`, a column-major 4×3 matrix of [`g_float`]s.
111    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
112    pub struct g_mat4x3(pub [g_float; 4 * 3]);
113    /// Equivalent to GLSL `mat4x4`, a column-major 4×4 matrix of [`g_float`]s.
114    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
115    pub struct g_mat4(pub [g_float; 4 * 4]);
116
117    /// Equivalent to GLSL `dmat2`, a column-major 2×2 matrix of [`g_double`]s.
118    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
119    pub struct g_dmat2(pub [g_double; 2 * 2]);
120    /// Equivalent to GLSL `dmat3`, a column-major 3×3 matrix of [`g_double`]s.
121    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
122    pub struct g_dmat3(pub [g_double; 3 * 3]);
123    /// Equivalent to GLSL `dmat4`, a column-major 4×4 matrix of [`g_double`]s.
124    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
125    pub struct g_dmat4(pub [g_double; 4 * 4]);
126
127    /* custom types: vertices */
128
129    /// A convenient 2D GLSL vertex representation with [`g_float`]s (position + UV).
130    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
131    pub struct g_vertex2 { pub pos: g_vec2, pub uv: g_vec2 }
132
133    /// A convenient 3D GLSL vertex representation with [`g_float`]s (position + UV).
134    #[repr(C)] #[derive(Clone, Copy, Debug, Default, PartialEq)]
135    pub struct g_vertex3 { pub pos: g_vec3, pub uv: g_vec2 }
136}
137
138macro_rules! impl_matrix_methods {
139    ($($mat:ident, $inner:ty, $cols:expr, $rows:expr);* $(;)?) => {
140        $(impl $mat {
141            /// Retrieves the value at `(row, col)`, if valid.
142            pub const fn get(&self, row: usize, col: usize) -> Option<$inner> {
143                if let Some(idx) = self.to_index(row, col) { Some(self.0[idx]) } else { None }
144            }
145            /// Converts `(row, col)` into a linear index.
146            pub const fn to_index(&self, row: usize, col: usize) -> Option<usize> {
147                if row < $rows && col < $cols { Some(col * $rows + row) } else { None }
148            }
149            /// Converts a linear index back into `(row, col)`, if valid.
150            pub const fn from_index(&self, index: usize) -> Option<(usize, usize)> {
151                if index < self.0.len() { Some((index % $rows, index / $rows)) } else { None }
152            }
153        })*
154    };
155}
156impl_matrix_methods!(
157    g_mat2, g_float, 2, 2; g_mat2x3, g_float, 2, 3; g_mat2x4, g_float, 2, 4;
158    g_mat3x2, g_float, 3, 2; g_mat3, g_float, 3, 3; g_mat3x4, g_float, 3, 4;
159    g_mat4x2, g_float, 4, 2; g_mat4x3, g_float, 4, 3; g_mat4, g_float, 4, 4;
160    g_dmat2, g_double, 2, 2; g_dmat3, g_double, 3, 3; g_dmat4, g_double, 4, 4;
161);
162
163#[cfg(test)]
164mod tests {
165    use super::g_mat3;
166
167    #[test]
168    fn matrix_methods() {
169        let m = g_mat3([
170            0.0, 1.0, 2.0, // Column 0
171            3.0, 4.0, 5.0, // Column 1
172            6.0, 7.0, 8.0, // Column 2
173        ]);
174
175        // Test `to_index`
176        assert_eq!(m.to_index(0, 0), Some(0));
177        assert_eq!(m.to_index(1, 2), Some(7));
178        assert_eq!(m.to_index(2, 2), Some(8));
179        assert_eq!(m.to_index(3, 2), None); // Out of bounds
180
181        // Test `get`
182        assert_eq!(m.get(1, 2), Some(7.0));
183        assert_eq!(m.get(0, 0), Some(0.0));
184        assert_eq!(m.get(2, 1), Some(5.0));
185        assert_eq!(m.get(3, 1), None); // Out of bounds
186
187        // Test `from_index`
188        assert_eq!(m.from_index(0), Some((0, 0)));
189        assert_eq!(m.from_index(7), Some((1, 2)));
190        assert_eq!(m.from_index(8), Some((2, 2)));
191        assert_eq!(m.from_index(9), None); // Out of bounds
192    }
193}
devela/lang/glsl/types.rs

devela/lang/glsl/
types.rs
