Memory-managed wrapper type.

Type class for types which can be safely cast to Pixbuf, for instance with toPixbuf.

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

A convenience alias for Nothing :: Maybe Pixbuf.

Takes an existing pixbuf and adds an alpha channel to it. If the existing pixbuf already had an alpha channel, the channel values are copied from the original; otherwise, the alpha channel is initialized to 255 (full opacity).

If substituteColor is True, then the color specified by (r, g, b) will be assigned zero opacity. That is, if you pass (255, 255, 255) for the substitute color, all white pixels will become fully transparent.

Takes an existing pixbuf and checks for the presence of an associated "orientation" option, which may be provided by the jpeg loader (which reads the exif orientation tag) or the tiff loader (which reads the tiff orientation tag, and compensates it for the partial transforms performed by libtiff). If an orientation option/tag is present, the appropriate transform will be performed so that the pixbuf is oriented correctly.

Since: 2.12

Calculates the rowstride that an image created with those values would have. This is useful for front-ends and backends that want to sanity check image values without needing to create them.

Since: 2.36.8

Creates a transformation of the source image src by scaling by scaleX and scaleY then translating by offsetX and offsetY. This gives an image in the coordinates of the destination pixbuf. The rectangle (destX, destY, destWidth, destHeight) is then alpha blended onto the corresponding rectangle of the original destination image.

When the destination rectangle contains parts not in the source image, the data at the edges of the source image is replicated to infinity.

Creates a transformation of the source image src by scaling by scaleX and scaleY then translating by offsetX and offsetY, then alpha blends the rectangle (destX ,destY, destWidth, destHeight) of the resulting image with a checkboard of the colors color1 and color2 and renders it onto the destination image.

If the source image has no alpha channel, and overallAlpha is 255, a fast path is used which omits the alpha blending and just performs the scaling.

See pixbufCompositeColorSimple for a simpler variant of this function suitable for many tasks.

Creates a new Pixbuf by scaling src to destWidth x destHeight and alpha blending the result with a checkboard of colors color1 and color2.

Creates a new Pixbuf with a copy of the information in the specified pixbuf. Note that this does not copy the options set on the original Pixbuf, use pixbufCopyOptions for this.

Copies a rectangular area from srcPixbuf to destPixbuf. Conversion of pixbuf formats is done automatically.

If the source rectangle overlaps the destination rectangle on the same pixbuf, it will be overwritten during the copy operation. Therefore, you can not use this function to scroll a pixbuf.

Copy the key/value pair options attached to a Pixbuf to another. This is useful to keep original metadata after having manipulated a file. However be careful to remove metadata which you've already applied, such as the "orientation" option after rotating the image.

Since: 2.36

Clears a pixbuf to the given RGBA value, converting the RGBA value into the pixbuf's pixel format. The alpha will be ignored if the pixbuf doesn't have an alpha channel.

Flips a pixbuf horizontally or vertically and returns the result in a new pixbuf.

Since: 2.6

Converts a Pixdata to a Pixbuf. If copyPixels is True or if the pixel data is run-length-encoded, the pixel data is copied into newly-allocated memory; otherwise it is reused.

Queries the number of bits per color sample in a pixbuf.

Returns the length of the pixel data, in bytes.

Since: 2.26

Queries the color space of a pixbuf.

Parses an image file far enough to determine its format and size.

Since: 2.4

Asynchronously parses an image file far enough to determine its format and size.

For more details see pixbufGetFileInfo, 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 pixbufGetFileInfoFinish to get the result of the operation.

Since: 2.32

Finishes an asynchronous pixbuf parsing operation started with pixbufGetFileInfoAsync.

Since: 2.32

Obtains the available information about the image formats supported by GdkPixbuf.

Since: 2.2

Queries whether a pixbuf has an alpha channel (opacity information).

Queries the height of a pixbuf.

Queries the number of channels of a pixbuf.

Looks up key in the list of options that may have been attached to the pixbuf when it was loaded, or that may have been attached by another function using pixbufSetOption.

