library: document root module

This commit is contained in:
Antoine Martin 2020-03-22 01:51:15 +01:00
parent 64125dbc43
commit 0d59f49ea7
1 changed files with 5 additions and 0 deletions

View File

@ -1,9 +1,14 @@
#![warn(missing_docs)]
//! A pathtracing crate
use bvh::nalgebra::{Point2, Point3, Vector3};
/// A 2D point coordinate
pub type Point2D = Point2<f32>;
/// A 3D point coordinate
pub type Point = Point3<f32>;
/// A 3D vector
pub type Vector = Vector3<f32>;
pub mod core;