diff options
author | Julian T <julian@jtle.dk> | 2021-02-02 20:39:32 +0100 |
---|---|---|
committer | Julian T <julian@jtle.dk> | 2021-02-03 14:30:21 +0100 |
commit | 32e719a517a6fea113f3e66e350c9aa60ddd98b9 (patch) | |
tree | 3db7367b59a981dd51135122254d72dc9299eb74 /src/scene | |
parent | df6a266e5823a7fc4cca3060ec86d35f2125cd0d (diff) |
Added documentation for many of the modules
Diffstat (limited to 'src/scene')
-rw-r--r-- | src/scene/mod.rs | 3 | ||||
-rw-r--r-- | src/scene/shapes/sphere.rs | 3 |
2 files changed, 6 insertions, 0 deletions
diff --git a/src/scene/mod.rs b/src/scene/mod.rs index 13c5e23..7c77412 100644 --- a/src/scene/mod.rs +++ b/src/scene/mod.rs @@ -1,3 +1,6 @@ +//! Defines the scene type which contains all the objects in the scene. +//! +//! Also handles finding intersections between rays and shapes pub mod shapes; mod scene; diff --git a/src/scene/shapes/sphere.rs b/src/scene/shapes/sphere.rs index f8ae11e..e30c1ec 100644 --- a/src/scene/shapes/sphere.rs +++ b/src/scene/shapes/sphere.rs @@ -1,3 +1,6 @@ +//! Implements sphere +//! +//! Spheres are relatively easy to calculate intersections between use crate::Float; use crate::core::{Ray, Vector3f}; use super::Shape; |