:mod:`_stage`
=============

.. py:module:: _stage

.. autoapi-nested-parse::

   C-level helpers for animation of sprites on a stage

   The `_stage` module contains native code to speed-up the ```stage`` Library
   <https://github.com/python-ugame/circuitpython-stage>`_.



.. raw:: html

    <p>
    <details>
    <summary>Available on these boards</summary>
    <ul>
    <li> Adafruit EdgeBadge
    <li> Adafruit PyGamer
    <li> Adafruit Pybadge
    <li> Electronut Labs Blip
    <li> MEOWBIT
    <li> PewPew M4
    <li> Pimoroni PicoSystem
    <li> TinyS2
    <li> uGame10
    </ul>
    </details>
    </p>




.. py:function:: render(x0: int, y0: int, x1: int, y1: int, layers: List[Layer], buffer: _typing.WriteableBuffer, display: displayio.Display, scale: int, background: int) -> None

   Render and send to the display a fragment of the screen.

   :param int x0: Left edge of the fragment.
   :param int y0: Top edge of the fragment.
   :param int x1: Right edge of the fragment.
   :param int y1: Bottom edge of the fragment.
   :param layers: A list of the :py:class:`~_stage.Layer` objects.
   :type layers: list[Layer]
   :param ~_typing.WriteableBuffer buffer: A buffer to use for rendering.
   :param ~displayio.Display display: The display to use.
   :param int scale: How many times should the image be scaled up.
   :param int background: What color to display when nothing is there.

   There are also no sanity checks, outside of the basic overflow
   checking. The caller is responsible for making the passed parameters
   valid.

   This function is intended for internal use in the ``stage`` library
   and all the necessary checks are performed there.


.. py:class:: Layer(width: int, height: int, graphic: _typing.ReadableBuffer, palette: _typing.ReadableBuffer, grid: _typing.ReadableBuffer)

   Keep information about a single layer of graphics

   Keep internal information about a layer of graphics (either a
   ``Grid`` or a ``Sprite``) in a format suitable for fast rendering
   with the ``render()`` function.

   :param int width: The width of the grid in tiles, or 1 for sprites.
   :param int height: The height of the grid in tiles, or 1 for sprites.
   :param ~_typing.ReadableBuffer graphic: The graphic data of the tiles.
   :param ~_typing.ReadableBuffer palette: The color palette to be used.
   :param ~_typing.ReadableBuffer grid: The contents of the grid map.

   This class is intended for internal use in the ``stage`` library and
   it shouldn't be used on its own.

   .. py:method:: move(x: int, y: int) -> None

      Set the offset of the layer to the specified values.


   .. py:method:: frame(frame: int, rotation: int) -> None

      Set the animation frame of the sprite, and optionally rotation its
      graphic.



.. py:class:: Text(width: int, height: int, font: _typing.ReadableBuffer, palette: _typing.ReadableBuffer, chars: _typing.ReadableBuffer)

   Keep information about a single grid of text

   Keep internal information about a grid of text
   in a format suitable for fast rendering
   with the ``render()`` function.

   :param int width: The width of the grid in tiles, or 1 for sprites.
   :param int height: The height of the grid in tiles, or 1 for sprites.
   :param ~_typing.ReadableBuffer font: The font data of the characters.
   :param ~_typing.ReadableBuffer palette: The color palette to be used.
   :param ~_typing.ReadableBuffer chars: The contents of the character grid.

   This class is intended for internal use in the ``stage`` library and
   it shouldn't be used on its own.

   .. py:method:: move(x: int, y: int) -> None

      Set the offset of the text to the specified values.