PixbufLoader

Incremental image loader.

gdkpixbuf.pixbuf_loader.PixbufLoader provides a way for applications to drive the process of loading an image, by letting them send the image data directly to the loader instead of having the loader read the data from a file. Applications can use this functionality instead of [gdkpixbuf.pixbuf.Pixbuf.newFromFile] or [gdkpixbuf.pixbuf_animation.PixbufAnimation.newFromFile] when they need to parse image data in small chunks. For example, it should be used when reading an image from a (potentially) slow network connection, or when loading an extremely large file.

To use gdkpixbuf.pixbuf_loader.PixbufLoader to load an image, create a new instance, and call gdkpixbuf.pixbuf_loader.PixbufLoader.write to send the data to it. When done, gdkpixbuf.pixbuf_loader.PixbufLoader.close should be called to end the stream and finalize everything.

The loader will emit three important signals throughout the process:

  • signal@GdkPixbuf.PixbufLoader::size-prepared will be emitted as soon as the image has enough information to determine the size of the image to be used. If you want to scale the image while loading it, you can call gdkpixbuf.pixbuf_loader.PixbufLoader.setSize in response to this signal.
  • signal@GdkPixbuf.PixbufLoader::area-prepared will be emitted as soon as the pixbuf of the desired has been allocated. You can obtain the gdkpixbuf.pixbuf.Pixbuf instance by calling gdkpixbuf.pixbuf_loader.PixbufLoader.getPixbuf. If you want to use it, simply acquire a reference to it. You can also call [gdkpixbuf.pixbuf_loader.PixbufLoader.getPixbuf] later to get the same pixbuf.
  • signal@GdkPixbuf.PixbufLoader::area-updated will be emitted every time a region is updated. This way you can update a partially completed image. Note that you do not know anything about the completeness of an image from the updated area. For example, in an interlaced image you will need to make several passes before the image is done loading.

Loading an animation

Loading an animation is almost as easy as loading an image. Once the first signal@GdkPixbuf.PixbufLoader::area-prepared signal has been emitted, you can call gdkpixbuf.pixbuf_loader.PixbufLoader.getAnimation to get the gdkpixbuf.pixbuf_animation.PixbufAnimation instance, and then call and gdkpixbuf.pixbuf_animation.PixbufAnimation.getIter to get a gdkpixbuf.pixbuf_animation_iter.PixbufAnimationIter to retrieve the pixbuf for the desired time stamp.

Constructors

this
this()

Creates a new pixbuf loader object.

Members

Functions

close
bool close()

Informs a pixbuf loader that no further writes with gdkpixbuf.pixbuf_loader.PixbufLoader.write will occur, so that it can free its internal loading structures.

connectAreaPrepared
ulong connectAreaPrepared(T callback, Flag!"After" after)

Connect to AreaPrepared signal.

connectAreaUpdated
ulong connectAreaUpdated(T callback, Flag!"After" after)

Connect to AreaUpdated signal.

connectClosed
ulong connectClosed(T callback, Flag!"After" after)

Connect to Closed signal.

connectSizePrepared
ulong connectSizePrepared(T callback, Flag!"After" after)

Connect to SizePrepared signal.

getAnimation
gdkpixbuf.pixbuf_animation.PixbufAnimation getAnimation()

Queries the #GdkPixbufAnimation that a pixbuf loader is currently creating.

getFormat
gdkpixbuf.pixbuf_format.PixbufFormat getFormat()

Obtains the available information about the format of the currently loading image file.

getPixbuf
gdkpixbuf.pixbuf.Pixbuf getPixbuf()

Queries the #GdkPixbuf that a pixbuf loader is currently creating.

setSize
void setSize(int width, int height)

Causes the image to be scaled while it is loaded.

write
bool write(ubyte[] buf)

Parses the next count bytes in the given image buffer.

writeBytes
bool writeBytes(glib.bytes.Bytes buffer)

Parses the next contents of the given image buffer.

Static functions

newWithMimeType
gdkpixbuf.pixbuf_loader.PixbufLoader newWithMimeType(string mimeType)

Creates a new pixbuf loader object that always attempts to parse image data as if it were an image of MIME type mime_type, instead of identifying the type automatically.

newWithType
gdkpixbuf.pixbuf_loader.PixbufLoader newWithType(string imageType)

Creates a new pixbuf loader object that always attempts to parse image data as if it were an image of type image_type, instead of identifying the type automatically.

Inherited Members

From ObjectG

setGObject
void setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectG wrapper.

cPtr
void* cPtr(Flag!"Dup" dup)

Get a pointer to the underlying C object.

ref_
void* ref_(void* gObj)

Calls g_object_ref() on a GObject.

unref
unref(void* gObj)

Calls g_object_unref() on a GObject.

getType
GType getType()

Get the GType of an object.

gType
GType gType [@property getter]

GObject GType property.

self
ObjectG self()

Convenience method to return this cast to a type. For use in D with statements.

getDObject
T getDObject(void* cptr, Flag!"Take" take)

Template to get the D object from a C GObject and cast it to the given D object type.

connectSignalClosure
ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after)

Connect a D closure to an object signal.

setProperty
void setProperty(string propertyName, T val)

Template for setting a GObject property.

getProperty
T getProperty(string propertyName)

Template for getting a GObject property.

compatControl
size_t compatControl(size_t what, void* data)
bindProperty
gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags)

Creates a binding between source_property on source and target_property on target.

bindPropertyFull
gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom)

Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

forceFloating
void forceFloating()

This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.

freezeNotify
void freezeNotify()

Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).

getProperty
void getProperty(string propertyName, gobject.value.Value value)

Gets a property of an object.

getQdata
void* getQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.

getv
void getv(string[] names, gobject.value.Value[] values)

Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

isFloating
bool isFloating()

Checks whether object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object.

notifyByPspec
void notifyByPspec(gobject.param_spec.ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

refSink
gobject.object.ObjectG refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setProperty
void setProperty(string propertyName, gobject.value.Value value)

Sets a property on an object.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

thawNotify
void thawNotify()

Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

watchClosure
void watchClosure(gobject.closure.Closure closure)

This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

connectNotify
ulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.