Trait gdk_pixbuf::prelude::PixbufAnimationExtManual[−][src]

pub trait PixbufAnimationExtManual {
    fn iter(&self, start_time: Option<SystemTime>) -> PixbufAnimationIter;
}

Required methods

Get an iterator for displaying an animation. The iterator provides the frames that should be displayed at a given time. It should be freed after use with g_object_unref().

start_time would normally come from g_get_current_time(), and marks the beginning of animation playback. After creating an iterator, you should immediately display the pixbuf returned by [PixbufAnimationIterExtManual::pixbuf()][crate::prelude::PixbufAnimationIterExtManual::pixbuf()]. Then, you should install a timeout (with g_timeout_add()) or by some other mechanism ensure that you’ll update the image after [PixbufAnimationIterExtManual::delay_time()][crate::prelude::PixbufAnimationIterExtManual::delay_time()] milliseconds. Each time the image is updated, you should reinstall the timeout with the new, possibly-changed delay time.

As a shortcut, if start_time is None, the result of g_get_current_time() will be used automatically.

To update the image (i.e. possibly change the result of [PixbufAnimationIterExtManual::pixbuf()][crate::prelude::PixbufAnimationIterExtManual::pixbuf()] to a new frame of the animation), call [PixbufAnimationIterExtManual::advance()][crate::prelude::PixbufAnimationIterExtManual::advance()].

If you’re using PixbufLoader, in addition to updating the image after the delay time, you should also update it whenever you receive the area_updated signal and [PixbufAnimationIterExtManual::on_currently_loading_frame()][crate::prelude::PixbufAnimationIterExtManual::on_currently_loading_frame()] returns true. In this case, the frame currently being fed into the loader has received new data, so needs to be refreshed. The delay time for a frame may also be modified after an area_updated signal, for example if the delay time for a frame is encoded in the data after the frame itself. So your timeout should be reinstalled after any area_updated signal.

A delay time of -1 is possible, indicating “infinite.”

start_time

time when the animation starts playing

Returns

an iterator to move over the animation

Implementors