aboutsummaryrefslogtreecommitdiff
path: root/src/camera/mod.rs
diff options
context:
space:
mode:
authorJulian T <julian@jtle.dk>2021-02-02 20:39:32 +0100
committerJulian T <julian@jtle.dk>2021-02-02 20:39:32 +0100
commit2b4adacea3c76b8b33dc5f50d296dd4a61107c16 (patch)
tree905b672e4005b29dad5807060ae3a966d4a3d264 /src/camera/mod.rs
parentd79d5d18c8281cce1e782892e5f85680906481dd (diff)
Added documentation for many of the modules
Diffstat (limited to 'src/camera/mod.rs')
-rw-r--r--src/camera/mod.rs8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/camera/mod.rs b/src/camera/mod.rs
index 42de3b3..4865a36 100644
--- a/src/camera/mod.rs
+++ b/src/camera/mod.rs
@@ -1,2 +1,10 @@
+//! Implements how light is captured on film and how rays are generated
+//!
+//! The Film module specifies how calculated spectrum values contribute to the final image.
+//!
+//! The Camera class generated rays that can be cast into the scene.
+//! This requires converting the film coordinates into real coordinates
+
pub mod film;
//pub mod filter;
+//pub mod camera;