Docs and move of materials

Author: Meziu

citro3d/examples/fragment-light.rs

@@ -3,8 +3,8 @@ use std::f32::consts::PI;
 
 use citro3d::{
     attrib, buffer,
-    light::{DistanceAttenuation, LightEnv, Lut, LutId, LutInput, Spotlight},
-    material::{Color, Material},
+    color::Color,
+    light::{DistanceAttenuation, LightEnv, Lut, LutId, LutInput, Material, Spotlight},
     math::{AspectRatio, ClipPlanes, FVec3, Matrix4, Projection, StereoDisplacement},
     render::{self, ClearFlags},
     shader, texenv,
@@ -318,7 +318,7 @@ fn main() {
     // Create a new light instance.
     let light = light_env.as_mut().create_light().unwrap();
     let mut light = light_env.as_mut().light_mut(light).unwrap();
-    light.as_mut().set_color(1.0, 1.0, 1.0); // White color
+    light.as_mut().set_color(Color::new(1.0, 1.0, 1.0)); // White color
     light.as_mut().set_position(FVec3::new(0.0, 0.0, -1.0)); // Approximately emitting from the camera
     // Set how the light attenuates over distance.
     // This particular LUT is optimized to work between 0 and 10 units of distance from the light point.
@@ -331,7 +331,7 @@ fn main() {
     // Subtle spotlight pointed at the top of the cube.
     let light = light_env.as_mut().create_light().unwrap();
     let mut light = light_env.as_mut().light_mut(light).unwrap();
-    light.as_mut().set_color(0.5, 0.5, 0.5);
+    light.as_mut().set_color(Color::new(0.5, 0.5, 0.5));
     light
         .as_mut()
         .set_spotlight(Some(Spotlight::with_cutoff(PI / 8.0))); // Spotlight angle of PI/6

citro3d/src/color.rs

@@ -0,0 +1,25 @@
+//! Color manipulation module.
+
+/// RGB color in linear space ([0, 1]).
+#[derive(Debug, Default, Clone, Copy)]
+pub struct Color {
+    pub r: f32,
+    pub g: f32,
+    pub b: f32,
+}
+
+impl Color {
+    pub fn new(r: f32, g: f32, b: f32) -> Self {
+        Self { r, g, b }
+    }
+
+    /// Splits the color into RGB ordered parts.
+    pub fn to_parts_rgb(self) -> [f32; 3] {
+        [self.r, self.g, self.b]
+    }
+
+    /// Splits the color into BGR ordered parts.
+    pub fn to_parts_bgr(self) -> [f32; 3] {
+        [self.b, self.g, self.r]
+    }
+}

citro3d/src/lib.rs

@@ -19,9 +19,9 @@
 
 pub mod attrib;
 pub mod buffer;
+pub mod color;
 pub mod error;
 pub mod light;
-pub mod material;
 pub mod math;
 pub mod render;
 pub mod shader;

citro3d/src/light.rs

@@ -43,7 +43,7 @@ use std::{marker::PhantomPinned, mem::MaybeUninit, ops::Range, pin::Pin};
 use pin_array::PinArray;
 
 use crate::{
-    material::Material,
+    color::Color,
     math::{FVec3, FVec4},
 };
 
@@ -99,6 +99,28 @@ pub struct Light {
     _pin: PhantomPinned,
 }
 
+/// Lighting and surface material used by the fragment stage.
+#[derive(Debug, Default, Clone, Copy)]
+pub struct Material {
+    pub ambient: Option<Color>,
+    pub diffuse: Option<Color>,
+    pub specular0: Option<Color>,
+    pub specular1: Option<Color>,
+    pub emission: Option<Color>,
+}
+
+impl Material {
+    pub fn to_raw(self) -> citro3d_sys::C3D_Material {
+        citro3d_sys::C3D_Material {
+            ambient: self.ambient.unwrap_or_default().to_parts_bgr(),
+            diffuse: self.diffuse.unwrap_or_default().to_parts_bgr(),
+            specular0: self.specular0.unwrap_or_default().to_parts_bgr(),
+            specular1: self.specular1.unwrap_or_default().to_parts_bgr(),
+            emission: self.emission.unwrap_or_default().to_parts_bgr(),
+        }
+    }
+}
+
 impl LightEnv {
     /// Constructs a new lighting environment.
     ///
@@ -322,8 +344,15 @@ impl Light {
 
     /// Sets the color of the light source.
     #[doc(alias = "C3D_LightColor")]
-    pub fn set_color(self: Pin<&mut Self>, r: f32, g: f32, b: f32) {
-        unsafe { citro3d_sys::C3D_LightColor(self.get_unchecked_mut().as_raw_mut(), r, g, b) }
+    pub fn set_color(self: Pin<&mut Self>, color: Color) {
+        unsafe {
+            citro3d_sys::C3D_LightColor(
+                self.get_unchecked_mut().as_raw_mut(),
+                color.r,
+                color.g,
+                color.b,
+            )
+        }
     }
 
     /// Enables/disables the light source.