pyglet 2.1.12__py3-none-any.whl → 3.0.dev1__py3-none-any.whl

pyglet/graphics/__init__.py

@@ -8,792 +8,13 @@ See the :ref:`guide_graphics` for details on how to use this graphics API.
 """
 from __future__ import annotations
 
-import ctypes
-import weakref
-from typing import TYPE_CHECKING, Any, Callable, Dict, List, Sequence, Tuple
 
-import pyglet
-from pyglet.gl.gl import (
-    GL_TEXTURE0,
-    GL_UNSIGNED_BYTE,
-    GL_UNSIGNED_INT,
-    GL_UNSIGNED_SHORT,
-    GLuint,
-    glActiveTexture,
-    glBindTexture,
-    glBindVertexArray,
-    glDeleteVertexArrays,
-    glDrawArrays,
-    glDrawElements,
-    glFlush,
-    glGenVertexArrays,
-)
-from pyglet.graphics import shader, vertexdomain
-from pyglet.graphics.vertexarray import VertexArray  # noqa: F401
-from pyglet.graphics.vertexbuffer import BufferObject
+from pyglet.graphics.base import GeometryMode  # noqa: F401
+from pyglet.graphics import api  # noqa: F401
+from pyglet.graphics.draw import Group, ShaderGroup  # noqa: F401
+from pyglet.graphics.state import State  # noqa: F401
+from pyglet.graphics.api import Batch, get_default_shader, get_default_batch, core, Shader, ShaderProgram, ComputeShaderProgram  # noqa: F401
+from pyglet.graphics.texture import Texture, TextureGrid, Texture3D, TextureArray   # noqa: F401
+from pyglet.graphics.atlas import TextureBin, TextureArrayBin, TextureAtlas   # noqa: F401
+from pyglet.graphics.framebuffer import Framebuffer, Renderbuffer  # noqa: F401
 
-if TYPE_CHECKING:
-    from pyglet.graphics.shader import ShaderProgram
-    from pyglet.graphics.vertexdomain import IndexedVertexList, VertexList
-
-_debug_graphics_batch = pyglet.options['debug_graphics_batch']
-
-
-def draw(size: int, mode: int, **data: Any) -> None:
-    """Draw a primitive immediately.
-
-    :warning: This function is deprecated as of 2.0.4, and will be removed
-              in the next release.
-
-    Args:
-        size:
-            Number of vertices given
-        mode:
-            OpenGL drawing mode, e.g. ``GL_TRIANGLES``, avoiding quotes.
-        **data: keyword arguments for passing vertex attribute data.
-            The keyword should be the vertex attribute name, and the
-            argument should be a tuple of (format, data). For example:
-            `position=('f', array)`
-
-    """
-    # Create and bind a throwaway VAO
-    vao_id = GLuint()
-    glGenVertexArrays(1, vao_id)
-    glBindVertexArray(vao_id)
-    # Activate shader program:
-    program = get_default_shader()
-    program.use()
-
-    buffers = []
-    for name, (fmt, array) in data.items():
-        location = program.attributes[name]['location']
-        count = program.attributes[name]['count']
-        gl_type = vertexdomain._gl_types[fmt[0]]
-        normalize = 'n' in fmt
-        attribute = shader.Attribute(name, location, count, gl_type, normalize, False)
-        assert size == len(array) // attribute.count, f'Data for {fmt} is incorrect length'
-
-        buffer = BufferObject(size * attribute.stride)
-        data = (attribute.c_type * len(array))(*array)
-        buffer.set_data(data)
-
-        attribute.enable()
-        attribute.set_pointer(buffer.ptr)
-        buffers.append(buffer)  # Don't garbage collect it.
-
-    glDrawArrays(mode, 0, size)
-
-    # Deactivate shader program:
-    program.stop()
-    # Discard everything after drawing:
-    del buffers
-    glBindVertexArray(0)
-    glDeleteVertexArrays(1, vao_id)
-
-
-def draw_indexed(size: int, mode: int, indices: Sequence[int], **data: Any) -> None:
-    """Draw a primitive with indexed vertices immediately.
-
-    :warning: This function is deprecated as of 2.0.4, and will be removed
-              in the next release.
-
-    Args:
-        size:
-            Number of vertices given
-        mode:
-            OpenGL drawing mode, e.g. ``GL_TRIANGLES``
-        indices:
-            Sequence of integers giving indices into the vertex list.
-        **data: keyword arguments for passing vertex attribute data.
-            The keyword should be the vertex attribute name, and the
-            argument should be a tuple of (format, data). For example:
-            `position=('f', array)`
-
-    """
-    # Create and bind a throwaway VAO
-    vao_id = GLuint()
-    glGenVertexArrays(1, vao_id)
-    glBindVertexArray(vao_id)
-    # Activate shader program:
-    program = get_default_shader()
-    program.use()
-
-    buffers = []
-    for name, (fmt, array) in data.items():
-        location = program.attributes[name]['location']
-        count = program.attributes[name]['count']
-        gl_type = vertexdomain._gl_types[fmt[0]]  # noqa: SLF001
-        normalize = 'n' in fmt
-        attribute = shader.Attribute(name, location, count, gl_type, normalize, False)
-        assert size == len(array) // attribute.count, f'Data for {fmt} is incorrect length'
-
-        buffer = BufferObject(size * attribute.stride)
-        data = (attribute.c_type * len(array))(*array)
-        buffer.set_data(data)
-
-        attribute.enable()
-        attribute.set_pointer(buffer.ptr)
-        buffers.append(buffer)  # Don't garbage collect it.
-
-    if size <= 0xff:
-        index_type = GL_UNSIGNED_BYTE
-        index_c_type = ctypes.c_ubyte
-    elif size <= 0xffff:
-        index_type = GL_UNSIGNED_SHORT
-        index_c_type = ctypes.c_ushort
-    else:
-        index_type = GL_UNSIGNED_INT
-        index_c_type = ctypes.c_uint
-
-    # With GL 3.3 vertex arrays indices needs to be in a buffer
-    # bound to the ELEMENT_ARRAY slot
-    index_array = (index_c_type * len(indices))(*indices)
-    index_buffer = BufferObject(ctypes.sizeof(index_array))
-    index_buffer.set_data(index_array)
-    index_buffer.bind_to_index_buffer()
-
-    glDrawElements(mode, len(indices), index_type, 0)
-    glFlush()
-
-    # Deactivate shader program:
-    program.stop()
-    # Discard everything after drawing:
-    del buffers
-    del index_buffer
-    glBindVertexArray(0)
-    glDeleteVertexArrays(1, vao_id)
-
-
-# Default Shader source:
-
-_vertex_source: str = """#version 330 core
-    in vec3 position;
-    in vec4 colors;
-    in vec3 tex_coords;
-    out vec4 vertex_colors;
-    out vec3 texture_coords;
-
-    uniform WindowBlock
-    {
-        mat4 projection;
-        mat4 view;
-    } window;
-
-    void main()
-    {
-        gl_Position = window.projection * window.view * vec4(position, 1.0);
-
-        vertex_colors = colors;
-        texture_coords = tex_coords;
-    }
-"""
-
-_fragment_source: str = """#version 330 core
-    in vec4 vertex_colors;
-    in vec3 texture_coords;
-    out vec4 final_colors;
-
-    uniform sampler2D our_texture;
-
-    void main()
-    {
-        final_colors = texture(our_texture, texture_coords.xy) + vertex_colors;
-    }
-"""
-
-# Default blit source
-_blit_vertex_source: str = """#version 330 core
-    in vec3 position;
-    in vec3 tex_coords;
-    out vec3 texture_coords;
-
-    uniform WindowBlock
-    {
-        mat4 projection;
-        mat4 view;
-    } window;
-
-    void main()
-    {
-        gl_Position = window.projection * window.view * vec4(position, 1.0);
-
-        texture_coords = tex_coords;
-    }
-"""
-
-_blit_fragment_source: str = """#version 330 core
-    in vec3 texture_coords;
-    out vec4 final_colors;
-
-    uniform sampler2D our_texture;
-
-    void main()
-    {
-        final_colors = texture(our_texture, texture_coords.xy);
-    }
-"""
-
-def get_default_batch() -> Batch:
-    """Batch used globally for objects that have no Batch specified."""
-    try:
-        return pyglet.gl.current_context.pyglet_graphics_default_batch
-    except AttributeError:
-        pyglet.gl.current_context.pyglet_graphics_default_batch = Batch()
-        return pyglet.gl.current_context.pyglet_graphics_default_batch
-
-
-def get_default_shader() -> ShaderProgram:
-    """A default basic shader for default batches."""
-    try:
-        return pyglet.gl.current_context.object_space.pyglet_graphics_default_shader
-    except AttributeError:
-        _vertex_shader = shader.Shader(_vertex_source, 'vertex')
-        _fragment_shader = shader.Shader(_fragment_source, 'fragment')
-        _shader_program = shader.ShaderProgram(_vertex_shader, _fragment_shader)
-        pyglet.gl.current_context.object_space.pyglet_graphics_default_shader = _shader_program
-        return pyglet.gl.current_context.object_space.pyglet_graphics_default_shader
-
-def get_default_blit_shader() -> ShaderProgram:
-    """A default basic shader for blitting, provides no blending."""
-    try:
-        return pyglet.gl.current_context.object_space.pyglet_graphics_default_blit_shader
-    except AttributeError:
-        _vertex_shader = shader.Shader(_blit_vertex_source, 'vertex')
-        _fragment_shader = shader.Shader(_blit_fragment_source, 'fragment')
-        _shader_program = shader.ShaderProgram(_vertex_shader, _fragment_shader)
-        pyglet.gl.current_context.object_space.pyglet_graphics_default_blit_shader = _shader_program
-        return pyglet.gl.current_context.object_space.pyglet_graphics_default_blit_shader
-
-_domain_class_map: dict[tuple[bool, bool], type[vertexdomain.VertexDomain]] = {
-    # Indexed, Instanced : Domain
-    (False, False): vertexdomain.VertexDomain,
-    (True, False): vertexdomain.IndexedVertexDomain,
-    (False, True): vertexdomain.InstancedVertexDomain,
-    (True, True): vertexdomain.InstancedIndexedVertexDomain,
-}
-
-DomainKey = Tuple[bool, int, int, str]
-
-class Batch:
-    """Manage a collection of drawables for batched rendering.
-
-    Many drawable pyglet objects accept an optional `Batch` argument in their
-    constructors. By giving a `Batch` to multiple objects, you can tell pyglet
-    that you expect to draw all of these objects at once, so it can optimise its
-    use of OpenGL. Hence, drawing a `Batch` is often much faster than drawing
-    each contained drawable separately.
-
-    The following example creates a batch, adds two sprites to the batch, and
-    then draws the entire batch::
-
-        batch = pyglet.graphics.Batch()
-        car = pyglet.sprite.Sprite(car_image, batch=batch)
-        boat = pyglet.sprite.Sprite(boat_image, batch=batch)
-
-        def on_draw():
-            batch.draw()
-
-    While any drawables can be added to a `Batch`, only those with the same
-    draw mode, shader program, and group can be optimised together.
-
-    Internally, a `Batch` manages a set of VertexDomains along with
-    information about how the domains are to be drawn. To implement batching on
-    a custom drawable, get your vertex domains from the given batch instead of
-    setting them up yourself.
-    """
-    _draw_list: list[Callable]
-    top_groups: list[Group]
-    group_children: dict[Group, list[Group]]
-    group_map: dict[Group, dict[DomainKey, vertexdomain.VertexDomain]]
-
-    def __init__(self) -> None:
-        """Create a graphics batch."""
-        # Mapping to find domain.
-        # group -> (attributes, mode, indexed) -> domain
-        self.group_map = {}
-
-        # Mapping of group to list of children.
-        self.group_children = {}
-
-        # List of top-level groups
-        self.top_groups = []
-
-        self._draw_list = []
-        self._draw_list_dirty = False
-
-        self._context = pyglet.gl.current_context
-
-        self._instance_count = 0
-
-    def invalidate(self) -> None:
-        """Force the batch to update the draw list.
-
-        This method can be used to force the batch to re-compute the draw list
-        when the ordering of groups has changed.
-
-        .. versionadded:: 1.2
-        """
-        self._draw_list_dirty = True
-
-    def update_shader(self, vertex_list: VertexList | IndexedVertexList, mode: int, group: Group,
-                      program: ShaderProgram) -> bool:
-        """Migrate a vertex list to another domain that has the specified shader attributes.
-
-        The results are undefined if `mode` is not correct or if `vertex_list`
-        does not belong to this batch (they are not checked and will not
-        necessarily throw an exception immediately).
-
-        Args:
-            vertex_list:
-                A vertex list currently belonging to this batch.
-            mode:
-                The current GL drawing mode of the vertex list.
-            group:
-                The new group to migrate to.
-            program:
-                The new shader program to migrate to.
-
-        Returns:
-            False if the domain's no longer match. The caller should handle this scenario.
-        """
-        # No new attributes.
-        attributes = program.attributes.copy()
-
-        # Formats may differ (normalization) than what is declared in the shader.
-        # Make those adjustments and attempt to get a domain.
-        for a_name in attributes:
-            if (a_name in vertex_list.initial_attribs and
-                    vertex_list.initial_attribs[a_name]['format'] != attributes[a_name]['format']):
-                attributes[a_name]['format'] = vertex_list.initial_attribs[a_name]['format']
-
-        domain = self.get_domain(vertex_list.indexed, vertex_list.instanced, mode, group, attributes)
-
-        # TODO: Allow migration if we can restore original vertices somehow. Much faster.
-        # If the domain's don't match, we need to re-create the vertex list. Tell caller no match.
-        if domain != vertex_list.domain:
-            return False
-
-        return True
-
-    def migrate(self, vertex_list: VertexList | IndexedVertexList, mode: int, group: Group, batch: Batch) -> None:
-        """Migrate a vertex list to another batch and/or group.
-
-        `vertex_list` and `mode` together identify the vertex list to migrate.
-        `group` and `batch` are new owners of the vertex list after migration.
-
-        The results are undefined if `mode` is not correct or if `vertex_list`
-        does not belong to this batch (they are not checked and will not
-        necessarily throw an exception immediately).
-
-        ``batch`` can remain unchanged if only a group change is desired.
-
-        Args:
-            vertex_list:
-                A vertex list currently belonging to this batch.
-            mode:
-                The current GL drawing mode of the vertex list.
-            group:
-                The new group to migrate to.
-            batch:
-                The batch to migrate to (or the current batch).
-
-        """
-        attributes = vertex_list.domain.attribute_meta
-        domain = batch.get_domain(vertex_list.indexed, vertex_list.instanced, mode, group, attributes)
-        vertex_list.migrate(domain)
-
-    def _convert_to_instanced(self, domain: vertexdomain.VertexDomain | vertexdomain.IndexedVertexDomain,
-                              instance_attributes: Sequence[
-                                  str]) -> (vertexdomain.InstancedVertexDomain |
-                                            vertexdomain.InstancedIndexedVertexDomain):
-        """Takes a domain from inside the Batch and creates a new instanced version."""
-        # Search for the existing domain.
-        for group, domain_map in self.group_map.items():
-            for key, mapped_domain in domain_map.items():
-                if domain == mapped_domain:
-                    # Set instance attributes.
-                    new_attributes = mapped_domain.attribute_meta.copy()
-                    for name, attribute_dict in new_attributes.items():
-                        if name in instance_attributes:
-                            attribute_dict['instance'] = True
-                    dindexed, dinstanced, dmode, _ = key
-
-                    assert dinstanced == 0, "Cannot convert an instanced domain."
-                    return self.get_domain(dindexed, True, dmode, group, new_attributes)
-
-        msg = "Domain was not found and could not be converted."
-        raise Exception(msg)
-
-    def get_domain(self, indexed: bool, instanced: bool, mode: int, group: Group,
-                   attributes: dict[str, Any]) -> (
-            vertexdomain.VertexDomain | vertexdomain.IndexedVertexDomain | vertexdomain.InstancedVertexDomain |
-            vertexdomain.InstancedIndexedVertexDomain):
-        """Get, or create, the vertex domain corresponding to the given arguments.
-
-        mode is the render mode such as GL_LINES or GL_TRIANGLES
-        """
-        # Batch group
-        if group not in self.group_map:
-            self._add_group(group)
-
-        domain_map = self.group_map[group]
-
-        # If instanced, ensure a separate domain, as multiple instance sources can match the key.
-        if instanced:
-            self._instance_count += 1
-            key = (indexed, self._instance_count, mode, str(attributes))
-        else:
-            # Find domain given formats, indices and mode
-            key = (indexed, 0, mode, str(attributes))
-
-        try:
-            domain = domain_map[key]
-        except KeyError:
-            # Create domain
-            domain = _domain_class_map[(indexed, instanced)](attributes)
-            domain_map[key] = domain
-            self._draw_list_dirty = True
-
-        return domain
-
-    def _add_group(self, group: Group) -> None:
-        self.group_map[group] = {}
-        if group.parent is None:
-            self.top_groups.append(group)
-        else:
-            if group.parent not in self.group_map:
-                self._add_group(group.parent)
-            if group.parent not in self.group_children:
-                self.group_children[group.parent] = []
-            self.group_children[group.parent].append(group)
-
-        group._assigned_batches.add(self)  # noqa: SLF001
-        self._draw_list_dirty = True
-
-    def _update_draw_list(self) -> None:
-        """Visit group tree in preorder and create a list of bound methods to call."""
-
-        def visit(group: Group) -> list:
-            draw_list = []
-
-            # Draw domains using this group
-            domain_map = self.group_map[group]
-
-            # indexed, instanced, mode, program, str(attributes))
-            for (indexed, instanced, mode, formats), domain in list(domain_map.items()):
-                # Remove unused domains from batch
-                if domain.is_empty:
-                    del domain_map[(indexed, instanced, mode, formats)]
-                    continue
-                draw_list.append((lambda d, m: lambda: d.draw(m))(domain, mode))  # noqa: PLC3002
-
-            # Sort and visit child groups of this group
-            children = self.group_children.get(group)
-            if children:
-                children.sort()
-                for child in list(children):
-                    if child.visible:
-                        draw_list.extend(visit(child))
-
-            if children or domain_map:
-                return [group.set_state, *draw_list, group.unset_state]
-
-            # Remove unused group from batch
-            del self.group_map[group]
-            group._assigned_batches.remove(self)  # noqa: SLF001
-            if group.parent:
-                self.group_children[group.parent].remove(group)
-            try:
-                del self.group_children[group]
-            except KeyError:
-                pass
-            try:
-                self.top_groups.remove(group)
-            except ValueError:
-                pass
-
-            return []
-
-        self._draw_list = []
-
-        self.top_groups.sort()
-        for top_group in list(self.top_groups):
-            if top_group.visible:
-                self._draw_list.extend(visit(top_group))
-
-        self._draw_list_dirty = False
-
-        if _debug_graphics_batch:
-            self._dump_draw_list()
-
-    def _dump_draw_list(self) -> None:
-        def dump(group: Group, indent: str = '') -> None:
-            print(indent, 'Begin group', group)
-            domain_map = self.group_map[group]
-            for domain in domain_map.values():
-                print(indent, '  ', domain)
-                for start, size in zip(*domain.allocator.get_allocated_regions()):
-                    print(indent, '    ', 'Region %d size %d:' % (start, size))
-                    for key, buffer in domain.attrib_name_buffers.items():
-                        print(indent, '      ', end=' ')
-                        try:
-                            region = buffer.get_region(start, size)
-                            print(key, region.array[:])
-                        except:  # noqa: E722
-                            print(key, '(unmappable)')
-            for child in self.group_children.get(group, ()):
-                dump(child, indent + '  ')
-            print(indent, 'End group', group)
-
-        print(f'Draw list for {self!r}:')
-        for group in self.top_groups:
-            dump(group)
-
-    def draw(self) -> None:
-        """Draw the batch."""
-        if self._draw_list_dirty:
-            self._update_draw_list()
-
-        for func in self._draw_list:
-            func()
-
-    def draw_subset(self, vertex_lists: Sequence[VertexList | IndexedVertexList]) -> None:
-        """Draw only some vertex lists in the batch.
-
-        The use of this method is highly discouraged, as it is quite
-        inefficient.  Usually an application can be redesigned so that batches
-        can always be drawn in their entirety, using `draw`.
-
-        The given vertex lists must belong to this batch; behaviour is
-        undefined if this condition is not met.
-
-        Args:
-            vertex_lists:
-                Vertex lists to draw.
-
-        """
-
-        # Horrendously inefficient.
-        def visit(group: Group) -> None:
-            group.set_state()
-
-            # Draw domains using this group
-            domain_map = self.group_map[group]
-            for (_, _, mode, _, _), domain in domain_map.items():
-                for alist in vertex_lists:
-                    if alist.domain is domain:
-                        alist.draw(mode)
-
-            # Sort and visit child groups of this group
-            children = self.group_children.get(group)
-            if children:
-                children.sort()
-                for child in children:
-                    if child.visible:
-                        visit(child)
-
-            group.unset_state()
-
-        self.top_groups.sort()
-        for top_group in self.top_groups:
-            if top_group.visible:
-                visit(top_group)
-
-
-class Group:
-    """Group of common OpenGL state.
-
-    ``Group`` provides extra control over how drawables are handled within a
-    ``Batch``. When a batch draws a drawable, it ensures its group's state is set;
-    this can include binding textures, shaders, or setting any other parameters.
-    It also sorts the groups before drawing.
-
-    In the following example, the background sprite is guaranteed to be drawn
-    before the car and the boat::
-
-        batch = pyglet.graphics.Batch()
-        background = pyglet.graphics.Group(order=0)
-        foreground = pyglet.graphics.Group(order=1)
-
-        background = pyglet.sprite.Sprite(background_image, batch=batch, group=background)
-        car = pyglet.sprite.Sprite(car_image, batch=batch, group=foreground)
-        boat = pyglet.sprite.Sprite(boat_image, batch=batch, group=foreground)
-
-        def on_draw():
-            batch.draw()
-    """
-
-    def __init__(self, order: int = 0, parent: Group | None = None) -> None:
-        """Initialize a rendering group.
-
-        Args:
-            order:
-                Set the order to render above or below other Groups.
-                Lower orders are drawn first.
-            parent:
-                Group to contain this Group; its state will be set before this Group's state.
-        """
-        self._order = order
-        self.parent = parent
-        self._visible = True
-        self._assigned_batches = weakref.WeakSet()
-
-    @property
-    def order(self) -> int:
-        """Rendering order of this group compared to others.
-
-        Lower numbers are drawn first.
-        """
-        return self._order
-
-    @property
-    def visible(self) -> bool:
-        """Visibility of the group in the rendering pipeline.
-
-        Determines whether this Group is visible in any of the Batches
-        it is assigned to. If ``False``, objects in this Group will not
-        be rendered.
-        """
-        return self._visible
-
-    @visible.setter
-    def visible(self, value: bool) -> None:
-        self._visible = value
-
-        for batch in self._assigned_batches:
-            batch.invalidate()
-
-    @property
-    def batches(self) -> tuple[Batch, ...]:
-        """Which graphics Batches this Group is a part of.
-
-        Read Only.
-        """
-        return tuple(self._assigned_batches)
-
-    def __lt__(self, other: Group) -> bool:
-        return self._order < other.order
-
-    def __eq__(self, other: Group) -> bool:
-        """Comparison function used to determine if another Group is providing the same state.
-
-        When the same state is determined, those groups will be consolidated into one draw call.
-
-        If subclassing, then care must be taken to ensure this function can compare to another of the same group.
-
-        :see: ``__hash__`` function, both must be implemented.
-        """
-        return (self.__class__ is other.__class__ and
-                self._order == other.order and
-                self.parent == other.parent)
-
-    def __hash__(self) -> int:
-        """This is an immutable return to establish the permanent identity of the object.
-
-        This is used by Python with ``__eq__`` to determine if something is unique.
-
-        For simplicity, the hash should be a tuple containing your unique identifiers of your Group.
-
-        By default, this is (``order``, ``parent``).
-
-        :see: ``__eq__`` function, both must be implemented.
-        """
-        return hash((self._order, self.parent))
-
-    def __repr__(self) -> str:
-        return f"{self.__class__.__name__}(order={self._order})"
-
-    def set_state(self) -> None:
-        """Apply the OpenGL state change.
-
-        The default implementation does nothing.
-        """
-
-    def unset_state(self) -> None:
-        """Repeal the OpenGL state change.
-
-        The default implementation does nothing.
-        """
-
-    def set_state_recursive(self) -> None:
-        """Set this group and its ancestry.
-
-        Call this method if you are using a group in isolation: the
-        parent groups will be called in top-down order, with this class's
-        ``set`` being called last.
-        """
-        if self.parent:
-            self.parent.set_state_recursive()
-        self.set_state()
-
-    def unset_state_recursive(self) -> None:
-        """Unset this group and its ancestry.
-
-        The inverse of ``set_state_recursive``.
-        """
-        self.unset_state()
-        if self.parent:
-            self.parent.unset_state_recursive()
-
-
-# Example Groups.
-
-class ShaderGroup(Group):
-    """A group that enables and binds a ShaderProgram."""
-
-    def __init__(self, program: ShaderProgram, order: int = 0, parent: Group | None = None) -> None:  # noqa: D107
-        super().__init__(order, parent)
-        self.program = program
-
-    def set_state(self) -> None:
-        self.program.use()
-
-    def unset_state(self) -> None:
-        self.program.stop()
-
-    def __eq__(self, other: ShaderGroup) -> bool:
-        return (self.__class__ is other.__class__ and
-                self._order == other.order and
-                self.program == other.program and
-                self.parent == other.parent)
-
-    def __hash__(self) -> int:
-        return hash((self._order, self.parent, self.program))
-
-
-class TextureGroup(Group):
-    """A group that enables and binds a texture.
-
-    TextureGroups are equal if their textures' targets and names are equal.
-    """
-
-    def __init__(self, texture: pyglet.image.Texture, order: int = 0, parent: Group | None = None) -> None:
-        """Create a texture group.
-
-        Args:
-            texture:
-                Texture to bind.
-            order:
-                Change the order to render above or below other Groups.
-            parent:
-                Parent group.
-        """
-        super().__init__(order, parent)
-        self.texture = texture
-
-    def set_state(self) -> None:
-        glActiveTexture(GL_TEXTURE0)
-        glBindTexture(self.texture.target, self.texture.id)
-
-    def __hash__(self) -> int:
-        return hash((self.texture.target, self.texture.id, self.order, self.parent))
-
-    def __eq__(self, other: TextureGroup) -> bool:
-        return (self.__class__ is other.__class__ and
-                self.texture.target == other.texture.target and
-                self.texture.id == other.texture.id and
-                self.order == other.order and
-                self.parent == other.parent)
-
-    def __repr__(self) -> str:
-        return f'{self.__class__.__name__}(id={self.texture.id})'