The gdk-pixbuf library provides a simple mechanism to load and represent animations. More...

#include <gdkmm/pixbufanimation.h>

Inheritance diagram for Gdk::PixbufAnimation:

Public Member Functions
	PixbufAnimation (PixbufAnimation&& src) noexcept
PixbufAnimation&	operator= (PixbufAnimation&& src) noexcept
	~PixbufAnimation () noexcept override
GdkPixbufAnimation*	gobj ()
	Provides access to the underlying C GObject. More...
const GdkPixbufAnimation*	gobj () const
	Provides access to the underlying C GObject. More...
GdkPixbufAnimation*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
int	get_width () const
	Queries the width of the bounding box of a pixbuf animation. More...
int	get_height () const
	Queries the height of the bounding box of a pixbuf animation. More...
bool	is_static_image () const
	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. More...
Glib::RefPtr< Pixbuf >	get_static_image ()
	If an animation is really just a plain image (has only one frame), this function returns that image. More...
Glib::RefPtr< PixbufAnimationIter >	get_iter (gint64 start_time=g_get_real_time())
	Get an iterator for displaying an animation. More...
Public Member Functions inherited from Glib::Object
	Object (const Object &)=delete
Object &	operator= (const Object &)=delete
	Object (Object &&src) noexcept
Object &	operator= (Object &&src) noexcept
void *	get_data (const QueryQuark &key)
void	set_data (const Quark &key, void *data)
void	set_data (const Quark &key, void *data, DestroyNotify notify)
void	remove_data (const QueryQuark &quark)
void *	steal_data (const QueryQuark &quark)
Glib::RefPtr< Glib::Object >	wrap (GObject *object, bool take_copy=false)
Public Member Functions inherited from Glib::ObjectBase
	ObjectBase (const ObjectBase &)=delete
ObjectBase &	operator= (const ObjectBase &)=delete
void	set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
void	get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
void	set_property (const Glib::ustring &property_name, const PropertyType &value)
void	get_property (const Glib::ustring &property_name, PropertyType &value) const
PropertyType	get_property (const Glib::ustring &property_name) const
sigc::connection	connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot)
sigc::connection	connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot)
void	freeze_notify ()
void	thaw_notify ()
virtual void	reference () const
virtual void	unreference () const
GObject *	gobj ()
const GObject *	gobj () const
GObject *	gobj_copy () const
Public Member Functions inherited from sigc::trackable
	trackable () noexcept
	trackable (const trackable &src) noexcept
	trackable (trackable &&src) noexcept
	~trackable ()
void	add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const
void	notify_callbacks ()
trackable &	operator= (const trackable &src)
trackable &	operator= (trackable &&src) noexcept
void	remove_destroy_notify_callback (notifiable *data) const

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...
static Glib::RefPtr< PixbufAnimation >	create_from_file (const std::string& filename)
	Creates a new animation by loading it from a file. More...

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gdk::PixbufAnimation >	wrap (GdkPixbufAnimation* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Additional Inherited Members
Public Types inherited from Glib::Object
typedef void(*)(gpointer data	DestroyNotify)
Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify	func_destroy_notify
Public Types inherited from sigc::notifiable
typedef internal::func_destroy_notify	func_destroy_notify
Protected Member Functions inherited from Glib::Object
	Object ()
	Object (const Glib::ConstructParams &construct_params)
	Object (GObject *castitem)
	~Object () noexcept override
Protected Member Functions inherited from Glib::ObjectBase
	ObjectBase ()
	ObjectBase (const char *custom_type_name)
	ObjectBase (const std::type_info &custom_type_info)
	ObjectBase (ObjectBase &&src) noexcept
ObjectBase &	operator= (ObjectBase &&src) noexcept
virtual	~ObjectBase () noexcept=0
void	initialize (GObject *castitem)
void	initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)

Detailed Description

The gdk-pixbuf library provides a simple mechanism to load and represent animations.

An animation is conceptually a series of frames to be displayed over time. Each frame is the same size. 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 gdk-pixbuf what should be displayed at a given point in time.

Constructor & Destructor Documentation

Gdk::PixbufAnimation::PixbufAnimation ( PixbufAnimation&&  src )

noexcept

Gdk::PixbufAnimation::~PixbufAnimation ( )

overridenoexcept

Member Function Documentation

static Glib::RefPtr<PixbufAnimation> Gdk::PixbufAnimation::create_from_file ( const std::string &  filename )

static

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.

Returns

A newly-created animation with a reference count of 1, or nullptr if any of several error conditions ocurred: the file could not be opened, there was no loader for the file's format, there was not enough memory to allocate the image buffer, or the image file contained invalid data.

Exceptions

Glib::Error

int Gdk::PixbufAnimation::get_height

(

)

const

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

Returns

Height of the bounding box of the animation.

Glib::RefPtr<PixbufAnimationIter> Gdk::PixbufAnimation::get_iter

(

gint64

start_time = g_get_real_time()

)

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 g_get_real_time(), and marks the beginning of animation playback. After creating an iterator, you should immediately display the pixbuf returned by Gdk::PixbufAnimationIter::get_pixbuf(). Then, you should install a timeout (with Glib::signal_timeout().connect()) or by some other mechanism ensure that you'll update the image after Gdk::PixbufAnimationIter::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, the default value of start_time is g_get_real_time().

To update the image (i.e. possibly change the result of Gdk::PixbufAnimationIter::get_pixbuf() to a new frame of the animation), call Gdk::PixbufAnimationIter::advance().

If you're using Gdk::PixbufLoader, in addition to updating the image after the delay time, you should also update it whenever you receive the area_updated signal and Gdk::PixbufAnimationIter::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.

Returns

An iterator to move over the animation.

Glib::RefPtr<Pixbuf> Gdk::PixbufAnimation::get_static_image

(

)

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 thing to display as a static unanimated image, which might be the first frame, or something more sophisticated. If an animation hasn't loaded any frames yet, this function will return nullptr.

Returns

Unanimated image representing the animation.

static GType Gdk::PixbufAnimation::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

int Gdk::PixbufAnimation::get_width

(

)

const

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

Returns

Width of the bounding box of the animation.

GdkPixbufAnimation* Gdk::PixbufAnimation::gobj ( )

inline

Provides access to the underlying C GObject.

const GdkPixbufAnimation* Gdk::PixbufAnimation::gobj ( ) const

inline

Provides access to the underlying C GObject.

GdkPixbufAnimation* Gdk::PixbufAnimation::gobj_copy

(

)

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

bool Gdk::PixbufAnimation::is_static_image

(

)

const

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.

Returns

true if the "animation" was really just an image.

PixbufAnimation& Gdk::PixbufAnimation::operator= ( PixbufAnimation&&  src )

noexcept

Friends And Related Function Documentation

Glib::RefPtr< Gdk::PixbufAnimation > wrap ( GdkPixbufAnimation *  object, bool  take_copy = false  )

related

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns

A C++ instance that wraps this C instance.