docs

pgrit · Aug 8, 2024 · 6834ea1 · 6834ea1
1 parent 672bbf2
commit 6834ea1
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/SeeSharp/Shading/Background/Background.cs b/SeeSharp/Shading/Background/Background.cs
@@ -13,6 +13,12 @@ public abstract class Background {
 
     public abstract BackgroundSample SampleDirection(Vector2 primary);
     public abstract Vector2 SampleDirectionInverse(Vector3 Direction);
+
+    /// <summary>
+    /// Computes the PDF for sampling a given direction from the background
+    /// </summary>
+    /// <param name="Direction">Direction from the scene towards the background</param>
+    /// <returns>Solid angle PDF</returns>
     public abstract float DirectionPdf(Vector3 Direction);
     public abstract (Ray, RgbColor, float) SampleRay(Vector2 primaryPos, Vector2 primaryDir);
     public abstract (Vector2, Vector2) SampleRayInverse(Vector3 dir, Vector3 pos);