Package ch.bailu.gtk.gdkpixbuf

Class PixbufAnimationIter

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.gobject.Object
ch.bailu.gtk.gdkpixbuf.PixbufAnimationIter
All Implemented Interfaces:
PointerInterface
Direct Known Subclasses:
PixbufSimpleAnimIter
public class PixbufAnimationIter extends Object
An opaque object representing an iterator which points to a
certain position in an animation.

https://docs.gtk.org/gdk-pixbuf/class.PixbufAnimationIter.html

  • Constructor Details

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • advance

      public boolean advance(@Nullable TimeVal current_time)
      Possibly advances an animation to a new frame.

      Chooses the frame based on the start time passed to
      gdk_pixbuf_animation_get_iter().

      @current_time would normally come from g_get_current_time(), and
      must be greater than or equal to the time passed to
      gdk_pixbuf_animation_get_iter(), and must increase or remain
      unchanged each time gdk_pixbuf_animation_iter_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 g_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 gdk_pixbuf_animation_iter_get_pixbuf()
      and update the display with the new pixbuf.
      Parameters:
      current_time - current time
      Returns:
      `TRUE` if the image may need updating

    • getDelayTime

      public int getDelayTime()
      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.
      Returns:
      delay time in milliseconds (thousandths of a second)

    • getPixbuf

      public Pixbuf getPixbuf()
      Gets the current pixbuf which should be displayed.

      The pixbuf might not be the same size as the animation itself
      (gdk_pixbuf_animation_get_width(), gdk_pixbuf_animation_get_height()).

      This pixbuf should be displayed for gdk_pixbuf_animation_iter_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
      gdk_pixbuf_animation_iter_advance().

      Copy the pixbuf to keep it (don't just add a reference), as it may get
      recycled as you advance the iterator.
      Returns:
      the pixbuf to be displayed

    • onCurrentlyLoadingFrame

      public boolean onCurrentlyLoadingFrame()
      Used to determine how to respond to the area_updated signal on
      #GdkPixbufLoader 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.
      Returns:
      `TRUE` if the frame we're on is partially loaded, or the last frame

    • getTypeID

      public static long getTypeID()

    • getParentTypeID

      public static long getParentTypeID()

    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()

    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()

    • getInstanceSize

      public static int getInstanceSize()