Merge branch 'master' into deprecate_setup_py

moderngl · Oct 13, 2023 · 035250e · 035250e
2 parents 69dbac0 + 200f2b9
commit 035250e
Show file tree

Hide file tree

Showing 46 changed files with 201,164 additions and 105 deletions.
diff --git a/.flake8 b/.flake8
@@ -1,5 +1,5 @@
 [flake8]
 ignore = W503,C901
 max-line-length = 120
-exclude = tests/*,temp/
+exclude = tests/*,temp/,.tox,.venv
 max-complexity = 10
diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml
@@ -5,7 +5,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -2,7 +2,7 @@ build:
   image: latest
 
 python:
-  version: 3.7
+  version: 3.8
   install:
     - method: pip
       path: .

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,45 @@
 # Changelog
 
+## 2.4.4
+
+* Added `--backend` option to specify context backend. 
+  This is mostly for the headless window to enable EGL.
+* Window now has a ``backend`` property containing the name of the context backend
+* Window now has a ``headless`` boolean property to check if the window is headless.
+  This is useful for adding headless only paths in your code.
+* Added stencil bits to window framebuffers by default
+
+## 2.4.3
+
+* Fix compatibility with moderngl 5.8.x
+* Camera now has keymap support (QWERTY, AZERTY etc) 
+
+## 2.4.2
+
+* Allow toggling vsync and runtime for most windows
+* Allow rendering with imgui in headless mode
+* Fixed a crash when using fullscreen mode with glfw
+* Support moving OrbitCamera
+* Added SSAO example
+* Added `on_generic_event` callback for pygame user events
+* Fixed zoom sensitivity getter returning the wrong value
+* Fixed several typos
+* Bumped several dependencies to reasonable versions
+
+Thanks to @Rafale25, @n3onUser, @erikstrand (Erik Strand),
+@sheepman4267 and @dbs4261 (Daniel Simon) for contributions to this release.
+
+## 2.4.1
+
+* Experimental support for ffmpeg capture
+* Event callbacks can now be assigned in WindowConfig.__init__
+* Initial support for confirming window close (glfw)
+* Fixed a crash when closing a pyglet window
+* Remove some spammy prints in the text writer
+
+Thanks to @DavideRuzza, @wk39 and @joehalliwell for their
+contributions to this release.
+
 ## 2.4.0
 
 Python 3.5 is no longer supported from this version.
@@ -10,7 +50,7 @@ New Features
 * Various smaller improvements
 * F11 now toggles fullscreen mode by default
 * Window modules are now fetched from `moderngl_window.WINDOW_CLASSES`
-  as a fallback. This is necessary in some enviroments.
+  as a fallback. This is necessary in some environments.
 * Absolute paths will now bypass all registered resource directories
   and load the specified file directly.
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -49,11 +49,11 @@ def __getattr__(cls, name):
 # -- Project information -----------------------------------------------------
 
 project = 'moderngl-window'
-copyright = '2019, Einar Forselv'
+copyright = '2023, Einar Forselv'
 author = 'Einar Forselv'
 
 # The short X.Y version
-version = '2.3.0'
+version = '2.4.4'
 # The full version, including alpha/beta/rc tags
 release = version
 

diff --git a/docs/reference/context/basewindow.rst b/docs/reference/context/basewindow.rst
@@ -30,6 +30,8 @@ Attributes
 .. autoattribute:: BaseWindow.keys
    :annotation:
 .. autoattribute:: BaseWindow.ctx
+.. autoattribute:: BaseWindow.backend
+.. autoattribute:: BaseWindow.headless
 .. autoattribute:: BaseWindow.fbo
 .. autoattribute:: BaseWindow.title
 .. autoattribute:: BaseWindow.exit_key
@@ -63,6 +65,7 @@ Attributes
 .. autoattribute:: BaseWindow.close_func
 .. autoattribute:: BaseWindow.iconify_func
 .. autoattribute:: BaseWindow.key_event_func
+.. autoattribute:: BaseWindow.on_generic_event_func
 .. autoattribute:: BaseWindow.mouse_position_event_func
 .. autoattribute:: BaseWindow.mouse_press_event_func
 .. autoattribute:: BaseWindow.mouse_release_event_func

diff --git a/docs/reference/context/glfw.window.rst b/docs/reference/context/glfw.window.rst
@@ -30,6 +30,8 @@ Attributes
 .. autoattribute:: Window.keys
    :annotation:
 .. autoattribute:: Window.ctx
+.. autoattribute:: Window.backend
+.. autoattribute:: Window.headless
 .. autoattribute:: Window.fbo
 .. autoattribute:: Window.title
 .. autoattribute:: Window.exit_key
@@ -63,6 +65,7 @@ Attributes
 .. autoattribute:: Window.resize_func
 .. autoattribute:: Window.iconify_func
 .. autoattribute:: Window.key_event_func
+.. autoattribute:: Window.on_generic_event_func
 .. autoattribute:: Window.mouse_position_event_func
 .. autoattribute:: Window.mouse_press_event_func
 .. autoattribute:: Window.mouse_release_event_func

diff --git a/docs/reference/context/headless.window.rst b/docs/reference/context/headless.window.rst
@@ -30,6 +30,8 @@ Attributes
 .. autoattribute:: Window.keys
    :annotation:
 .. autoattribute:: Window.ctx
+.. autoattribute:: Window.backend
+.. autoattribute:: Window.headless
 .. autoattribute:: Window.fbo
 .. autoattribute:: Window.title
 .. autoattribute:: Window.exit_key
@@ -63,6 +65,7 @@ Attributes
 .. autoattribute:: Window.close_func
 .. autoattribute:: Window.iconify_func
 .. autoattribute:: Window.key_event_func
+.. autoattribute:: Window.on_generic_event_func
 .. autoattribute:: Window.mouse_position_event_func
 .. autoattribute:: Window.mouse_press_event_func
 .. autoattribute:: Window.mouse_release_event_func

diff --git a/docs/reference/context/pyglet.window.rst b/docs/reference/context/pyglet.window.rst
@@ -47,6 +47,8 @@ Attributes
 .. autoattribute:: Window.keys
    :annotation:
 .. autoattribute:: Window.ctx
+.. autoattribute:: Window.backend
+.. autoattribute:: Window.headless
 .. autoattribute:: Window.fbo
 .. autoattribute:: Window.title
 .. autoattribute:: Window.exit_key
@@ -80,6 +82,7 @@ Attributes
 .. autoattribute:: Window.close_func
 .. autoattribute:: Window.iconify_func
 .. autoattribute:: Window.key_event_func
+.. autoattribute:: Window.on_generic_event_func
 .. autoattribute:: Window.mouse_position_event_func
 .. autoattribute:: Window.mouse_press_event_func
 .. autoattribute:: Window.mouse_release_event_func

diff --git a/docs/reference/context/pyqt5.window.rst b/docs/reference/context/pyqt5.window.rst
@@ -43,6 +43,8 @@ Attributes
 .. autoattribute:: Window.keys
    :annotation:
 .. autoattribute:: Window.ctx
+.. autoattribute:: Window.backend
+.. autoattribute:: Window.headless
 .. autoattribute:: Window.fbo
 .. autoattribute:: Window.title
 .. autoattribute:: Window.exit_key
@@ -76,6 +78,7 @@ Attributes
 .. autoattribute:: Window.close_func
 .. autoattribute:: Window.iconify_func
 .. autoattribute:: Window.key_event_func
+.. autoattribute:: Window.on_generic_event_func
 .. autoattribute:: Window.mouse_position_event_func
 .. autoattribute:: Window.mouse_press_event_func
 .. autoattribute:: Window.mouse_release_event_func

diff --git a/docs/reference/context/pyside2.window.rst b/docs/reference/context/pyside2.window.rst
@@ -43,6 +43,8 @@ Attributes
 .. autoattribute:: Window.keys
    :annotation:
 .. autoattribute:: Window.ctx
+.. autoattribute:: Window.backend
+.. autoattribute:: Window.headless
 .. autoattribute:: Window.fbo
 .. autoattribute:: Window.title
 .. autoattribute:: Window.exit_key
@@ -76,6 +78,7 @@ Attributes
 .. autoattribute:: Window.close_func
 .. autoattribute:: Window.iconify_func
 .. autoattribute:: Window.key_event_func
+.. autoattribute:: Window.on_generic_event_func
 .. autoattribute:: Window.mouse_position_event_func
 .. autoattribute:: Window.mouse_press_event_func
 .. autoattribute:: Window.mouse_release_event_func

diff --git a/docs/reference/context/sdl2.window.rst b/docs/reference/context/sdl2.window.rst
@@ -35,6 +35,8 @@ Attributes
 .. autoattribute:: Window.keys
    :annotation:
 .. autoattribute:: Window.ctx
+.. autoattribute:: Window.backend
+.. autoattribute:: Window.headless
 .. autoattribute:: Window.fbo
 .. autoattribute:: Window.title
 .. autoattribute:: Window.exit_key
@@ -68,6 +70,7 @@ Attributes
 .. autoattribute:: Window.close_func
 .. autoattribute:: Window.iconify_func
 .. autoattribute:: Window.key_event_func
+.. autoattribute:: Window.on_generic_event_func
 .. autoattribute:: Window.mouse_position_event_func
 .. autoattribute:: Window.mouse_press_event_func
 .. autoattribute:: Window.mouse_release_event_func

diff --git a/docs/reference/moderngl_window.rst b/docs/reference/moderngl_window.rst
@@ -6,7 +6,7 @@
 moderngl_window
 ===============
 
-General helper functions aiding in the boostrapping of this library.
+General helper functions aiding in the bootstrapping of this library.
 
 .. autofunction:: setup_basic_logging
 .. autofunction:: activate_context

diff --git a/examples/advanced/pygame2.py b/examples/advanced/pygame2.py
@@ -36,6 +36,7 @@ def __init__(self, **kwargs):
         # 24 bit (rgba) moderngl texture
         self.pg_texture = self.ctx.texture(self.pg_res, 4)
         self.pg_texture.filter = moderngl.NEAREST, moderngl.NEAREST
+        self.pg_texture.swizzle = "BGRA"
 
         # Simple geometry and shader to render
         self.cube = geometry.cube(size=(2.0, 2.0, 2.0))

diff --git a/examples/advanced/pygame2_background_image.py b/examples/advanced/pygame2_background_image.py
@@ -30,6 +30,7 @@ def __init__(self, **kwargs):
         # 24 bit (rgba) moderngl texture
         self.pg_texture = self.ctx.texture(self.window_size, 4)
         self.pg_texture.filter = moderngl.NEAREST, moderngl.NEAREST
+        self.pg_texture.swizzle = "BGRA"
 
         self.texture_program = self.load_program('programs/texture.glsl')
         self.quad_texture = self.load_texture_2d('textures/python-bg.png')