Package org.gnome.gdkpixbuf

Class PixbufAnimation

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gdkpixbuf.PixbufAnimation

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

PixbufNonAnim, PixbufSimpleAnim

@Generated("io.github.jwharm.JavaGI")
public class PixbufAnimation
extends GObject

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PixbufAnimation.Builder<B extends PixbufAnimation.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	PixbufAnimation.PixbufAnimationClass	Modules supporting animations must derive a type from GdkPixbufAnimation, providing suitable implementations of the virtual functions.

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
PixbufAnimation(MemorySegment address)	Create a PixbufAnimation proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected PixbufAnimation	asParent()	Returns this instance as if it were its parent type.
static PixbufAnimation.Builder<? extends PixbufAnimation.Builder>	builder()	A PixbufAnimation.Builder object constructs a PixbufAnimation with the specified properties.
static PixbufAnimation	fromFile(String filename)	Creates a new animation by loading it from a file.
static PixbufAnimation	fromFileUtf8(String filename)	Same as gdk_pixbuf_animation_new_from_file()
static PixbufAnimation	fromResource(String resourcePath)	Creates a new pixbuf animation by loading an image from an resource.
static PixbufAnimation	fromStream(InputStream stream, @Nullable Cancellable cancellable)	Creates a new animation by loading it from an input stream.
static PixbufAnimation	fromStreamFinish(AsyncResult asyncResult)	Finishes an asynchronous pixbuf animation creation operation started with newFromStreamAsync(org.gnome.gio.InputStream, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback).
int	getHeight()	Queries the height of the bounding box of a pixbuf animation.
PixbufAnimationIter	getIter(@Nullable TimeVal startTime)	Get an iterator for displaying an animation.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
protected void	getSize(MemorySegment width, MemorySegment height)	fills width and height with the frame size of the animation.
Pixbuf	getStaticImage()	Retrieves a static image for the animation.
static Type	getType()	Get the GType of the PixbufAnimation class
int	getWidth()	Queries the width of the bounding box of a pixbuf animation.
boolean	isStaticImage()	Checks whether the animation is a static image.
static void	newFromStreamAsync(InputStream stream, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Creates a new animation by asynchronously loading an image from an input stream.
PixbufAnimation	ref()	Deprecated. Use g_object_ref().
void	unref()	Deprecated. Use g_object_unref().

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newInstance, newInstance, newv, notify_, notify_, notifyByPspec, onNotify, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PixbufAnimation

public PixbufAnimation(MemorySegment address)

Create a PixbufAnimation proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the PixbufAnimation class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected PixbufAnimation asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

fromFile

public static PixbufAnimation fromFile(String filename)
                                throws GErrorException

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

Throws:

GErrorException - see GError

fromResource

public static PixbufAnimation fromResource(String resourcePath)
                                    throws GErrorException

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.

Parameters:

resourcePath - the path of the resource file

Returns:

A newly-created animation

Throws:

GErrorException - see GError

fromStream

public static PixbufAnimation fromStream(InputStream stream,
 @Nullable
 @Nullable Cancellable cancellable)
                                  throws GErrorException

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.

Parameters:

stream - a GInputStream to load the pixbuf from

cancellable - optional GCancellable object

Returns:

A newly-created animation

Throws:

GErrorException - see GError

fromStreamFinish

public static PixbufAnimation fromStreamFinish(AsyncResult asyncResult)
                                        throws GErrorException

Finishes an asynchronous pixbuf animation creation operation started with newFromStreamAsync(org.gnome.gio.InputStream, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback).

Parameters:

asyncResult - a GAsyncResult

Returns:

the newly created animation

Throws:

GErrorException - see GError

fromFileUtf8

public static PixbufAnimation fromFileUtf8(String filename)
                                    throws GErrorException

Same as gdk_pixbuf_animation_new_from_file()

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

Throws:

GErrorException - see GError

newFromStreamAsync

public static void newFromStreamAsync(InputStream stream,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

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.

Parameters:

stream - a GInputStream from which to load the animation

cancellable - optional GCancellable object

callback - a GAsyncReadyCallback to call when the pixbuf is loaded

getHeight

public int getHeight()

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

Returns:

Height of the bounding box of the animation.

getIter

public PixbufAnimationIter getIter(@Nullable
 @Nullable TimeVal startTime)

Get an iterator for displaying an animation.

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

startTime 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 gdk_pixbuf_animation_iter_get_pixbuf(). Then, you should install a timeout (with g_timeout_add()) or by some other mechanism ensure that you'll update the image after gdk_pixbuf_animation_iter_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 startTime is NULL, the result of g_get_current_time() will be used automatically.

To update the image (i.e. possibly change the result of gdk_pixbuf_animation_iter_get_pixbuf() to a new frame of the animation), call gdk_pixbuf_animation_iter_advance().

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

startTime - time when the animation starts playing

Returns:

an iterator to move over the animation

getStaticImage

public Pixbuf getStaticImage()

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.

Returns:

unanimated image representing the animation

getWidth

public int getWidth()

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

Returns:

Width of the bounding box of the animation.

isStaticImage

public boolean isStaticImage()

Checks whether the animation is a static image.

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

Returns:

TRUE if the "animation" was really just an image

ref

@Deprecated
public PixbufAnimation ref()

Deprecated.

Use g_object_ref().

Adds a reference to an animation.

Overrides:

ref in class GObject

Returns:

The same as the this PixbufAnimation argument.

unref

@Deprecated
public void unref()

Deprecated.

Use g_object_unref().

Removes a reference from an animation.

Overrides:

unref in class GObject

getSize

protected void getSize(MemorySegment width,
 MemorySegment height)

fills width and height with the frame size of the animation.

builder

public static PixbufAnimation.Builder<? extends PixbufAnimation.Builder> builder()

A PixbufAnimation.Builder object constructs a PixbufAnimation with the specified properties. Use the various set...() methods to set properties, and finish construction with PixbufAnimation.Builder.build().