Struct gdk_pixbuf::PixbufAnimation

#[repr(transparent)]
pub struct PixbufAnimation { /* private fields */ }

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 Pixbuf what should be displayed at a given point in time.

Implements

PixbufAnimationExt, PixbufAnimationExtManual

Implementations

impl PixbufAnimation

pub const NONE: Option<&'static PixbufAnimation> = None

pub fn from_file(filename: impl AsRef<Path>) -> Result<PixbufAnimation, Error>

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.

filename

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

Returns

A newly-created animation

pub fn from_resource(resource_path: &str) -> Result<PixbufAnimation, Error>

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.

resource_path

the path of the resource file

Returns

A newly-created animation

pub fn from_stream( stream: &impl IsA<InputStream>, cancellable: Option<&impl IsA<Cancellable>> ) -> Result<PixbufAnimation, Error>

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.

stream

a GInputStream to load the pixbuf from

cancellable

optional GCancellable object

Returns

A newly-created animation

pub fn from_stream_async<P: FnOnce(Result<PixbufAnimation, Error>) + 'static>( stream: &impl IsA<InputStream>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

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

For more details see gdk_pixbuf_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 gdk_pixbuf_animation_new_from_stream_finish() to get the result of the operation.

stream

a #GInputStream from which to load the animation

cancellable

optional #GCancellable object

callback

a GAsyncReadyCallback to call when the pixbuf is loaded

pub fn from_stream_future( stream: &impl IsA<InputStream> + Clone + 'static ) -> Pin<Box_<dyn Future<Output = Result<PixbufAnimation, Error>> + 'static>>

Trait Implementations

impl Clone for PixbufAnimation

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 PixbufAnimation

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

Formats the value using the given formatter.

impl Display for PixbufAnimation

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

Formats the value using the given formatter.

impl Hash for PixbufAnimation

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 Ord for PixbufAnimation

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for PixbufAnimation

type Parent = Object

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

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 PixbufAnimation

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 PixbufAnimation

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PixbufAnimation

impl IsA<PixbufAnimation> for PixbufNonAnim

impl IsA<PixbufAnimation> for PixbufSimpleAnim