:right-sidebar: True

FrameRequest
===================================================================

.. currentmodule:: gi.repository.Gly


.. versionadded:: 2.0




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


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





Defines which parts of an image to load.

::: warning
    Loaders can and frequently will ignore instructions set in
    ``GlyFrameRequest``\. The reason is that for most loaders
    many instructions don't have a meaningful interpretation.


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

.. rst-class:: interim-class

.. class:: FrameRequest
   :no-index:


   .. classmethod:: new() -> ~gi.repository.Gly.FrameRequest

      Creates a new frame request.


      .. versionadded:: 2.0












Methods
-------

.. rst-class:: interim-class

.. class:: FrameRequest
   :no-index:


   .. method:: set_loop_animation(loop_animation: bool) -> None

      Controls if first frame is returned after last frame

      By default, this option is set to ``TRUE``\, returning the first frame, if
      the previously requested frame was the last frame.



      .. versionadded:: 2.0.1





      :param loop_animation: 




   .. method:: set_scale(width: int, height: int) -> None

      Set maximum dimensions for the frame. The texture will be scaled
      to be within the maximum dimensions while keeping its aspect ratio.
      This option is especially useful to SVGs which will be rendered at
      the respective size.

      ::: warning
          Most loaders will ignore this option. Currently, only the SVG
          loader is known to obey it.



      .. versionadded:: 2.0





      :param width: Maximum width

      :param height: Maximum height








Properties
----------

.. rst-class:: interim-class

.. class:: FrameRequest
   :no-index:
   

   .. attribute:: props.loop_animation
      :type: bool

      The type of the None singleton.







   .. attribute:: props.scale_height
      :type: int

      The type of the None singleton.







   .. attribute:: props.scale_width
      :type: int

      The type of the None singleton.