FAQ

docs/FAQ.rst

@@ -39,3 +39,9 @@ Frequently Asked Questions (FAQs)
         
 
     .. _importlib-resources: https://importlib-resources.readthedocs.io/en/latest/
+
+    Renders the scene into a image (screenshot)
+    .. code-block:: python
+
+    renderer.gl.saveImage("filename.bmp")
+

flatland/utils/graphics_pil.py

@@ -219,6 +219,10 @@ class PILGL(GraphicsLayer):
         return array(img)
 
     def saveImage(self, filename):
+        """
+        Renders the current scene into a image file
+        :param filename: filename where to store the rendering output (supported image format *.bmp , .. , *.png)
+        """
         img = self.alpha_composite_layers()
         img.save(filename)