:right-sidebar: True

VectorSpriteSheet
===================================================================

.. currentmodule:: gi.repository.Shumate


.. versionadded:: 1.1




.. class:: VectorSpriteSheet(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`





:Constructors:

::

    VectorSpriteSheet(**properties)
    new() -> Shumate.VectorSpriteSheet



Constructors
------------

.. rst-class:: interim-class

.. class:: VectorSpriteSheet
   :no-index:


   .. classmethod:: new() -> ~gi.repository.Shumate.VectorSpriteSheet

      Creates a new, empty :obj:`~gi.repository.Shumate.VectorSpriteSheet`.



      .. versionadded:: 1.1












Methods
-------

.. rst-class:: interim-class

.. class:: VectorSpriteSheet
   :no-index:


   .. method:: add_page(texture: ~gi.repository.Gdk.Texture, json: str, default_scale: float) -> bool

      Adds a page to the spritesheet.

      See <https://maplibre.org/maplibre-gl-js-docs/style-spec/sprite/> for
      details about the spritesheet format. Most stylesheets provide these files
      along with the main style JSON.

      Map styles should provide a double resolution spritesheet for high DPI
      displays. That spritesheet should be added as its own page, with a
      ``default_scale`` of 2.



      .. versionadded:: 1.1





      :param texture: a :obj:`~gi.repository.Gdk.Texture`


      :param json: a JSON string


      :param default_scale: the default scale factor of the page





   .. method:: add_sprite(name: str, sprite: ~gi.repository.Shumate.VectorSprite) -> None

      Adds a sprite to the spritesheet.



      .. versionadded:: 1.1





      :param name: the name of the sprite


      :param sprite: a :obj:`~gi.repository.Shumate.VectorSprite`





   .. method:: get_sprite(name: str, scale: float) -> ~gi.repository.Shumate.VectorSprite | None

      Gets a sprite from the spritesheet.

      The returned sprite might not be at the requested scale factor if an exact
      match is not found.



      .. versionadded:: 1.1





      :param name: an icon name


      :param scale: the scale factor of the icon





   .. method:: set_fallback(fallback: ~typing.Callable[[...], ~gi.repository.Shumate.VectorSprite | None] | None = None, *user_data: ~typing.Any) -> None

      Sets a fallback function to generate sprites.

      The fallback function is called when a texture is not found in the sprite
      sheet. It receives the icon name and scale factor, and should return a
      :obj:`~gi.repository.Shumate.VectorSprite`, or :const:`None` if the icon could not be generated.
      It may be called in a different thread, and it may be called multiple times
      for the same icon name.

      If a previous fallback function was set, it will be replaced and any sprites
      it generated will be cleared.

      ``fallback`` may be :const:`None` to clear the fallback function.



      .. versionadded:: 1.1





      :param fallback: a ``ShumateVectorSpriteFallbackFunc`` or :const:`None`


      :param user_data: user data to pass to ``fallback``