add canvas kwarg that takes str (#235)

kushalkolar · web-flow · commit 7490cb3d6c90 · 2023-06-16T14:48:56.000-04:00
* add canvas kwarg that takes str

* fix
diff --git a/fastplotlib/layouts/_subplot.py b/fastplotlib/layouts/_subplot.py
@@ -8,8 +8,34 @@
 import traceback
 
 from pygfx import Scene, OrthographicCamera, PanZoomController, OrbitController, \
-    AxesHelper, GridHelper, WgpuRenderer
+    AxesHelper, GridHelper, WgpuRenderer, Texture
 from wgpu.gui.auto import WgpuCanvas
+from wgpu.gui.base import WgpuCanvasBase
+
+
+# TODO: this determination can be better
+try:
+    from wgpu.gui.jupyter import JupyterWgpuCanvas
+except ImportError:
+    JupyterWgpuCanvas = False
+
+try:
+    from wgpu.gui.qt import QWgpuCanvas
+except ImportError:
+    QWgpuCanvas = False
+
+try:
+    from wgpu.gui.glfw import GlfwWgpuCanvas
+except ImportError:
+    GlfwWgpuCanvas = False
+
+
+CANVAS_OPTIONS = ["jupyter", "glfw", "qt"]
+CANVAS_OPTIONS_AVAILABLE = {
+    "jupyter": JupyterWgpuCanvas,
+    "glfw": GlfwWgpuCanvas,
+    "qt": QWgpuCanvas
+}
 
 from ._base import PlotArea
 from .. import graphics
@@ -24,7 +50,7 @@ def __init__(
             parent_dims: Tuple[int, int] = None,
             camera: str = '2d',
             controller: Union[PanZoomController, OrbitController] = None,
-            canvas: WgpuCanvas = None,
+            canvas: Union[str, WgpuCanvas, Texture] = None,
             renderer: WgpuRenderer = None,
             name: str = None,
             **kwargs
@@ -45,8 +71,10 @@ def __init__(
         controller: PanZoomController or OrbitOrthoController, optional
             ``PanZoomController`` type is used for 2D pan-zoom camera control and ``OrbitController`` type is used for
             rotating the camera around a center position, used to control the camera
-        canvas: WgpuCanvas, optional
-            provides surface on which a scene will be rendered
+        canvas: WgpuCanvas, Texture, or one of "jupyter", "glfw", "qt", optional
+            Provides surface on which a scene will be rendered. Can optionally provide a WgpuCanvas instance or a str
+            to force the PlotArea to use a specific canvas from one of the following options: "jupyter", "glfw", "qt".
+            Can also provide a pygfx Texture to render to.
         renderer: WgpuRenderer, optional
             object used to render scenes using wgpu
         name: str, optional
@@ -55,6 +83,24 @@ def __init__(
         if canvas is None:
             canvas = WgpuCanvas()
 
+        elif isinstance(canvas, str):
+            if canvas not in CANVAS_OPTIONS:
+                raise ValueError(
+                    f"str canvas argument must be one of: {CANVAS_OPTIONS}"
+                )
+            elif not CANVAS_OPTIONS_AVAILABLE[canvas]:
+                raise ImportError(
+                    f"The {canvas} framework is not installed for using this canvas"
+                )
+            else:
+                canvas = CANVAS_OPTIONS_AVAILABLE[canvas]()
+
+        elif not isinstance(canvas, (WgpuCanvasBase, Texture)):
+            raise ValueError(
+                f"canvas option must either be a valid WgpuCanvas implementation, a pygfx Texture"
+                f" or a str from the following options: {CANVAS_OPTIONS}"
+            )
+
         if renderer is None:
             renderer = WgpuRenderer(canvas)
 
