docs

pygfx · Sep 17, 2024 · 40e7071 · 40e7071
1 parent 23f3e06
commit 40e7071
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/gui.rst b/docs/gui.rst
@@ -21,7 +21,6 @@ The Canvas base classes
     ~WgpuCanvasInterface
     ~WgpuCanvasBase
     ~WgpuAutoGui
-    ~WgpuOffscreenCanvasBase
 
 
 For each supported GUI toolkit there is a module that implements a ``WgpuCanvas`` class,

diff --git a/wgpu/gui/base.py b/wgpu/gui/base.py
@@ -80,6 +80,12 @@ def get_context(self, kind="webgpu"):
         return self._canvas_context
 
     def present_image(self, image, **kwargs):
+        """Consume the final rendered image.
+
+        This is called when using the "image" method, see ``get_surface_info()``.
+        Canvases that don't support offscreen rendering don't need to implement
+        this method.
+        """
         raise NotImplementedError()