:right-sidebar: True PixbufAnimationIter =================================================================== .. currentmodule:: gi.repository.GdkPixbuf .. class:: PixbufAnimationIter(**properties: ~typing.Any) :no-contents-entry: Superclasses: :class:`~gi.repository.GObject.Object` Subclasses: :class:`~gi.repository.GdkPixbuf.PixbufSimpleAnimIter` An opaque object representing an iterator which points to a certain position in an animation. Methods ------- .. rst-class:: interim-class .. class:: PixbufAnimationIter :no-index: .. method:: advance(current_time: ~gi.repository.GLib.TimeVal | None = None) -> bool Possibly advances an animation to a new frame. Chooses the frame based on the start time passed to :func:`~gi.repository.GdkPixbuf.PixbufAnimation.get_iter`. ``current_time`` would normally come from :func:`~gi.repository.GLib.get_current_time`, and must be greater than or equal to the time passed to :func:`~gi.repository.GdkPixbuf.PixbufAnimation.get_iter`, and must increase or remain unchanged each time :func:`~gi.repository.GdkPixbuf.PixbufAnimationIter.get_pixbuf` is called. That is, you can't go backward in time; animations only play forward. As a shortcut, pass ``NULL`` for the current time and :func:`~gi.repository.GLib.get_current_time` will be invoked on your behalf. So you only need to explicitly pass ``current_time`` if you're doing something odd like playing the animation at double speed. If this function returns ``FALSE``\, there's no need to update the animation display, assuming the display had been rendered prior to advancing; if ``TRUE``\, you need to call :func:`~gi.repository.GdkPixbuf.PixbufAnimationIter.get_pixbuf` and update the display with the new pixbuf. :param current_time: current time .. method:: do_advance(self, current_time: ~gi.repository.GLib.TimeVal | None = None) -> bool :param current_time: .. method:: do_get_delay_time(self) -> int .. method:: do_get_pixbuf(self) -> ~gi.repository.GdkPixbuf.Pixbuf .. method:: do_on_currently_loading_frame(self) -> bool .. method:: get_delay_time() -> int Gets the number of milliseconds the current pixbuf should be displayed, or -1 if the current pixbuf should be displayed forever. The ``g_timeout_add()`` function conveniently takes a timeout in milliseconds, so you can use a timeout to schedule the next update. Note that some formats, like GIF, might clamp the timeout values in the image file to avoid updates that are just too quick. The minimum timeout for GIF images is currently 20 milliseconds. .. method:: get_pixbuf() -> ~gi.repository.GdkPixbuf.Pixbuf Gets the current pixbuf which should be displayed. The pixbuf might not be the same size as the animation itself (:func:`~gi.repository.GdkPixbuf.PixbufAnimation.get_width`, :func:`~gi.repository.GdkPixbuf.PixbufAnimation.get_height`). This pixbuf should be displayed for :func:`~gi.repository.GdkPixbuf.PixbufAnimationIter.get_delay_time` milliseconds. The caller of this function does not own a reference to the returned pixbuf; the returned pixbuf will become invalid when the iterator advances to the next frame, which may happen anytime you call :func:`~gi.repository.GdkPixbuf.PixbufAnimationIter.advance`. Copy the pixbuf to keep it (don't just add a reference), as it may get recycled as you advance the iterator. .. method:: on_currently_loading_frame() -> bool Used to determine how to respond to the area_updated signal on :obj:`~gi.repository.GdkPixbuf.PixbufLoader` when loading an animation. The ``::area_updated`` signal is emitted for an area of the frame currently streaming in to the loader. So if you're on the currently loading frame, you will need to redraw the screen for the updated area. Virtual Methods --------------- .. rst-class:: interim-class .. class:: PixbufAnimationIter :no-index: .. method:: do_advance(current_time: ~gi.repository.GLib.TimeVal | None = None) -> bool Possibly advances an animation to a new frame. Chooses the frame based on the start time passed to :func:`~gi.repository.GdkPixbuf.PixbufAnimation.get_iter`. ``current_time`` would normally come from :func:`~gi.repository.GLib.get_current_time`, and must be greater than or equal to the time passed to :func:`~gi.repository.GdkPixbuf.PixbufAnimation.get_iter`, and must increase or remain unchanged each time :func:`~gi.repository.GdkPixbuf.PixbufAnimationIter.get_pixbuf` is called. That is, you can't go backward in time; animations only play forward. As a shortcut, pass ``NULL`` for the current time and :func:`~gi.repository.GLib.get_current_time` will be invoked on your behalf. So you only need to explicitly pass ``current_time`` if you're doing something odd like playing the animation at double speed. If this function returns ``FALSE``\, there's no need to update the animation display, assuming the display had been rendered prior to advancing; if ``TRUE``\, you need to call :func:`~gi.repository.GdkPixbuf.PixbufAnimationIter.get_pixbuf` and update the display with the new pixbuf. :param current_time: current time .. method:: do_get_delay_time() -> int Gets the number of milliseconds the current pixbuf should be displayed, or -1 if the current pixbuf should be displayed forever. The ``g_timeout_add()`` function conveniently takes a timeout in milliseconds, so you can use a timeout to schedule the next update. Note that some formats, like GIF, might clamp the timeout values in the image file to avoid updates that are just too quick. The minimum timeout for GIF images is currently 20 milliseconds. .. method:: do_get_pixbuf() -> ~gi.repository.GdkPixbuf.Pixbuf Gets the current pixbuf which should be displayed. The pixbuf might not be the same size as the animation itself (:func:`~gi.repository.GdkPixbuf.PixbufAnimation.get_width`, :func:`~gi.repository.GdkPixbuf.PixbufAnimation.get_height`). This pixbuf should be displayed for :func:`~gi.repository.GdkPixbuf.PixbufAnimationIter.get_delay_time` milliseconds. The caller of this function does not own a reference to the returned pixbuf; the returned pixbuf will become invalid when the iterator advances to the next frame, which may happen anytime you call :func:`~gi.repository.GdkPixbuf.PixbufAnimationIter.advance`. Copy the pixbuf to keep it (don't just add a reference), as it may get recycled as you advance the iterator. .. method:: do_on_currently_loading_frame() -> bool Used to determine how to respond to the area_updated signal on :obj:`~gi.repository.GdkPixbuf.PixbufLoader` when loading an animation. The ``::area_updated`` signal is emitted for an area of the frame currently streaming in to the loader. So if you're on the currently loading frame, you will need to redraw the screen for the updated area. Fields ------ .. rst-class:: interim-class .. class:: PixbufAnimationIter :no-index: .. attribute:: parent_instance