gdkpixbuf.pixbuf_loader

class PixbufLoader PixbufLoaderGidBuilder PixbufLoaderGidBuilderImpl

Types 3

classPixbufLoader : gobject.object.ObjectWrap

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:

gdkpixbuf.pixbuf_loader.PixbufLoader.sizePrepared 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.
gdkpixbuf.pixbuf_loader.PixbufLoader.areaPrepared 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.
gdkpixbuf.pixbuf_loader.PixbufLoader.areaUpdated 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 gdkpixbuf.pixbuf_loader.PixbufLoader.areaPrepared 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.

Methods

GType _getGType()

GType _gType() @property

PixbufLoader self()Returns `this`, for use in `with` statements.

PixbufLoaderGidBuilder builder()Get builder for [gdkpixbuf.pixbuf_loader.PixbufLoader] Returns: New builder object

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.

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.

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.

gdkpixbuf.pixbuf_animation.PixbufAnimation getAnimation()Queries the #GdkPixbufAnimation that a pixbuf loader is currently creating.

gdkpixbuf.pixbuf_format.PixbufFormat getFormat()Obtains the available information about the format of the currently loading image file. Returns: A #GdkPixbufFormat

gdkpixbuf.pixbuf.Pixbuf getPixbuf()Queries the #GdkPixbuf that a pixbuf loader is currently creating.

void setSize(int width, int height)Causes the image to be scaled while it is loaded.

bool write(ubyte[] buf)Parses the next `count` bytes in the given image buffer.

bool writeBytes(glib.bytes.Bytes buffer)Parses the next contents of the given image buffer.

gulong connectAreaPrepared(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gdkpixbuf.pixbuf_loader.PixbufLoader)))
   &&  Parameters!T.length <  2)

Connect to `AreaPrepared` signal.

gulong connectAreaUpdated(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  int)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  int)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2]  ==  int)))
   && (Parameters!T.length <  4 || (ParameterStorageClassTuple!T[3]  ==  ParameterStorageClass.none &&  is(Parameters!T[3]  ==  int)))
   && (Parameters!T.length <  5 || (ParameterStorageClassTuple!T[4]  ==  ParameterStorageClass.none &&  is(Parameters!T[4] :  gdkpixbuf.pixbuf_loader.PixbufLoader)))
   &&  Parameters!T.length <  6)

Connect to `AreaUpdated` signal.

gulong connectClosed(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gdkpixbuf.pixbuf_loader.PixbufLoader)))
   &&  Parameters!T.length <  2)

Connect to `Closed` signal.

gulong connectSizePrepared(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  int)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  int)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  gdkpixbuf.pixbuf_loader.PixbufLoader)))
   &&  Parameters!T.length <  4)

Connect to `SizePrepared` signal.

Constructors

this(void * ptr, Flag!"Take" take)

this()Creates a new pixbuf loader object. Returns: A newly-created pixbuf loader.

classPixbufLoaderGidBuilderImpl(T) : gobject.object.ObjectWrapGidBuilderImpl!T

Fluent builder implementation template for gdkpixbuf.pixbuf_loader.PixbufLoader

classPixbufLoaderGidBuilder : PixbufLoaderGidBuilderImpl!PixbufLoaderGidBuilder

Fluent builder for gdkpixbuf.pixbuf_loader.PixbufLoader

Methods

PixbufLoader build()Create object from builder. Returns: New object