Struct gdk_pixbuf::PixbufAnimationIter[][src]

pub struct PixbufAnimationIter(_);
Expand description

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

Implementations

Possibly advances an animation to a new frame. Chooses the frame based on the start time passed to PixbufAnimationExtManual::iter().

current_time would normally come from g_get_current_time(), and must be greater than or equal to the time passed to PixbufAnimationExtManual::iter(), and must increase or remain unchanged each time [PixbufAnimationIterExtManual::pixbuf()][crate::prelude::PixbufAnimationIterExtManual::pixbuf()] is called. That is, you can’t go backward in time; animations only play forward.

As a shortcut, pass None 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 [PixbufAnimationIterExtManual::pixbuf()][crate::prelude::PixbufAnimationIterExtManual::pixbuf()] and update the display with the new pixbuf.

current_time

current time

Returns

true if the image may need updating

Gets the current pixbuf which should be displayed; the pixbuf might not be the same size as the animation itself (PixbufAnimationExt::width(), PixbufAnimationExt::height()). This pixbuf should be displayed for [PixbufAnimationIterExtManual::delay_time()][crate::prelude::PixbufAnimationIterExtManual::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 [PixbufAnimationIterExtManual::advance()][crate::prelude::PixbufAnimationIterExtManual::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

Gets the number of milliseconds the current pixbuf should be displayed, or -1 if the current pixbuf should be displayed forever. g_timeout_add() 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)

Used to determine how to respond to the area_updated signal on PixbufLoader when loading an animation. area_updated is emitted for an area of the frame currently streaming in to the loader. So if you’re on the currently loading frame, you 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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

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

This method tests for !=.

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

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

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

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

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

Returns the type identifier of Self.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Upcasts an object to a superclass or interface T. Read more

Upcasts an object to a reference of its superclass or interface T. Read more

Tries to downcast to a subclass or interface implementor T. Read more

Tries to downcast to a reference of its subclass or interface implementor T. Read more

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Casts to T unconditionally. Read more

Casts to &T unconditionally. Read more

Performs the conversion.

Performs the conversion.

Returns true if the object is an instance of (can be cast to) T.

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Same as connect but takes a SignalId instead of a signal name.

Same as connect_local but takes a SignalId instead of a signal name.

Same as connect_unsafe but takes a SignalId instead of a signal name.

Emit signal by signal id.

Emit signal with details by signal id.

Emit signal by it’s name.

Same as emit but takes Value for the arguments.

Same as emit_by_name but takes Value for the arguments.

Same as emit_with_details but takes Value for the arguments.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

Returns a SendValue clone of self.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.