Struct gdk_pixbuf::PixbufAnimationIter

pub struct PixbufAnimationIter { /* private fields */ }

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

Implementations

impl PixbufAnimationIter

pub fn advance(&self, current_time: SystemTime) -> bool

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.

current_time

current time

Returns

TRUE if the image may need updating

pub fn pixbuf(&self) -> Pixbuf

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

pub fn delay_time(&self) -> Option<Duration>

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)

pub fn on_currently_loading_frame(&self) -> bool

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

Trait Implementations

impl Clone for PixbufAnimationIter

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PixbufAnimationIter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for PixbufAnimationIter

type ParamSpec = ParamSpecObject

type SetValue = PixbufAnimationIter

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, PixbufAnimationIter>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for PixbufAnimationIter

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PixbufAnimationIterImpl> IsSubclassable<T> for PixbufAnimationIter

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for PixbufAnimationIter

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for PixbufAnimationIter

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for PixbufAnimationIter

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for PixbufAnimationIter

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for PixbufAnimationIter

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PixbufAnimationIter