Renamed + Added Docs

1 files changed, 5 insertions, 0 deletions

diff --git a/src/components.rs b/src/components.rs
index cc6c471..49f4684 100644
--- a/src/components.rs
+++ b/src/components.rs
@@ -3,8 +3,13 @@ use bevy::{
     render::{extract_component::ExtractComponent, render_resource::ShaderType},
 };
 
+/// Component which, when inserted into an entity with a camera and normal prepass, enables an outline effect for that
+/// camera.
 #[derive(Component, ShaderType, ExtractComponent, PartialEq, Clone, Default)]
 pub struct OutlinePostProcessSettings {
+    /// Weight of outlines in pixels.
     pub weight: f32,
+    /// A threshold for normal differences, values below this threshold will not become outlines.
+    /// Higher values will result in more outlines which may look better on smooth surfaces.
     pub threshold: f32,
 }