Fix docs

google · Nov 28, 2018 · 47d1068 · 47d1068
1 parent ad1f3cf
commit 47d1068
Showing 1 changed file with 10 additions and 5 deletions.
diff --git a/filament/include/filament/View.h b/filament/include/filament/View.h
@@ -307,7 +307,7 @@ class UTILS_PUBLIC View : public FilamentAPI {
     void setRenderTarget(TargetBufferFlags discard = TargetBufferFlags::ALL) noexcept;
 
     /**
-     * Sets how many samples are to be used for MSAA. Default is 1.
+     * Sets how many samples are to be used for MSAA. Default is 1 and disables MSAA.
      *
      * @param count number of samples to use for multi-sampled anti-aliasing.\n
      *              0: treated as 1
@@ -319,7 +319,9 @@ class UTILS_PUBLIC View : public FilamentAPI {
     void setSampleCount(uint8_t count = 1) noexcept;
 
     /**
-     * Returns the sample count set by setSampleCount(). Effective sample could be different
+     * Returns the sample count set by setSampleCount(). Effective sample could be different.
+     * A value of 0 or 1 means MSAA is disabled.
+     *
      * @return value set by setSampleCount().
      */
     uint8_t getSampleCount() const noexcept;
@@ -330,16 +332,18 @@ class UTILS_PUBLIC View : public FilamentAPI {
     };
 
     /**
-     * Enables or disables in the post-processing stage. Enabled by default.
+     * Enables or disables anti-aliasing in the post-processing stage. Enabled by default.
+     * MSAA can be enabled in addition, see setSampleCount().
      *
      * @param type FXAA for enabling, NONE for disabling anti-aliasing.
      */
     void setAntiAliasing(AntiAliasing type) noexcept;
 
     /**
-     * Queries whether FXAA is enabled during the post-processing stage.
+     * Queries whether anti-aliasing is enabled during the post-processing stage. To query
+     * whether MSAA is enabled, see getSampleCount().
      *
-     * @return true if FXAA is enabled, false if not.
+     * @return The post-processing anti-aliasing method.
      */
     AntiAliasing getAntiAliasing() const noexcept;
 
@@ -395,6 +399,7 @@ class UTILS_PUBLIC View : public FilamentAPI {
      */
     void setPostProcessingEnabled(bool enabled) noexcept;
 
+    //! Returns true if post-processing is enabled. See setPostProcessingEnabled() for more info.
     bool isPostProcessingEnabled() const noexcept;
 
     // for debugging...