Browse Source

filter: Add docstring for CommonFilters.setMSAA

[skip ci]
rdb 3 years ago
parent
commit
e0c3c8a8d9
1 changed files with 7 additions and 0 deletions
  1. 7 0
      direct/src/filter/CommonFilters.py

+ 7 - 0
direct/src/filter/CommonFilters.py

@@ -466,6 +466,13 @@ class CommonFilters:
             return task.cont
 
     def setMSAA(self, samples):
+        """Enables multisample anti-aliasing on the render-to-texture buffer.
+        If you enable this, it is recommended to leave any multisample request
+        on the main framebuffer OFF (ie. don't set framebuffer-multisample true
+        in Config.prc), since it would be a waste of resources otherwise.
+
+        .. versionadded:: 1.10.13
+        """
         fullrebuild = "MSAA" not in self.configuration or self.configuration["MSAA"].samples != samples
         newconfig = FilterConfig()
         newconfig.samples = samples