For instance, the ANI loader provides "Title" and "Artist" options. The ICO, XBM, and XPM loaders provide "x_hot" and "y_hot" hot-spot options for cursor definitions. The PNG loader provides the tEXt ancillary chunk key/value pairs as options. Since 2.12, the TIFF and JPEG loaders return an "orientation" option string that corresponds to the embedded TIFF/Exif orientation tag (if present). Since 2.32, the TIFF loader sets the "multipage" option string to "yes" when a multi-page TIFF is loaded. Since 2.32 the JPEG and PNG loaders set "x-dpi" and "y-dpi" if the file contains image density information in dots per inch. Since 2.36.6, the JPEG loader sets the "comment" option with the comment EXIF tag.

Queries a pointer to the pixel data of a pixbuf.

Since: 2.26

Queries the rowstride of a pixbuf, which is the number of bytes between the start of a row and the start of the next row.

Queries the width of a pixbuf.

Creates a new Pixbuf structure and allocates a buffer for it. The buffer has an optimal rowstride. Note that the buffer is not cleared; you will have to fill it completely yourself.

Creates a new Pixbuf out of in-memory readonly image data. Currently only RGB images with 8 bits per sample are supported. This is the Bytes variant of pixbufNewFromData.

Since: 2.32

Creates a new Pixbuf out of in-memory image data. Currently only RGB images with 8 bits per sample are supported.

Since you are providing a pre-allocated pixel buffer, you must also specify a way to free that data. This is done with a function of type PixbufDestroyNotify. When a pixbuf created with is finalized, your destroy notification function will be called, and it is its responsibility to free the pixel array.

See also pixbufNewFromBytes.

Creates a new pixbuf by loading an image from a file. The file format is detected automatically. If Nothing is returned, then error will be set. Possible errors are in the GDK_PIXBUF_ERROR and G_FILE_ERROR domains.

Creates a new pixbuf by loading an image from a file. The file format is detected automatically. If Nothing is returned, then error will be set. Possible errors are in the GDK_PIXBUF_ERROR and G_FILE_ERROR domains. The image will be scaled to fit in the requested size, optionally preserving the image's aspect ratio.

When preserving the aspect ratio, a width of -1 will cause the image to be scaled to the exact given height, and a height of -1 will cause the image to be scaled to the exact given width. When not preserving aspect ratio, a width or height of -1 means to not scale the image at all in that dimension. Negative values for width and height are allowed since 2.8.

Since: 2.6

Creates a new pixbuf by loading an image from a file. The file format is detected automatically. If Nothing is returned, then error will be set. Possible errors are in the GDK_PIXBUF_ERROR and G_FILE_ERROR domains.

The image will be scaled to fit in the requested size, preserving the image's aspect ratio. Note that the returned pixbuf may be smaller than width x height, if the aspect ratio requires it. To load and image at the requested size, regardless of aspect ratio, use pixbufNewFromFileAtScale.

Since: 2.4

Create a Pixbuf from a flat representation that is suitable for storing as inline data in a program. This is useful if you want to ship a program with images, but don't want to depend on any external files.

gdk-pixbuf ships with a program called [gdk-pixbuf-csource][gdk-pixbuf-csource], which allows for conversion of GdkPixbufs into such a inline representation. In almost all cases, you should pass the --raw option to gdk-pixbuf-csource. A sample invocation would be:

gdk-pixbuf-csource --raw --name=myimage_inline myimage.png

For the typical case where the inline pixbuf is read-only static data, you don't need to copy the pixel data unless you intend to write to it, so you can pass False for copyPixels. (If you pass --rle to gdk-pixbuf-csource, a copy will be made even if copyPixels is False, so using this option is generally a bad idea.)

If you create a pixbuf from const inline data compiled into your program, it's probably safe to ignore errors and disable length checks, since things will always succeed: > >pixbuf = gdk_pixbuf_new_from_inline (-1, myimage_inline, FALSE, NULL);

