Docs: PyQt5 window

Author: einarf

demosys/context/pyqt/keys.py

@@ -5,7 +5,9 @@
 
 
 class Keys(BaseKeys):
-    """Namespace translating pyqt keys"""
+    """
+    Namespace creating pyqt specific key constants
+    """
     ESCAPE = Qt.Key_Escape
     SPACE = Qt.Key_Space
     ENTER = Qt.Key_Enter

demosys/context/pyqt/window.py

@@ -8,9 +8,20 @@
 
 
 class Window(BaseWindow):
+    """
+    Window using PyQt5.
+
+    This is the recommended window if you want your project to work
+    on most platforms out of the box without any binary dependecies.
+    """
     keys = Keys
 
     def __init__(self):
+        """
+        Creates a pyqt application and window overriding the
+        built in event loop. Sets up keyboard and mouse events
+        and creates a ``monderngl.Context``.
+        """
         super().__init__()
         self._closed = False
 
@@ -73,31 +84,62 @@ def __init__(self):
         self.set_default_viewport()
 
     def keyPressEvent(self, event):
+        """
+        Pyqt specific key press callback function.
+        Translates and forwards events to :py:func:`keyboard_event`.
+        """
         self.keyboard_event(event.key(), self.keys.ACTION_PRESS, 0)
 
     def keyReleaseEvent(self, event):
+        """
+        Pyqt specific key release callback function.
+        Translates and forwards events to :py:func:`keyboard_event`.
+        """
         self.keyboard_event(event.key(), self.keys.ACTION_RELEASE, 0)
 
     def mouseMoveEvent(self, event):
+        """
+        Pyqt specific mouse event callback
+        Translates and forwards events to :py:func:`cursor_event`.
+        """
         self.cursor_event(event.x(), event.y(), 0, 0)
 
     def resizeGL(self, width, height):
+        """
+        Pyqt specific resize callback.
+        The window currently do not support resizing.
+        """
         print("Resize", width, height)
 
     def swap_buffers(self):
+        """
+        Swaps buffers, increments the frame counter and pulls events
+        """
         self.frames += 1
         self.widget.swapBuffers()
         # We don't use standard event loop having to manually process events
         self.app.processEvents()
 
     def use(self):
+        """
+        Make the window's framebuffer the current render target
+        """
         self.fbo.use()
 
-    def should_close(self):
+    def should_close(self) -> bool:
+        """
+        Checks if the internal close state is set
+        """
         return self._closed
 
     def close(self):
+        """
+        Set the internal close state
+        """
         self._closed = True
 
     def terminate(self):
+        """
+        Quits the running qt application
+        """
         QtCore.QCoreApplication.instance().quit()

docs/reference/demosys.context.pyqt.rst

@@ -0,0 +1,27 @@
+
+.. py:module:: demosys.context.pyqt
+.. py:currentmodule:: demosys.context.pyqt
+
+demosys.context.pyqt.Window
+===========================
+
+.. autodata:: Window
+
+.. autodata:: Keys
+
+Methods
+-------
+
+.. automethod:: Window.__init__
+.. automethod:: Window.keyPressEvent
+.. automethod:: Window.keyReleaseEvent
+.. automethod:: Window.mouseMoveEvent
+.. automethod:: Window.resizeGL
+.. automethod:: Window.swap_buffers
+.. automethod:: Window.use
+.. automethod:: Window.should_close
+.. automethod:: Window.close
+.. automethod:: Window.terminate
+
+Attributes
+----------

docs/reference/index.rst

@@ -16,6 +16,7 @@ Reference
    demosys.timers.rocketmusic
    demosys.timers.vlc
    demosys.context.base
+   demosys.context.pyqt
    demosys.context.glfw
    demosys.context.headless
    demosys.context.pyglet