star-sf

commit 2eac75faa1ed84128e57b0a52d464bd3c8047a52
parent 12122fa4af59f17cd039be2ce4e68d86bb3e0ea4
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Mon,  3 Oct 2016 09:00:59 +0200

Fix comments

Diffstat:
M
src/ssf.h
 | 
24
+++++++++++-------------

1 file changed, 11 insertions(+), 13 deletions(-)
diff --git a/src/ssf.h b/src/ssf.h
@@ -35,8 +35,7 @@
   #define SSF(Func) ssf_##Func
 #endif
 
-/* Maximum value of the exponent parameter in the the Blinn microfacet
- * distribution */
+/* Max value of the exponent parameter in the Blinn microfacet distribution */
 #define SSF_BLINN_DISTRIBUTION_MAX_EXPONENT 10000.0
 
 /* Forward declaration */
@@ -57,11 +56,10 @@ struct ssf_bxdf_type {
 
   /* Sample an incoming direction `wi' with respect to the outgoing direction
    * `wo'. Return the direction reflectance along 'wi'. Note that the
-   * directionnal reflectance is *not* the value of the of the BxDF wrt to 'wo'
-   * and 'wi'. The directionnal reflectance is the ratio between the reflected
-   * and the incoming radiance (i.e. Li / Lo), while the BxDF is the constant
-   * of proportionality between the reflected radiance and the incoming
-   * irradiance (i.e. Lo / Eo) */
+   * directional reflectance is *not* the value of the BxDF wrt to 'wo'
+   * and 'wi'. It is the ratio between the reflected and the incoming radiance
+   * (i.e. Li / Lo), while the BxDF is the constant of proportionality between
+   * the reflected radiance and the incoming irradiance (i.e. Lo / Eo) */
   double
   (*sample)
     (void* bxdf,
@@ -164,10 +162,10 @@ SSF_API const struct ssf_bxdf_type ssf_lambertian_reflection;
 /* Glossy reflections with respect to a microfacet distribution */
 SSF_API const struct ssf_bxdf_type ssf_microfacet_reflection;
 /* Glossy reflections with respect to a microfacet distribution. In contrast to
- * the common microfacet model, this BRDF ensures, by construction, the energy
- * conservation property without requiring the normalization of the BRDF.  As a
- * conterpart, it only provides the sample function. The others functions
- * return invalid results */
+ * the common microfacet reflection, this BRDF ensures, by construction, the
+ * energy conservation property without requiring the normalization of the
+ * BRDF. As a conterpart, it only provides the sample function. The others
+ * functions return invalid value. */
 SSF_API const struct ssf_bxdf_type ssf_microfacet2_reflection;
 
 /* Fresnel term for perfect reflection */
@@ -183,7 +181,7 @@ SSF_API const struct ssf_microfacet_distribution_type ssf_beckmann_distribution;
 SSF_API const struct ssf_microfacet_distribution_type ssf_blinn_distribution;
 
 /*******************************************************************************
- * BSDF API - Bidirectionnal Scattering Distribution Function. Describes the
+ * BSDF API - Bidirectional Scattering Distribution Function. Describes the
  * way the light is scattered by a surface with a combination of BxDFs. Note
  * that by convention the outgoing direction `wo' and the incoming direction
  * `wi' point outward the surface.
@@ -211,7 +209,7 @@ SSF_API res_T
 ssf_bsdf_clear
   (struct ssf_bsdf* bsdf);
 
-/* Return the directionnal reflectance, i.e. the ratio between the reflected
+/* Return the directional reflectance, i.e. the ratio between the reflected
  * and the incoming radiance (Li/Lo). Note that this is different to the
  * BxDF value that is the ratio between the reflected radiance and the incoming
  * irradiance, i.e. Li/Eo */