For non-const inline data, you could get out of memory. For untrusted inline data located at runtime, you could have corrupt inline data in addition.

Creates a new pixbuf by loading an image from an resource.

The file format is detected automatically. If Nothing is returned, then error will be set.

Since: 2.26

Creates a new pixbuf by loading an image from an resource.

The file format is detected automatically. If Nothing is returned, then error will be set.

The image will be scaled to fit in the requested size, optionally preserving the image's aspect ratio. When preserving the aspect ratio, a width of -1 will cause the image to be scaled to the exact given height, and a height of -1 will cause the image to be scaled to the exact given width. When not preserving aspect ratio, a width or height of -1 means to not scale the image at all in that dimension.

The stream is not closed.

Since: 2.26

Creates a new pixbuf by loading an image from an input stream.

The file format is detected automatically. If Nothing 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 IOErrorEnumCancelled will be returned. Other possible errors are in the GDK_PIXBUF_ERROR and G_IO_ERROR domains.

The stream is not closed.

Since: 2.14

Creates a new pixbuf by asynchronously loading an image from an input stream.

For more details see pixbufNewFromStream, 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 pixbufNewFromStreamFinish to get the result of the operation.

Since: 2.24

Creates a new pixbuf by loading an image from an input stream.

The file format is detected automatically. If Nothing 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 IOErrorEnumCancelled will be returned. Other possible errors are in the GDK_PIXBUF_ERROR and G_IO_ERROR domains.

The image will be scaled to fit in the requested size, optionally preserving the image's aspect ratio.

When preserving the aspect ratio, a width of -1 will cause the image to be scaled to the exact given height, and a height of -1 will cause the image to be scaled to the exact given width. If both width and height are given, this function will behave as if the smaller of the two values is passed as -1.

When not preserving aspect ratio, a width or height of -1 means to not scale the image at all in that dimension.

The stream is not closed.

Since: 2.14

Creates a new pixbuf by asynchronously loading an image from an input stream.

For more details see pixbufNewFromStreamAtScale, 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 pixbufNewFromStreamFinish to get the result of the operation.

Since: 2.24

Finishes an asynchronous pixbuf creation operation started with pixbufNewFromStreamAsync.

Since: 2.24

Creates a new pixbuf by parsing XPM data in memory. This data is commonly the result of including an XPM file into a program's C source.

Creates a new pixbuf which represents a sub-region of srcPixbuf. The new pixbuf shares its pixels with the original pixbuf, so writing to one affects both. The new pixbuf holds a reference to srcPixbuf, so srcPixbuf will not be finalized until the new pixbuf is finalized.

Note that if srcPixbuf is read-only, this function will force it to be mutable.

No description available in the introspection data.

Since: 2.32

Returns a read-only pointer to the raw pixel data; must not be modified. This function allows skipping the implicit copy that must be made if gdk_pixbuf_get_pixels() is called on a read-only pixbuf.

Since: 2.32

Remove the key/value pair option attached to a Pixbuf.

Since: 2.36

Rotates a pixbuf by a multiple of 90 degrees, and returns the result in a new pixbuf.

If angle is 0, a copy of src is returned, avoiding any rotation.

Since: 2.6

Modifies saturation and optionally pixelates src, placing the result in dest. src and dest may be the same pixbuf with no ill effects. If saturation is 1.0 then saturation is not changed. If it's less than 1.0, saturation is reduced (the image turns toward grayscale); if greater than 1.0, saturation is increased (the image gets more vivid colors). If pixelate is True, then pixels are faded in a checkerboard pattern to create a pixelated image. src and dest must have the same image format, size, and rowstride.

Saves pixbuf to a new buffer in format type, which is currently "jpeg", "tiff", "png", "ico" or "bmp". See gdk_pixbuf_save_to_buffer() for more details.

Since: 2.4

Saves pixbuf to a callback in format type, which is currently "jpeg", "png", "tiff", "ico" or "bmp". If error is set, False will be returned. See gdk_pixbuf_save_to_callback () for more details.

