Memory-managed wrapper type.

Type class for types which can be safely cast to PixbufLoader, for instance with toPixbufLoader.

Cast to PixbufLoader, for types for which this is known to be safe. For general casts, use castTo.

A convenience alias for Nothing :: Maybe PixbufLoader.

Informs a pixbuf loader that no further writes with pixbufLoaderWrite will occur, so that it can free its internal loading structures. Also, tries to parse any data that hasn't yet been parsed; if the remaining data is partial or corrupt, an error will be returned. If False is returned, error will be set to an error from the GDK_PIXBUF_ERROR or G_FILE_ERROR domains. If you're just cancelling a load rather than expecting it to be finished, passing Nothing for error to ignore it is reasonable.

Remember that this does not unref the loader, so if you plan not to use it anymore, please objectUnref it.

Queries the PixbufAnimation that a pixbuf loader is currently creating. In general it only makes sense to call this function after the "area-prepared" signal has been emitted by the loader. If the loader doesn't have enough bytes yet (hasn't emitted the "area-prepared" signal) this function will return Nothing.

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

Since: 2.2

Queries the Pixbuf that a pixbuf loader is currently creating. In general it only makes sense to call this function after the "area-prepared" signal has been emitted by the loader; this means that enough data has been read to know the size of the image that will be allocated. If the loader has not received enough data via pixbufLoaderWrite, then this function returns Nothing. The returned pixbuf will be the same in all future calls to the loader, so simply calling objectRef should be sufficient to continue using it. Additionally, if the loader is an animation, it will return the "static image" of the animation (see pixbufAnimationGetStaticImage).

Creates a new pixbuf loader object.

Creates a new pixbuf loader object that always attempts to parse image data as if it were an image of mime type mimeType, instead of identifying the type automatically. Useful if you want an error if the image isn't the expected mime type, for loading image formats that can't be reliably identified by looking at the data, or if the user manually forces a specific mime type.

The list of supported mime types depends on what image loaders are installed, but typically "image/png", "image/jpeg", "image/gif", "image/tiff" and "image/x-xpixmap" are among the supported mime types. To obtain the full list of supported mime types, call pixbufFormatGetMimeTypes on each of the PixbufFormat structs returned by pixbufGetFormats.

Since: 2.4

Creates a new pixbuf loader object that always attempts to parse image data as if it were an image of type imageType, instead of identifying the type automatically. Useful if you want an error if the image isn't the expected type, for loading image formats that can't be reliably identified by looking at the data, or if the user manually forces a specific type.

The list of supported image formats depends on what image loaders are installed, but typically "png", "jpeg", "gif", "tiff" and "xpm" are among the supported formats. To obtain the full list of supported image formats, call pixbufFormatGetName on each of the PixbufFormat structs returned by pixbufGetFormats.

Causes the image to be scaled while it is loaded. The desired image size can be determined relative to the original size of the image by calling pixbufLoaderSetSize from a signal handler for the sizePrepared signal.

Attempts to set the desired image size are ignored after the emission of the sizePrepared signal.

Since: 2.2

This will cause a pixbuf loader to parse the next count bytes of an image. It will return True if the data was loaded successfully, and False if an error occurred. In the latter case, the loader will be closed, and will not accept further writes. If False is returned, error will be set to an error from the GDK_PIXBUF_ERROR or G_FILE_ERROR domains.

This will cause a pixbuf loader to parse a buffer inside a Bytes for an image. It will return True if the data was loaded successfully, and False if an error occurred. In the latter case, the loader will be closed, and will not accept further writes. If False is returned, error will be set to an error from the GDK_PIXBUF_ERROR or G_FILE_ERROR domains.

See also: pixbufLoaderWrite

Since: 2.30

Type for the callback on the (unwrapped) C side.

This signal is emitted when the pixbuf loader has allocated the pixbuf in the desired size. After this signal is emitted, applications can call pixbufLoaderGetPixbuf to fetch the partially-loaded pixbuf.

Connect a signal handler for the areaPrepared signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after pixbufLoader #areaPrepared callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_PixbufLoaderAreaPreparedCallback.

A convenience synonym for Nothing :: Maybe PixbufLoaderAreaPreparedCallback.

Connect a signal handler for the areaPrepared signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on pixbufLoader #areaPrepared callback

Wrap a PixbufLoaderAreaPreparedCallback into a C_PixbufLoaderAreaPreparedCallback.

Type for the callback on the (unwrapped) C side.

This signal is emitted when a significant area of the image being loaded has been updated. Normally it means that a complete scanline has been read in, but it could be a different area as well. Applications can use this signal to know when to repaint areas of an image that is being loaded.

Connect a signal handler for the areaUpdated signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after pixbufLoader #areaUpdated callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_PixbufLoaderAreaUpdatedCallback.

A convenience synonym for Nothing :: Maybe PixbufLoaderAreaUpdatedCallback.

Connect a signal handler for the areaUpdated signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on pixbufLoader #areaUpdated callback

Wrap a PixbufLoaderAreaUpdatedCallback into a C_PixbufLoaderAreaUpdatedCallback.

Type for the callback on the (unwrapped) C side.

This signal is emitted when pixbufLoaderClose is called. It can be used by different parts of an application to receive notification when an image loader is closed by the code that drives it.

Connect a signal handler for the closed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after pixbufLoader #closed callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_PixbufLoaderClosedCallback.

A convenience synonym for Nothing :: Maybe PixbufLoaderClosedCallback.

Connect a signal handler for the closed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on pixbufLoader #closed callback

Wrap a PixbufLoaderClosedCallback into a C_PixbufLoaderClosedCallback.

Type for the callback on the (unwrapped) C side.

This signal is emitted when the pixbuf loader has been fed the initial amount of data that is required to figure out the size of the image that it will create. Applications can call pixbufLoaderSetSize in response to this signal to set the desired size to which the image should be scaled.

Connect a signal handler for the sizePrepared signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after pixbufLoader #sizePrepared callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_PixbufLoaderSizePreparedCallback.

A convenience synonym for Nothing :: Maybe PixbufLoaderSizePreparedCallback.

Connect a signal handler for the sizePrepared signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on pixbufLoader #sizePrepared callback

Wrap a PixbufLoaderSizePreparedCallback into a C_PixbufLoaderSizePreparedCallback.