diff --git a/src/serialize/coefficient.rs b/src/serialize/coefficient.rs index 1b37875..229871a 100644 --- a/src/serialize/coefficient.rs +++ b/src/serialize/coefficient.rs @@ -1,3 +1,6 @@ +//! Helper functions deserialize coefficients. + +/// Returns the identity for a f32, i.e. 1.0. pub fn default_identity() -> f32 { 1. } diff --git a/src/serialize/mod.rs b/src/serialize/mod.rs index 1b8a1b0..9b6b8e4 100644 --- a/src/serialize/mod.rs +++ b/src/serialize/mod.rs @@ -1,3 +1,5 @@ +//! Helper functions to help scene (de)serialization + pub mod vector; pub use vector::*; diff --git a/src/serialize/vector.rs b/src/serialize/vector.rs index 3a354bf..00d40ab 100644 --- a/src/serialize/vector.rs +++ b/src/serialize/vector.rs @@ -1,6 +1,11 @@ +//! Helper functions to deserialize `Vector` values. + use crate::Vector; use serde::de::{Deserialize, Deserializer}; +/// Deserialize a vector. +/// +/// Needs a custom implementation to make sur the vector is normalized when deserialized. pub fn vector_normalizer<'de, D>(deserializer: D) -> Result where D: Deserializer<'de>,