Since: 2.4

Finishes an asynchronous pixbuf save operation started with gdk_pixbuf_save_to_stream_async().

Since: 2.24

Saves pixbuf to an output stream.

Supported file formats are currently "jpeg", "tiff", "png", "ico" or "bmp". See gdk_pixbuf_save_to_stream() for more details.

Since: 2.36

Saves pixbuf to an output stream asynchronously.

For more details see pixbufSaveToStreamv, 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 pixbufSaveToStreamFinish to get the result of the operation.

Since: 2.36

Saves pixbuf to a file in type, which is currently "jpeg", "png", "tiff", "ico" or "bmp". If error is set, False will be returned. See gdk_pixbuf_save () for more details.

Creates a transformation of the source image src by scaling by scaleX and scaleY then translating by offsetX and offsetY, then renders the rectangle (destX, destY, destWidth, destHeight) of the resulting image onto the destination image replacing the previous contents.

Try to use pixbufScaleSimple first, this function is the industrial-strength power tool you can fall back to if pixbufScaleSimple isn't powerful enough.

If the source rectangle overlaps the destination rectangle on the same pixbuf, it will be overwritten during the scaling which results in rendering artifacts.

Create a new Pixbuf containing a copy of src scaled to destWidth x destHeight. Leaves src unaffected. interpType should be GDK_INTERP_NEAREST if you want maximum speed (but when scaling down GDK_INTERP_NEAREST is usually unusably ugly). The default interpType should be GDK_INTERP_BILINEAR which offers reasonable quality and speed.

You can scale a sub-portion of src by creating a sub-pixbuf pointing into src; see pixbufNewSubpixbuf.

If destWidth and destHeight are equal to the src width and height, a copy of src is returned, avoiding any scaling.

For more complicated scaling/alpha blending see pixbufScale and pixbufComposite.

Attaches a key/value pair as an option to a Pixbuf. If key already exists in the list of options attached to pixbuf, the new value is ignored and False is returned.

Since: 2.2

Construct a GValueConstruct with valid value for the “bits-per-sample” property. This is rarely needed directly, but it is used by new.

Get the value of the “bits-per-sample” property. When overloading is enabled, this is equivalent to

get pixbuf #bitsPerSample

Construct a GValueConstruct with valid value for the “colorspace” property. This is rarely needed directly, but it is used by new.

Get the value of the “colorspace” property. When overloading is enabled, this is equivalent to

get pixbuf #colorspace

Construct a GValueConstruct with valid value for the “has-alpha” property. This is rarely needed directly, but it is used by new.

Get the value of the “has-alpha” property. When overloading is enabled, this is equivalent to

get pixbuf #hasAlpha

Construct a GValueConstruct with valid value for the “height” property. This is rarely needed directly, but it is used by new.

Get the value of the “height” property. When overloading is enabled, this is equivalent to

get pixbuf #height

Construct a GValueConstruct with valid value for the “n-channels” property. This is rarely needed directly, but it is used by new.

Get the value of the “n-channels” property. When overloading is enabled, this is equivalent to

get pixbuf #nChannels

Construct a GValueConstruct with valid value for the “pixel-bytes” property. This is rarely needed directly, but it is used by new.

Get the value of the “pixel-bytes” property. When overloading is enabled, this is equivalent to

get pixbuf #pixelBytes

Construct a GValueConstruct with valid value for the “pixels” property. This is rarely needed directly, but it is used by new.

Get the value of the “pixels” property. When overloading is enabled, this is equivalent to

get pixbuf #pixels

Construct a GValueConstruct with valid value for the “rowstride” property. This is rarely needed directly, but it is used by new.

Get the value of the “rowstride” property. When overloading is enabled, this is equivalent to

get pixbuf #rowstride

Construct a GValueConstruct with valid value for the “width” property. This is rarely needed directly, but it is used by new.

Get the value of the “width” property. When overloading is enabled, this is equivalent to

get pixbuf #width