Add documents to marker components.

cryscan · Mar 10, 2022 · abab5b3 · abab5b3
1 parent d6aee3c
commit abab5b3
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/examples/city.rs b/examples/city.rs
@@ -135,6 +135,7 @@ fn scene_update(
     mut done: Local<bool>,
 ) {
     if !*done {
+        // Rendering GI for those two meshes are extremely slow, so disable them in tracing
         let names = vec![
             Name::new("CityTree_T_Leaves_D_0"),
             Name::new("Tree_T_Leaves_D_0"),

diff --git a/src/lib.rs b/src/lib.rs
@@ -197,9 +197,11 @@ pub enum VoxelConeTracingSystems {
     QueueTracingBindGroups,
 }
 
+/// Marker component for meshes not casting GI.
 #[derive(Component)]
 pub struct NotGiCaster;
 
+/// Marker component for meshes not receiving GI.
 #[derive(Component)]
 pub struct NotGiReceiver;