PixbufAnimationIterProtocol

public protocol PixbufAnimationIterProtocol : ObjectProtocol

An opaque object representing an iterator which points to a certain position in an animation.

The PixbufAnimationIterProtocol protocol exposes the methods and properties of an underlying GdkPixbufAnimationIter instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see PixbufAnimationIter. Alternatively, use PixbufAnimationIterRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GdkPixbufAnimationIter instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • pixbuf_animation_iter_ptr Default implementation

    Typed pointer to the underlying GdkPixbufAnimationIter instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GdkPixbufAnimationIter instance.

    Declaration

    Swift

    var pixbuf_animation_iter_ptr: UnsafeMutablePointer<GdkPixbufAnimationIter>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to PixbufAnimationIterProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

PixbufAnimationIter Class: PixbufAnimationIterProtocol extension (methods and fields)

  • advance(currentTime:) Extension method

    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.

    Declaration

    Swift

    @inlinable
func advance(currentTime: GLib.TimeValRef? = nil) -> Bool
    Show on GitHub
  • advance(currentTime:) Extension method

    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.

    Declaration

    Swift

    @inlinable
func advance<GLibTimeValT>(currentTime: GLibTimeValT?) -> Bool where GLibTimeValT : TimeValProtocol
    Show on GitHub
  • getDelayTime() Extension method

    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.

    Declaration

    Swift

    @inlinable
func getDelayTime() -> Int
    Show on GitHub
  • getPixbuf() Extension method

    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.

    Declaration

    Swift

    @inlinable
func getPixbuf() -> GdkPixBuf.PixbufRef!
    Show on GitHub
  • onCurrentlyLoadingFrame() Extension method

    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.

    Declaration

    Swift

    @inlinable
func onCurrentlyLoadingFrame() -> Bool
    Show on GitHub
  • delayTime Extension method

    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.

    Declaration

    Swift

    @inlinable
var delayTime: Int { get }
    Show on GitHub
  • pixbuf Extension method

    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.

    Declaration

    Swift

    @inlinable
var pixbuf: GdkPixBuf.PixbufRef! { get }
    Show on GitHub
  • parentInstance Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var parentInstance: GObject { get }
    Show on GitHub