PixbufAnimation

class PixbufAnimation(**properties: Any)

Superclasses: Object

Subclasses: PixbufNonAnim, PixbufSimpleAnim

An opaque object representing an animation.

The GdkPixBuf library provides a simple mechanism to load and represent animations. An animation is conceptually a series of frames to be displayed over time.

The animation may not be represented as a series of frames internally; for example, it may be stored as a sprite and instructions for moving the sprite around a background.

To display an animation you don’t need to understand its representation, however; you just ask GdkPixbuf what should be displayed at a given point in time.

Constructors

class PixbufAnimation

classmethod new_from_file(filename: str) → PixbufAnimation | None

Creates a new animation by loading it from a file.

The file format is detected automatically.

If the file’s format does not support multi-frame images, then an animation with a single frame will be created.

Possible errors are in the GDK_PIXBUF_ERROR and G_FILE_ERROR domains.

Parameters:

filename – Name of file to load, in the GLib file name encoding

classmethod new_from_resource(resource_path: str) → PixbufAnimation | None

Creates a new pixbuf animation by loading an image from an resource.

The file format is detected automatically. If NULL is returned, then error will be set.

Added in version 2.28.

Parameters:

resource_path – the path of the resource file

classmethod new_from_stream(stream: InputStream, cancellable: Cancellable | None = None) → PixbufAnimation | None

Creates a new animation by loading it from an input stream.

The file format is detected automatically.

If NULL is returned, then error will be set.

The cancellable can be used to abort the operation from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned. Other possible errors are in the GDK_PIXBUF_ERROR and G_IO_ERROR domains.

The stream is not closed.

Added in version 2.28.

Parameters:

• stream – a GInputStream to load the pixbuf from

• cancellable – optional GCancellable object

classmethod new_from_stream_finish(async_result: AsyncResult) → PixbufAnimation | None

Finishes an asynchronous pixbuf animation creation operation started with new_from_stream_async.

Added in version 2.28.

Parameters:

async_result – a AsyncResult

Methods

class PixbufAnimation

get_height() → int

Queries the height of the bounding box of a pixbuf animation.

get_iter(start_time: TimeVal | None = None) → PixbufAnimationIter

Get an iterator for displaying an animation.

The iterator provides the frames that should be displayed at a given time.

start_time would normally come from get_current_time(), and marks the beginning of animation playback. After creating an iterator, you should immediately display the pixbuf returned by get_pixbuf(). Then, you should install a timeout (with timeout_add()) or by some other mechanism ensure that you’ll update the image after get_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 NULL, the result of get_current_time() will be used automatically.

To update the image (i.e. possibly change the result of get_pixbuf() to a new frame of the animation), call 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 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”.

Parameters:

start_time – time when the animation starts playing

get_static_image() → Pixbuf

Retrieves a static image for the animation.

If an animation is really just a plain image (has only one frame), this function returns that image.

If the animation is an animation, this function returns a reasonable image to use as a static unanimated image, which might be the first frame, or something more sophisticated depending on the file format.

If an animation hasn’t loaded any frames yet, this function will return NULL.

get_width() → int

Queries the width of the bounding box of a pixbuf animation.

is_static_image() → bool

Checks whether the animation is a static image.

If you load a file with new_from_file() and it turns out to be a plain, unanimated image, then this function will return TRUE. Use get_static_image() to retrieve the image.

new_from_stream_async(stream: InputStream, cancellable: Cancellable | None = None, callback: Callable[[...], None] | None = None, *user_data: Any) → None

Creates a new animation by asynchronously loading an image from an input stream.

For more details see new_from_stream(), which is the synchronous version of this function.

When the operation is finished, callback will be called in the main thread. You can then call new_from_stream_finish() to get the result of the operation.

Added in version 2.28.

Parameters:

• stream – a InputStream from which to load the animation

• cancellable – optional Cancellable object

• callback – a GAsyncReadyCallback to call when the pixbuf is loaded

• user_data – the data to pass to the callback function

Virtual Methods

class PixbufAnimation

do_get_iter(start_time: TimeVal | None = None) → PixbufAnimationIter

Get an iterator for displaying an animation.

The iterator provides the frames that should be displayed at a given time.

start_time would normally come from get_current_time(), and marks the beginning of animation playback. After creating an iterator, you should immediately display the pixbuf returned by get_pixbuf(). Then, you should install a timeout (with timeout_add()) or by some other mechanism ensure that you’ll update the image after get_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 NULL, the result of get_current_time() will be used automatically.

To update the image (i.e. possibly change the result of get_pixbuf() to a new frame of the animation), call 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 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”.

Parameters:

start_time – time when the animation starts playing

do_get_size(width: int, height: int) → None

Parameters:

• width

• height

do_get_static_image() → Pixbuf

Retrieves a static image for the animation.

If an animation is really just a plain image (has only one frame), this function returns that image.

If the animation is an animation, this function returns a reasonable image to use as a static unanimated image, which might be the first frame, or something more sophisticated depending on the file format.

If an animation hasn’t loaded any frames yet, this function will return NULL.

do_is_static_image() → bool

Checks whether the animation is a static image.

If you load a file with new_from_file() and it turns out to be a plain, unanimated image, then this function will return TRUE. Use get_static_image() to retrieve the image.

Fields

class PixbufAnimation

parent_instance