Google

logo top
Main Page   Widgets   Namespaces   Book  

Gdk::PixbufAnimation Class Reference

Inheritance diagram for Gdk::PixbufAnimation:

Inheritance graph
[legend]
List of all members.

Public Methods

virtual ~PixbufAnimation ()
GdkPixbufAnimation* gobj ()
const GdkPixbufAnimation* gobj () const
GdkPixbufAnimation* gobj_copy ()
int get_width () const
 Queries the width of the bounding box of a pixbuf animation.

int get_height () const
 Queries the height of the bounding box of a pixbuf animation.

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.

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

Glib::RefPtr<PixbufAnimationIterget_iter (const GTimeVal* start_time)
 Get an iterator for displaying an animation.


Static Public Methods

Glib::RefPtr<PixbufAnimation> create_from_file (const Glib::ustring& filename)

Related Functions

(Note that these are not member functions.)

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

Constructor & Destructor Documentation

virtual Gdk::PixbufAnimation::~PixbufAnimation (   [virtual]
 


Member Function Documentation

Glib::RefPtr<PixbufAnimation> Gdk::PixbufAnimation::create_from_file ( const Glib::ustring   filename [static]
 

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 ( const GTimeVal   start_time
 

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 Glib::object_unref().

start_time would normally come from Glib::get_current_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::timeout_add()) 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, if start_time is 0, the result of Glib::get_current_time() will be used automatically.

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 0.

Returns:
Unanimated image representing the animation.

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.

const GdkPixbufAnimation* Gdk::PixbufAnimation::gobj (   const [inline]
 

Reimplemented from Glib::ObjectBase.

GdkPixbufAnimation* Gdk::PixbufAnimation::gobj (   [inline]
 

Reimplemented from Glib::ObjectBase.

GdkPixbufAnimation* Gdk::PixbufAnimation::gobj_copy (  
 

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.


Friends And Related Function Documentation

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


The documentation for this class was generated from the following file:
Generated for gtkmm by Doxygen 1.3-rc1 © 1997-2001