Add util to get glfw present_info (#767)

* Add util to get glfw present_info

* fix

* update examples

* typo

* laxy imoirt

Author: almarklein

docs/conf.py

@@ -25,6 +25,7 @@
 # Load wgpu so autodoc can query docstrings
 import wgpu  # noqa: E402
 import wgpu.utils.compute  # noqa: E402
+import wgpu.utils.glfw_present_info  # noqa: E402
 
 
 # -- Tests -------------------------------------------------------------------

docs/utils.rst

@@ -66,3 +66,13 @@ Compute with buffers
 
 .. autofunction:: wgpu.utils.compute.compute_with_buffers
 
+
+
+Helper for using glfw directly (not via rendercanvas)
+-----------------------------------------------------
+
+.. code-block:: py
+
+    from wgpu.utils.glfw_present_info import get_glfw_present_info
+
+.. autofunction:: wgpu.utils.glfw_present_info.get_glfw_present_info

examples/gui_direct.py

@@ -7,57 +7,16 @@
 
 # run_example = false
 
-import os
-import sys
 import time
 import atexit
 
 import glfw
 import wgpu
+from wgpu.utils.glfw_present_info import get_glfw_present_info
 
 # from triangle import setup_drawing_sync
 from cube import setup_drawing_sync
 
-
-system_is_wayland = "wayland" in os.getenv("XDG_SESSION_TYPE", "").lower()
-api_is_wayland = False
-if sys.platform.startswith("linux") and system_is_wayland:
-    if not hasattr(glfw, "get_x11_window"):
-        api_is_wayland = True
-
-
-def get_glfw_present_info(window):
-    if sys.platform.startswith("win"):
-        return {
-            "platform": "windows",
-            "window": int(glfw.get_win32_window(window)),
-            "vsync": True,
-        }
-    elif sys.platform.startswith("darwin"):
-        return {
-            "platform": "cocoa",
-            "window": int(glfw.get_cocoa_window(window)),
-            "vsync": True,
-        }
-    elif sys.platform.startswith("linux"):
-        if api_is_wayland:
-            return {
-                "platform": "wayland",
-                "window": int(glfw.get_wayland_window(window)),
-                "display": int(glfw.get_wayland_display()),
-                "vsync": True,
-            }
-        else:
-            return {
-                "platform": "x11",
-                "window": int(glfw.get_x11_window(window)),
-                "display": int(glfw.get_x11_display()),
-                "vsync": True,
-            }
-    else:
-        raise RuntimeError(f"Cannot get GLFW surface info on {sys.platform}.")
-
-
 # Setup glfw
 glfw.init()
 atexit.register(glfw.terminate)

wgpu/utils/glfw_present_info.py

@@ -0,0 +1,48 @@
+import os
+import sys
+
+
+def get_glfw_present_info(window, vsync=True) -> dict:
+    """Get the ``present_info`` dict required to instantiate a ``GPUCanvasContext``.
+
+    Given a glfw window handle, return a dict that can be passed to ``wgpu.gpu.get_canvas_context()`` to create a ``GPUCanvasContext``.
+    """
+
+    # Lazy import, so the docs can be build without needing glfw
+    import glfw
+
+    system_is_wayland = "wayland" in os.getenv("XDG_SESSION_TYPE", "").lower()
+    api_is_wayland = False
+    if sys.platform.startswith("linux") and system_is_wayland:
+        if not hasattr(glfw, "get_x11_window"):
+            api_is_wayland = True
+
+    if sys.platform.startswith("win"):
+        return {
+            "platform": "windows",
+            "window": int(glfw.get_win32_window(window)),
+            "vsync": vsync,
+        }
+    elif sys.platform.startswith("darwin"):
+        return {
+            "platform": "cocoa",
+            "window": int(glfw.get_cocoa_window(window)),
+            "vsync": vsync,
+        }
+    elif sys.platform.startswith("linux"):
+        if api_is_wayland:
+            return {
+                "platform": "wayland",
+                "window": int(glfw.get_wayland_window(window)),
+                "display": int(glfw.get_wayland_display()),
+                "vsync": vsync,
+            }
+        else:
+            return {
+                "platform": "x11",
+                "window": int(glfw.get_x11_window(window)),
+                "display": int(glfw.get_x11_display()),
+                "vsync": vsync,
+            }
+    else:
+        raise RuntimeError(f"Cannot get GLFW surface info on {sys.platform}.")