Abstract the arcade.gl package in order to support different rendering backends

arcade/application.py

@@ -22,8 +22,9 @@
 from arcade.clock import GLOBAL_CLOCK, GLOBAL_FIXED_CLOCK, _setup_clock, _setup_fixed_clock
 from arcade.color import BLACK
 from arcade.context import ArcadeContext
+from arcade.gl.provider import get_arcade_context, set_provider
 from arcade.types import LBWH, Color, Rect, RGBANormalized, RGBOrA255
-from arcade.utils import is_raspberry_pi
+from arcade.utils import is_pyodide, is_raspberry_pi
 from arcade.window_commands import get_display_size, set_window
 
 if TYPE_CHECKING:
@@ -157,7 +158,7 @@ def __init__(
         center_window: bool = False,
         samples: int = 4,
         enable_polling: bool = True,
-        gl_api: str = "gl",
+        gl_api: str = "opengl",
         draw_rate: float = 1 / 60,
         fixed_rate: float = 1.0 / 60.0,
         fixed_frame_cap: int | None = None,
@@ -167,10 +168,17 @@ def __init__(
         if os.environ.get("REPL_ID"):
             antialiasing = False
 
+        desired_gl_provider = "opengl"
+        if is_pyodide():
+            gl_api = "webgl"
+
+        if gl_api == "webgl":
+            desired_gl_provider = "webgl"
+
         # Detect Raspberry Pi and switch to OpenGL ES 3.1
         if is_raspberry_pi():
             gl_version = 3, 1
-            gl_api = "gles"
+            gl_api = "opengles"
 
         self.closed = False
         """Indicates if the window was closed"""
@@ -184,7 +192,7 @@ def __init__(
                 config = gl.Config(
                     major_version=gl_version[0],
                     minor_version=gl_version[1],
-                    opengl_api=gl_api,  # type: ignore  # pending: upstream fix
+                    opengl_api=gl_api.replace("open", ""),  # type: ignore  # pending: upstream fix
                     double_buffer=True,
                     sample_buffers=1,
                     samples=samples,
@@ -208,7 +216,7 @@ def __init__(
             config = gl.Config(
                 major_version=gl_version[0],
                 minor_version=gl_version[1],
-                opengl_api=gl_api,  # type: ignore  # pending: upstream fix
+                opengl_api=gl_api.replace("open", ""),  # type: ignore  # pending: upstream fix
                 double_buffer=True,
                 depth_size=24,
                 stencil_size=8,
@@ -277,7 +285,9 @@ def __init__(
 
         self.push_handlers(on_resize=self._on_resize)
 
-        self._ctx: ArcadeContext = ArcadeContext(self, gc_mode=gc_mode, gl_api=gl_api)
+        set_provider(desired_gl_provider)
+        self._ctx: ArcadeContext = get_arcade_context(self, gc_mode=gc_mode, gl_api=gl_api)
+        # self._ctx: ArcadeContext = ArcadeContext(self, gc_mode=gc_mode, gl_api=gl_api)
         self._background_color: Color = BLACK
 
         self._current_view: View | None = None

arcade/context.py

@@ -21,7 +21,6 @@
 from arcade.gl.framebuffer import Framebuffer
 from arcade.gl.program import Program
 from arcade.gl.texture import Texture2D
-from arcade.gl.types import PyGLenum
 from arcade.gl.vertex_array import Geometry
 from arcade.texture_atlas import DefaultTextureAtlas, TextureAtlasBase
 
@@ -451,9 +450,9 @@ def load_texture(
         path: str | Path,
         *,
         flip: bool = True,
-        wrap_x: PyGLenum | None = None,
-        wrap_y: PyGLenum | None = None,
-        filter: tuple[PyGLenum, PyGLenum] | None = None,
+        wrap_x=None,
+        wrap_y=None,
+        filter=None,
         build_mipmaps: bool = False,
         internal_format: int | None = None,
         immutable: bool = False,

arcade/examples/gl/tessellation.py

@@ -10,6 +10,7 @@
 
 import arcade
 from arcade.gl import BufferDescription
+import pyglet.gl
 
 WINDOW_WIDTH = 1280
 WINDOW_HEIGHT = 720
@@ -106,7 +107,7 @@ def __init__(self, width, height, title):
     def on_draw(self):
         self.clear()
         self.program["time"] = self.time
-        self.geometry.render(self.program, mode=self.ctx.PATCHES)
+        self.geometry.render(self.program, mode=pyglet.gl.GL_PATCHES)
 
 
 if __name__ == "__main__":

arcade/gl/backends/opengl/buffer.py

@@ -0,0 +1,287 @@
+from __future__ import annotations
+
+import weakref
+from ctypes import byref, string_at
+from typing import TYPE_CHECKING
+
+from pyglet import gl
+
+from arcade.gl.buffer import Buffer
+from arcade.types import BufferProtocol
+
+from .utils import data_to_ctypes
+
+if TYPE_CHECKING:
+    from arcade.gl import Context
+
+_usages = {
+    "static": gl.GL_STATIC_DRAW,
+    "dynamic": gl.GL_DYNAMIC_DRAW,
+    "stream": gl.GL_STREAM_DRAW,
+}
+
+
+class OpenGLBuffer(Buffer):
+    """OpenGL buffer object. Buffers store byte data and upload it
+    to graphics memory so shader programs can process the data.
+    They are used for storage of vertex data,
+    element data (vertex indexing), uniform block data etc.
+
+    The ``data`` parameter can be anything that implements the
+    `Buffer Protocol <https://docs.python.org/3/c-api/buffer.html>`_.
+
+    This includes ``bytes``, ``bytearray``, ``array.array``, and
+    more. You may need to use typing workarounds for non-builtin
+    types. See :ref:`prog-guide-gl-buffer-protocol-typing` for more
+    information.
+
+    .. warning:: Buffer objects should be created using :py:meth:`arcade.gl.Context.buffer`
+
+    Args:
+        ctx:
+            The context this buffer belongs to
+        data:
+            The data this buffer should contain. It can be a ``bytes`` instance or any
+            object supporting the buffer protocol.
+        reserve:
+            Create a buffer of a specific byte size
+        usage:
+            A hit of this buffer is ``static`` or ``dynamic`` (can mostly be ignored)
+    """
+
+    __slots__ = "_glo", "_usage"
+
+    def __init__(
+        self,
+        ctx: Context,
+        data: BufferProtocol | None = None,
+        reserve: int = 0,
+        usage: str = "static",
+    ):
+        super().__init__(ctx)
+        self._usage = _usages[usage]
+        self._glo = glo = gl.GLuint()
+        gl.glGenBuffers(1, byref(self._glo))
+        # print(f"glGenBuffers() -> {self._glo.value}")
+        if self._glo.value == 0:
+            raise RuntimeError("Cannot create Buffer object.")
+
+        # print(f"glBindBuffer({self._glo.value})")
+        gl.glBindBuffer(gl.GL_ARRAY_BUFFER, self._glo)
+        # print(f"glBufferData(gl.GL_ARRAY_BUFFER, {self._size}, data, {self._usage})")
+
+        if data is not None and len(data) > 0:  # type: ignore
+            self._size, data = data_to_ctypes(data)
+            gl.glBufferData(gl.GL_ARRAY_BUFFER, self._size, data, self._usage)
+        elif reserve > 0:
+            self._size = reserve
+            # populate the buffer with zero byte values
+            data = (gl.GLubyte * self._size)()
+            gl.glBufferData(gl.GL_ARRAY_BUFFER, self._size, data, self._usage)
+        else:
+            raise ValueError("Buffer takes byte data or number of reserved bytes")
+
+        if self._ctx.gc_mode == "auto":
+            weakref.finalize(self, OpenGLBuffer.delete_glo, self.ctx, glo)
+
+    def __repr__(self):
+        return f"<Buffer {self._glo.value}>"
+
+    def __del__(self):
+        # Intercept garbage collection if we are using Context.gc()
+        if self._ctx.gc_mode == "context_gc" and self._glo.value > 0:
+            self._ctx.objects.append(self)
+
+    @property
+    def glo(self) -> gl.GLuint:
+        """The OpenGL resource id."""
+        return self._glo
+
+    def delete(self) -> None:
+        """
+        Destroy the underlying OpenGL resource.
+
+        .. warning:: Don't use this unless you know exactly what you are doing.
+        """
+        OpenGLBuffer.delete_glo(self._ctx, self._glo)
+        self._glo.value = 0
+
+    @staticmethod
+    def delete_glo(ctx: Context, glo: gl.GLuint):
+        """
+        Release/delete open gl buffer.
+
+        This is automatically called when the object is garbage collected.
+
+        Args:
+            ctx:
+                The context the buffer belongs to
+            glo:
+                The OpenGL buffer id
+        """
+        # If we have no context, then we are shutting down, so skip this
+        if gl.current_context is None:
+            return
+
+        if glo.value != 0:
+            gl.glDeleteBuffers(1, byref(glo))
+            glo.value = 0
+
+        ctx.stats.decr("buffer")
+
+    def read(self, size: int = -1, offset: int = 0) -> bytes:
+        """Read data from the buffer.
+
+        Args:
+            size:
+                The bytes to read. -1 means the entire buffer (default)
+            offset:
+                Byte read offset
+        """
+        if size == -1:
+            size = self._size - offset
+
+        # Catch this before confusing INVALID_OPERATION is raised
+        if size < 1:
+            raise ValueError(
+                "Attempting to read 0 or less bytes from buffer: "
+                f"buffer size={self._size} | params: size={size}, offset={offset}"
+            )
+
+        # Manually detect this so it doesn't raise a confusing INVALID_VALUE error
+        if size + offset > self._size:
+            raise ValueError(
+                (
+                    "Attempting to read outside the buffer. "
+                    f"Buffer size: {self._size} "
+                    f"Reading from {offset} to {size + offset}"
+                )
+            )
+
+        gl.glBindBuffer(gl.GL_ARRAY_BUFFER, self._glo)
+        ptr = gl.glMapBufferRange(gl.GL_ARRAY_BUFFER, offset, size, gl.GL_MAP_READ_BIT)
+        data = string_at(ptr, size=size)
+        gl.glUnmapBuffer(gl.GL_ARRAY_BUFFER)
+        return data
+
+    def write(self, data: BufferProtocol, offset: int = 0):
+        """Write byte data to the buffer from a buffer protocol object.
+
+        The ``data`` value can be anything that implements the
+        `Buffer Protocol <https://docs.python.org/3/c-api/buffer.html>`_.
+
+        This includes ``bytes``, ``bytearray``, ``array.array``, and
+        more. You may need to use typing workarounds for non-builtin
+        types. See :ref:`prog-guide-gl-buffer-protocol-typing` for more
+        information.
+
+        If the supplied data is larger than the buffer, it will be
+        truncated to fit. If the supplied data is smaller than the
+        buffer, the remaining bytes will be left unchanged.
+
+        Args:
+            data:
+                The byte data to write. This can be bytes or any object
+                supporting the buffer protocol.
+            offset:
+                The byte offset
+        """
+        gl.glBindBuffer(gl.GL_ARRAY_BUFFER, self._glo)
+        size, data = data_to_ctypes(data)
+        # Ensure we don't write outside the buffer
+        size = min(size, self._size - offset)
+        if size < 0:
+            raise ValueError("Attempting to write negative number bytes to buffer")
+        gl.glBufferSubData(gl.GL_ARRAY_BUFFER, gl.GLintptr(offset), size, data)
+
+    def copy_from_buffer(self, source: Buffer, size=-1, offset=0, source_offset=0):
+        """Copy data into this buffer from another buffer.
+
+        Args:
+            source:
+                The buffer to copy from
+            size:
+                The amount of bytes to copy
+            offset:
+                The byte offset to write the data in this buffer
+            source_offset:
+                The byte offset to read from the source buffer
+        """
+        # Read the entire source buffer into this buffer
+        if size == -1:
+            size = source.size
+
+        # TODO: Check buffer bounds
+        if size + source_offset > source.size:
+            raise ValueError("Attempting to read outside the source buffer")
+
+        if size + offset > self._size:
+            raise ValueError("Attempting to write outside the buffer")
+
+        gl.glBindBuffer(gl.GL_COPY_READ_BUFFER, source.glo)
+        gl.glBindBuffer(gl.GL_COPY_WRITE_BUFFER, self._glo)
+        gl.glCopyBufferSubData(
+            gl.GL_COPY_READ_BUFFER,
+            gl.GL_COPY_WRITE_BUFFER,
+            gl.GLintptr(source_offset),  # readOffset
+            gl.GLintptr(offset),  # writeOffset
+            size,  # size (number of bytes to copy)
+        )
+
+    def orphan(self, size: int = -1, double: bool = False):
+        """
+        Re-allocate the entire buffer memory. This can be used to resize
+        a buffer or for re-specification (orphan the buffer to avoid blocking).
+
+        If the current buffer is busy in rendering operations
+        it will be deallocated by OpenGL when completed.
+
+        Args:
+            size:
+                New size of buffer. -1 will retain the current size.
+                Takes precedence over ``double`` parameter if specified.
+            double:
+                Is passed in with `True` the buffer size will be doubled
+                from its current size.
+        """
+        if size > 0:
+            self._size = size
+        elif double is True:
+            self._size *= 2
+
+        gl.glBindBuffer(gl.GL_ARRAY_BUFFER, self._glo)
+        gl.glBufferData(gl.GL_ARRAY_BUFFER, self._size, None, self._usage)
+
+    def bind_to_uniform_block(self, binding: int = 0, offset: int = 0, size: int = -1):
+        """Bind this buffer to a uniform block location.
+        In most cases it will be sufficient to only provide a binding location.
+
+        Args:
+            binding:
+                The binding location
+            offset:
+                Byte offset
+            size:
+                Size of the buffer to bind.
+        """
+        if size < 0:
+            size = self.size
+
+        gl.glBindBufferRange(gl.GL_UNIFORM_BUFFER, binding, self._glo, offset, size)
+
+    def bind_to_storage_buffer(self, *, binding=0, offset=0, size=-1):
+        """
+        Bind this buffer as a shader storage buffer.
+
+        Args:
+            binding:
+                The binding location
+            offset:
+                Byte offset in the buffer
+            size:
+                The size in bytes. The entire buffer will be mapped by default.
+        """
+        if size < 0:
+            size = self.size
+
+        gl.glBindBufferRange(gl.GL_SHADER_STORAGE_BUFFER, binding, self._glo, offset, size)