Docs: Headless window

Author: einarf

demosys/context/headless.py

@@ -6,8 +6,20 @@
 
 
 class Window(BaseWindow):
-
+    """
+    Headless window using a standalone ``moderngl.Context``.
+    """
     def __init__(self):
+        """
+        Creates a standalone ``moderngl.Context``.
+        The headless window currently have no event input from keyboard or mouse.
+
+        Using this window require either ``settings`` values to be present:
+
+        * ``HEADLESS_FRAMES``: How many frames should be rendered before closing the window
+        * ``HEADLESS_DURATION``: How many seconds rendering should last before the window closes
+
+        """
         super().__init__()
 
         self.headless_frames = getattr(settings, 'HEADLESS_FRAMES', 0)
@@ -29,31 +41,47 @@ def __init__(self):
         self.fbo.use()
 
     def draw(self, current_time, frame_time):
+        """
+        Calls the superclass ``draw()`` methods and checks ``HEADLESS_FRAMES``/``HEADLESS_DURATION``
+        """
         super().draw(current_time, frame_time)
 
         if self.headless_duration and current_time >= self.headless_duration:
             self.close()
 
     def use(self):
+        """
+        Binds the framebuffer representing this window
+        """
         self.fbo.use()
 
-    def should_close(self):
+    def should_close(self) -> bool:
+        """Checks if the internal close state is set"""
         return self._close
 
     def close(self):
+        """Sets the internal close state"""
         self._close = True
 
     def resize(self, width, height):
+        """
+        Resizing is not supported by the headless window.
+        We simply override with an empty method.
+        """
         pass
 
     def swap_buffers(self):
+        """
+        Headless window currently don't support double buffering.
+        We only increment the frame counter here.
+        """
         self.frames += 1
 
         if self.headless_frames and self.frames >= self.headless_frames:
             self.close()
 
     def terminate(self):
+        """
+        No teardown is needed. We override with an empty method
+        """
         pass
-
-    def mgl_fbo(self):
-        return self.screenbuffer.mglo

docs/reference/demosys.context.headless.rst

@@ -0,0 +1,24 @@
+
+.. py:module:: demosys.context.headless
+.. py:currentmodule:: demosys.context.headless
+
+demosys.context.headless.Window
+===============================
+
+.. autodata:: Window
+   :annotation:
+
+Methods
+-------
+
+.. automethod:: Window.__init__
+.. automethod:: Window.draw
+.. automethod:: Window.use
+.. automethod:: Window.should_close
+.. automethod:: Window.close
+.. automethod:: Window.resize
+.. automethod:: Window.swap_buffers
+.. automethod:: Window.terminate
+
+Attributes
+----------

docs/reference/index.rst

@@ -17,3 +17,4 @@ Reference
    demosys.timers.vlc
    demosys.context.base
    demosys.context.glfw
+   demosys.context.headless