GdkPixbuf.Pixbuf

g GObject.GInterface GObject.GInterface Gio.Icon Gio.Icon GObject.GInterface->Gio.Icon Gio.LoadableIcon Gio.LoadableIcon GObject.GInterface->Gio.LoadableIcon GObject.Object GObject.Object GdkPixbuf.Pixbuf GdkPixbuf.Pixbuf GObject.Object->GdkPixbuf.Pixbuf Gio.Icon->GdkPixbuf.Pixbuf Gio.LoadableIcon->GdkPixbuf.Pixbuf

Subclasses

None

Methods

Inherited

GObject.Object (37), Gio.Icon (6), Gio.LoadableIcon (3)

Structs

GObject.ObjectClass (5)

class

calculate_rowstride (colorspace, has_alpha, bits_per_sample, width, height)

class

get_file_info (filename)

class

get_file_info_async (filename, cancellable, callback, *user_data)

class

get_file_info_finish (async_result)

class

get_formats ()

class

init_modules (path)

class

new (colorspace, has_alpha, bits_per_sample, width, height)

class

new_from_bytes (data, colorspace, has_alpha, bits_per_sample, width, height, rowstride)

class

new_from_data (data, colorspace, has_alpha, bits_per_sample, width, height, rowstride, destroy_fn, *destroy_fn_data)

class

new_from_file (filename)

class

new_from_file_at_scale (filename, width, height, preserve_aspect_ratio)

class

new_from_file_at_size (filename, width, height)

class

new_from_inline (data, copy_pixels)

class

new_from_resource (resource_path)

class

new_from_resource_at_scale (resource_path, width, height, preserve_aspect_ratio)

class

new_from_stream (stream, cancellable)

class

new_from_stream_async (stream, cancellable, callback, *user_data)

class

new_from_stream_at_scale (stream, width, height, preserve_aspect_ratio, cancellable)

class

new_from_stream_at_scale_async (stream, width, height, preserve_aspect_ratio, cancellable, callback, *user_data)

class

new_from_stream_finish (async_result)

class

new_from_xpm_data (data)

class

save_to_stream_finish (async_result)

add_alpha (substitute_color, r, g, b)

apply_embedded_orientation ()

composite (dest, dest_x, dest_y, dest_width, dest_height, offset_x, offset_y, scale_x, scale_y, interp_type, overall_alpha)

composite_color (dest, dest_x, dest_y, dest_width, dest_height, offset_x, offset_y, scale_x, scale_y, interp_type, overall_alpha, check_x, check_y, check_size, color1, color2)

composite_color_simple (dest_width, dest_height, interp_type, overall_alpha, check_size, color1, color2)

copy ()

copy_area (src_x, src_y, width, height, dest_pixbuf, dest_x, dest_y)

copy_options (dest_pixbuf)

fill (pixel)

flip (horizontal)

get_bits_per_sample ()

get_byte_length ()

get_colorspace ()

get_has_alpha ()

get_height ()

get_n_channels ()

get_option (key)

get_options ()

get_pixels ()

get_rowstride ()

get_width ()

new_subpixbuf (src_x, src_y, width, height)

read_pixel_bytes ()

read_pixels ()

remove_option (key)

rotate_simple (angle)

saturate_and_pixelate (dest, saturation, pixelate)

save_to_bufferv (type, option_keys, option_values)

save_to_callbackv (save_func, user_data, type, option_keys, option_values)

save_to_streamv (stream, type, option_keys, option_values, cancellable)

save_to_streamv_async (stream, type, option_keys, option_values, cancellable, callback, *user_data)

savev (filename, type, option_keys, option_values)

scale (dest, dest_x, dest_y, dest_width, dest_height, offset_x, offset_y, scale_x, scale_y, interp_type)

scale_simple (dest_width, dest_height, interp_type)

set_option (key, value)

Virtual Methods

Inherited

GObject.Object (7), Gio.Icon (4), Gio.LoadableIcon (3)

Properties

Name

Type

Flags

Short Description

bits-per-sample

int

r/w/co/en

The number of bits per sample

colorspace

GdkPixbuf.Colorspace

r/w/co/en

The colorspace in which the samples are interpreted

has-alpha

bool

r/w/co/en

Whether the pixbuf has an alpha channel

height

int

r/w/co/en

The number of rows of the pixbuf

n-channels

int

r/w/co/en

The number of samples per pixel

pixel-bytes

GLib.Bytes

r/w/co/en

Readonly pixel data

pixels

int

r/w/co/en

A pointer to the pixel data of the pixbuf

rowstride

int

r/w/co/en

The number of bytes between the start of a row and the start of the next row

width

int

r/w/co/en

The number of columns of the pixbuf

Signals

Inherited

GObject.Object (1)

Fields

Inherited

GObject.Object (1)

Class Details

class GdkPixbuf.Pixbuf(**kwargs)
Bases

GObject.Object, Gio.Icon, Gio.LoadableIcon

Abstract

No

A pixel buffer.

GdkPixbuf contains information about an image’s pixel data, its color space, bits per sample, width and height, and the rowstride (the number of bytes between the start of one row and the start of the next).

Creating new GdkPixbuf.Pixbuf

The most basic way to create a pixbuf is to wrap an existing pixel buffer with a [class`GdkPixbuf`.Pixbuf] instance. You can use the [ctor@GdkPixbuf.Pixbuf.new_from_data] function to do this.

Every time you create a new GdkPixbuf instance for some data, you will need to specify the destroy notification function that will be called when the data buffer needs to be freed; this will happen when a GdkPixbuf is finalized by the reference counting functions. If you have a chunk of static data compiled into your application, you can pass in NULL as the destroy notification function so that the data will not be freed.

The [ctor@GdkPixbuf.Pixbuf.new] constructor function can be used as a convenience to create a pixbuf with an empty buffer; this is equivalent to allocating a data buffer using malloc() and then wrapping it with gdk_pixbuf_new_from_data(). The gdk_pixbuf_new() function will compute an optimal rowstride so that rendering can be performed with an efficient algorithm.

As a special case, you can use the [ctor@GdkPixbuf.Pixbuf.new_from_xpm_data] function to create a pixbuf from inline XPM image data.

You can also copy an existing pixbuf with the [method`Pixbuf`.copy] function. This is not the same as just acquiring a reference to the old pixbuf instance: the copy function will actually duplicate the pixel data in memory and create a new [class`Pixbuf`] instance for it.

Reference counting

GdkPixbuf structures are reference counted. This means that an application can share a single pixbuf among many parts of the code. When a piece of the program needs to use a pixbuf, it should acquire a reference to it by calling g_object_ref(); when it no longer needs the pixbuf, it should release the reference it acquired by calling g_object_unref(). The resources associated with a GdkPixbuf will be freed when its reference count drops to zero. Newly-created GdkPixbuf instances start with a reference count of one.

Image Data

Image data in a pixbuf is stored in memory in an uncompressed, packed format. Rows in the image are stored top to bottom, and in each row pixels are stored from left to right.

There may be padding at the end of a row.

The “rowstride” value of a pixbuf, as returned by [method@GdkPixbuf.Pixbuf.get_rowstride], indicates the number of bytes between rows.

**NOTE**: If you are copying raw pixbuf data with memcpy() note that the last row in the pixbuf may not be as wide as the full rowstride, but rather just as wide as the pixel data needs to be; that is: it is unsafe to do memcpy (dest, pixels, rowstride * height) to copy a whole pixbuf. Use [method`GdkPixbuf`.Pixbuf.copy] instead, or compute the width in bytes of the last row as:

``c last_row = width * ((n_channels * bits_per_sample + 7) / 8); ``

The same rule applies when iterating over each row of a GdkPixbuf pixels array.

The following code illustrates a simple put_pixel() function for RGB pixbufs with 8 bits per channel with an alpha channel.

```c static void put_pixel (GdkPixbuf.Pixbuf *pixbuf, int x, int y, guchar red, guchar green, guchar blue, guchar alpha) { int n_channels = GdkPixbuf.Pixbuf.get_n_channels (pixbuf);

// Ensure that the pixbuf is valid g_assert (GdkPixbuf.Pixbuf.get_colorspace (pixbuf) == GdkPixbuf.Colorspace.RGB); g_assert (GdkPixbuf.Pixbuf.get_bits_per_sample (pixbuf) == 8); g_assert (GdkPixbuf.Pixbuf.get_has_alpha (pixbuf)); g_assert (n_channels == 4);

int width = GdkPixbuf.Pixbuf.get_width (pixbuf); int height = GdkPixbuf.Pixbuf.get_height (pixbuf);

// Ensure that the coordinates are in a valid range g_assert (x >= 0 && x < width); g_assert (y >= 0 && y < height);

int rowstride = GdkPixbuf.Pixbuf.get_rowstride (pixbuf);

// The pixel buffer in the GdkPixbuf.Pixbuf instance guchar *pixels = GdkPixbuf.Pixbuf.get_pixels (pixbuf);

// The pixel we wish to modify guchar *p = pixels + y * rowstride + x * n_channels; p[0] = red; p[1] = green; p[2] = blue; p[3] = alpha; } ```

Loading images

The GdkPixBuf class provides a simple mechanism for loading an image from a file in synchronous and asynchronous fashion.

For GUI applications, it is recommended to use the asynchronous stream API to avoid blocking the control flow of the application.

Additionally, GdkPixbuf provides the [class`GdkPixbuf`.PixbufLoader`] API for progressive image loading.

Saving images

The GdkPixbuf class provides methods for saving image data in a number of file formats. The formatted data can be written to a file or to a memory buffer. GdkPixbuf can also call a user-defined callback on the data, which allows to e.g. write the image to a socket or store it in a database.

classmethod calculate_rowstride(colorspace, has_alpha, bits_per_sample, width, height)
Parameters
  • colorspace (GdkPixbuf.Colorspace) – Color space for image

  • has_alpha (bool) – Whether the image should have transparency information

  • bits_per_sample (int) – Number of bits per color sample

  • width (int) – Width of image in pixels, must be > 0

  • height (int) – Height of image in pixels, must be > 0

Returns

the rowstride for the given values, or -1 in case of error.

Return type

int

Calculates the rowstride that an image created with those values would have.

This function is useful for front-ends and backends that want to check image values without needing to create a GdkPixbuf.

New in version 2.36.8.

classmethod get_file_info(filename)
Parameters

filename (str) – The name of the file to identify.

Returns

A GdkPixbufFormat describing the image format of the file

width

Return location for the width of the image

height

Return location for the height of the image

Return type

(GdkPixbuf.PixbufFormat or None, width: int, height: int)

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

New in version 2.4.

classmethod get_file_info_async(filename, cancellable, callback, *user_data)
Parameters
  • filename (str) – The name of the file to identify

  • cancellable (Gio.Cancellable or None) – optional GCancellable object, NULL to ignore

  • callback (Gio.AsyncReadyCallback or None) – a GAsyncReadyCallback to call when the file info is available

  • user_data (object or None) – the data to pass to the callback function

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

For more details see GdkPixbuf.Pixbuf.get_file_info(), 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 GdkPixbuf.Pixbuf.get_file_info_finish() to get the result of the operation.

New in version 2.32.

classmethod get_file_info_finish(async_result)
Parameters

async_result (Gio.AsyncResult) – a GAsyncResult

Raises

GLib.Error

Returns

A GdkPixbufFormat describing the image format of the file

width

Return location for the width of the image, or NULL

height

Return location for the height of the image, or NULL

Return type

(GdkPixbuf.PixbufFormat or None, width: int, height: int)

Finishes an asynchronous pixbuf parsing operation started with GdkPixbuf.Pixbuf.get_file_info_async().

New in version 2.32.

classmethod get_formats()
Returns

A list of support image formats.

Return type

[GdkPixbuf.PixbufFormat]

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

New in version 2.2.

classmethod init_modules(path)
Parameters

path (str) – Path to directory where the loaders.cache is installed

Raises

GLib.Error

Return type

bool

Initalizes the gdk-pixbuf loader modules referenced by the loaders.cache file present inside that directory.

This is to be used by applications that want to ship certain loaders in a different location from the system ones.

This is needed when the OS or runtime ships a minimal number of loaders so as to reduce the potential attack surface of carefully crafted image files, especially for uncommon file types. Applications that require broader image file types coverage, such as image viewers, would be expected to ship the gdk-pixbuf modules in a separate location, bundled with the application in a separate directory from the OS or runtime- provided modules.

New in version 2.40.

classmethod new(colorspace, has_alpha, bits_per_sample, width, height)
Parameters
  • colorspace (GdkPixbuf.Colorspace) – Color space for image

  • has_alpha (bool) – Whether the image should have transparency information

  • bits_per_sample (int) – Number of bits per color sample

  • width (int) – Width of image in pixels, must be > 0

  • height (int) – Height of image in pixels, must be > 0

Returns

A newly-created pixel buffer

Return type

GdkPixbuf.Pixbuf or None

Creates a new GdkPixbuf structure and allocates a buffer for it.

If the allocation of the buffer failed, this function will return NULL.

The buffer has an optimal rowstride. Note that the buffer is not cleared; you will have to fill it completely yourself.

classmethod new_from_bytes(data, colorspace, has_alpha, bits_per_sample, width, height, rowstride)
Parameters
  • data (GLib.Bytes) – Image data in 8-bit/sample packed format inside a GLib.Bytes

  • colorspace (GdkPixbuf.Colorspace) – Colorspace for the image data

  • has_alpha (bool) – Whether the data has an opacity channel

  • bits_per_sample (int) – Number of bits per sample

  • width (int) – Width of the image in pixels, must be > 0

  • height (int) – Height of the image in pixels, must be > 0

  • rowstride (int) – Distance in bytes between row starts

Returns

A newly-created pixbuf

Return type

GdkPixbuf.Pixbuf

Creates a new GdkPixbuf.Pixbuf out of in-memory readonly image data.

Currently only RGB images with 8 bits per sample are supported.

This is the GBytes variant of GdkPixbuf.Pixbuf.new_from_data(), useful for language bindings.

New in version 2.32.

classmethod new_from_data(data, colorspace, has_alpha, bits_per_sample, width, height, rowstride, destroy_fn, *destroy_fn_data)
Parameters
  • data (bytes) – Image data in 8-bit/sample packed format

  • colorspace (GdkPixbuf.Colorspace) – Colorspace for the image data

  • has_alpha (bool) – Whether the data has an opacity channel

  • bits_per_sample (int) – Number of bits per sample

  • width (int) – Width of the image in pixels, must be > 0

  • height (int) – Height of the image in pixels, must be > 0

  • rowstride (int) – Distance in bytes between row starts

  • destroy_fn (GdkPixbuf.PixbufDestroyNotify or None) – Function used to free the data when the pixbuf’s reference count drops to zero, or None if the data should not be freed

  • destroy_fn_data (object or None) – Closure data to pass to the destroy notification function

Returns

A newly-created pixbuf

Return type

GdkPixbuf.Pixbuf

Creates a new GdkPixbuf.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 GdkPixbufDestroyNotify. 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: [ctor`GdkPixbuf`.Pixbuf.new_from_bytes]

classmethod new_from_file(filename)
Parameters

filename (str) – Name of file to load, in the GLib file name encoding

Raises

GLib.Error

Returns

A newly-created pixbuf

Return type

GdkPixbuf.Pixbuf or None

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

The file format is detected automatically.

If NULL is returned, then error will be set. Possible errors are:

  • the file could not be opened

  • there is no loader for the file’s format

  • there is not enough memory to allocate the image buffer

  • the image buffer contains invalid data

The error domains are GDK_PIXBUF_ERROR and G_FILE_ERROR.

classmethod new_from_file_at_scale(filename, width, height, preserve_aspect_ratio)
Parameters
  • filename (str) – Name of file to load, in the GLib file name encoding

  • width (int) – The width the image should have or -1 to not constrain the width

  • height (int) – The height the image should have or -1 to not constrain the height

  • preserve_aspect_ratio (bool) – TRUE to preserve the image’s aspect ratio

Raises

GLib.Error

Returns

A newly-created pixbuf

Return type

GdkPixbuf.Pixbuf or None

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

The file format is detected automatically.

If NULL is returned, then error will be set. Possible errors are:

  • the file could not be opened

  • there is no loader for the file’s format

  • there is not enough memory to allocate the image buffer

  • the image buffer contains invalid data

The error domains are GDK_PIXBUF_ERROR and G_FILE_ERROR.

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.

New in version 2.6.

classmethod new_from_file_at_size(filename, width, height)
Parameters
  • filename (str) – Name of file to load, in the GLib file name encoding

  • width (int) – The width the image should have or -1 to not constrain the width

  • height (int) – The height the image should have or -1 to not constrain the height

Raises

GLib.Error

Returns

A newly-created pixbuf

Return type

GdkPixbuf.Pixbuf or None

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

The file format is detected automatically.

If NULL is returned, then error will be set. Possible errors are:

  • the file could not be opened

  • there is no loader for the file’s format

  • there is not enough memory to allocate the image buffer

  • the image buffer contains invalid data

The error domains are GDK_PIXBUF_ERROR and G_FILE_ERROR.

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 [ctor`GdkPixbuf`.Pixbuf.new_from_file_at_scale].

New in version 2.4.

classmethod new_from_inline(data, copy_pixels)
Parameters
  • data (bytes) – Byte data containing a serialized GdkPixdata structure

  • copy_pixels (bool) – Whether to copy the pixel data, or use direct pointers data for the resulting pixbuf

Raises

GLib.Error

Returns

A newly-created pixbuf

Return type

GdkPixbuf.Pixbuf

Creates a GdkPixbuf 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.

GdkPixbuf.Pixbuf ships with a program called gdk-pixbuf-csource, which allows for conversion of ``GdkPixbuf``s 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 copy_pixels. If you pass --rle to gdk-pixbuf-csource, a copy will be made even if copy_pixels 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:

``c 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.

Deprecated since version 2.32: Use GResource instead.

classmethod new_from_resource(resource_path)
Parameters

resource_path (str) – the path of the resource file

Raises

GLib.Error

Returns

A newly-created pixbuf

Return type

GdkPixbuf.Pixbuf or None

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

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

New in version 2.26.

classmethod new_from_resource_at_scale(resource_path, width, height, preserve_aspect_ratio)
Parameters
  • resource_path (str) – the path of the resource file

  • width (int) – The width the image should have or -1 to not constrain the width

  • height (int) – The height the image should have or -1 to not constrain the height

  • preserve_aspect_ratio (bool) – TRUE to preserve the image’s aspect ratio

Raises

GLib.Error

Returns

A newly-created pixbuf

Return type

GdkPixbuf.Pixbuf or None

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

The file format is detected automatically. If NULL 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.

New in version 2.26.

classmethod new_from_stream(stream, cancellable)
Parameters
Raises

GLib.Error

Returns

A newly-created pixbuf

Return type

GdkPixbuf.Pixbuf or None

Creates a new pixbuf by loading an image 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.

New in version 2.14.

classmethod new_from_stream_async(stream, cancellable, callback, *user_data)
Parameters

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

For more details see GdkPixbuf.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 GdkPixbuf.Pixbuf.new_from_stream_finish() to get the result of the operation.

New in version 2.24.

classmethod new_from_stream_at_scale(stream, width, height, preserve_aspect_ratio, cancellable)
Parameters
  • stream (Gio.InputStream) – a GInputStream to load the pixbuf from

  • width (int) – The width the image should have or -1 to not constrain the width

  • height (int) – The height the image should have or -1 to not constrain the height

  • preserve_aspect_ratio (bool) – TRUE to preserve the image’s aspect ratio

  • cancellable (Gio.Cancellable or None) – optional GCancellable object, NULL to ignore

Raises

GLib.Error

Returns

A newly-created pixbuf

Return type

GdkPixbuf.Pixbuf or None

Creates a new pixbuf by loading an image 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 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.

New in version 2.14.

classmethod new_from_stream_at_scale_async(stream, width, height, preserve_aspect_ratio, cancellable, callback, *user_data)
Parameters
  • stream (Gio.InputStream) – a GInputStream from which to load the pixbuf

  • width (int) – the width the image should have or -1 to not constrain the width

  • height (int) – the height the image should have or -1 to not constrain the height

  • preserve_aspect_ratio (bool) – TRUE to preserve the image’s aspect ratio

  • cancellable (Gio.Cancellable or None) – optional GCancellable object, NULL to ignore

  • callback (Gio.AsyncReadyCallback or None) – a GAsyncReadyCallback to call when the pixbuf is loaded

  • user_data (object or None) – the data to pass to the callback function

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

For more details see GdkPixbuf.Pixbuf.new_from_stream_at_scale(), 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 GdkPixbuf.Pixbuf.new_from_stream_finish() to get the result of the operation.

New in version 2.24.

classmethod new_from_stream_finish(async_result)
Parameters

async_result (Gio.AsyncResult) – a GAsyncResult

Raises

GLib.Error

Returns

the newly created pixbuf

Return type

GdkPixbuf.Pixbuf or None

Finishes an asynchronous pixbuf creation operation started with GdkPixbuf.Pixbuf.new_from_stream_async().

New in version 2.24.

classmethod new_from_xpm_data(data)
Parameters

data ([str]) – Pointer to inline XPM data.

Returns

A newly-created pixbuf

Return type

GdkPixbuf.Pixbuf

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.

classmethod save_to_stream_finish(async_result)
Parameters

async_result (Gio.AsyncResult) – a GAsyncResult

Raises

GLib.Error

Returns

TRUE if the pixbuf was saved successfully, FALSE if an error was set.

Return type

bool

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

New in version 2.24.

add_alpha(substitute_color, r, g, b)
Parameters
  • substitute_color (bool) – Whether to set a color to zero opacity.

  • r (int) – Red value to substitute.

  • g (int) – Green value to substitute.

  • b (int) – Blue value to substitute.

Returns

A newly-created pixbuf

Return type

GdkPixbuf.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 substitute_color is TRUE, then the color specified by the (r, g, b) arguments will be assigned zero opacity. That is, if you pass (255, 255, 255) for the substitute color, all white pixels will become fully transparent.

If substitute_color is FALSE, then the (r, g, b) arguments will be ignored.

apply_embedded_orientation()
Returns

A newly-created pixbuf

Return type

GdkPixbuf.Pixbuf or None

Takes an existing pixbuf and checks for the presence of an associated “orientation” option.

The orientation option 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.

New in version 2.12.

composite(dest, dest_x, dest_y, dest_width, dest_height, offset_x, offset_y, scale_x, scale_y, interp_type, overall_alpha)
Parameters
  • dest (GdkPixbuf.Pixbuf) – the GdkPixbuf.Pixbuf into which to render the results

  • dest_x (int) – the left coordinate for region to render

  • dest_y (int) – the top coordinate for region to render

  • dest_width (int) – the width of the region to render

  • dest_height (int) – the height of the region to render

  • offset_x (float) – the offset in the X direction (currently rounded to an integer)

  • offset_y (float) – the offset in the Y direction (currently rounded to an integer)

  • scale_x (float) – the scale factor in the X direction

  • scale_y (float) – the scale factor in the Y direction

  • interp_type (GdkPixbuf.InterpType) – the interpolation type for the transformation.

  • overall_alpha (int) – overall alpha for source image (0..255)

Creates a transformation of the source image self by scaling by scale_x and scale_y then translating by offset_x and offset_y.

This gives an image in the coordinates of the destination pixbuf. The rectangle (dest_x, dest_y, dest_width, dest_height) 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.

composite_color(dest, dest_x, dest_y, dest_width, dest_height, offset_x, offset_y, scale_x, scale_y, interp_type, overall_alpha, check_x, check_y, check_size, color1, color2)
Parameters
  • dest (GdkPixbuf.Pixbuf) – the GdkPixbuf.Pixbuf into which to render the results

  • dest_x (int) – the left coordinate for region to render

  • dest_y (int) – the top coordinate for region to render

  • dest_width (int) – the width of the region to render

  • dest_height (int) – the height of the region to render

  • offset_x (float) – the offset in the X direction (currently rounded to an integer)

  • offset_y (float) – the offset in the Y direction (currently rounded to an integer)

  • scale_x (float) – the scale factor in the X direction

  • scale_y (float) – the scale factor in the Y direction

  • interp_type (GdkPixbuf.InterpType) – the interpolation type for the transformation.

  • overall_alpha (int) – overall alpha for source image (0..255)

  • check_x (int) – the X offset for the checkboard (origin of checkboard is at -check_x, -check_y)

  • check_y (int) – the Y offset for the checkboard

  • check_size (int) – the size of checks in the checkboard (must be a power of two)

  • color1 (int) – the color of check at upper left

  • color2 (int) – the color of the other check

Creates a transformation of the source image self by scaling by scale_x and scale_y then translating by offset_x and offset_y, then alpha blends the rectangle (dest_x ,`dest_y`, dest_width, dest_height) 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 overall_alpha is 255, a fast path is used which omits the alpha blending and just performs the scaling.

See GdkPixbuf.Pixbuf.composite_color_simple() for a simpler variant of this function suitable for many tasks.

composite_color_simple(dest_width, dest_height, interp_type, overall_alpha, check_size, color1, color2)
Parameters
  • dest_width (int) – the width of destination image

  • dest_height (int) – the height of destination image

  • interp_type (GdkPixbuf.InterpType) – the interpolation type for the transformation.

  • overall_alpha (int) – overall alpha for source image (0..255)

  • check_size (int) – the size of checks in the checkboard (must be a power of two)

  • color1 (int) – the color of check at upper left

  • color2 (int) – the color of the other check

Returns

the new pixbuf

Return type

GdkPixbuf.Pixbuf or None

Creates a new pixbuf by scaling src to dest_width x dest_height and alpha blending the result with a checkboard of colors color1 and color2.

copy()
Returns

A newly-created pixbuf

Return type

GdkPixbuf.Pixbuf or None

Creates a new GdkPixbuf with a copy of the information in the specified pixbuf.

Note that this does not copy the options set on the original GdkPixbuf, use GdkPixbuf.Pixbuf.copy_options() for this.

copy_area(src_x, src_y, width, height, dest_pixbuf, dest_x, dest_y)
Parameters
  • src_x (int) – Source X coordinate within self.

  • src_y (int) – Source Y coordinate within self.

  • width (int) – Width of the area to copy.

  • height (int) – Height of the area to copy.

  • dest_pixbuf (GdkPixbuf.Pixbuf) – Destination pixbuf.

  • dest_x (int) – X coordinate within dest_pixbuf.

  • dest_y (int) – Y coordinate within dest_pixbuf.

Copies a rectangular area from src_pixbuf to dest_pixbuf.

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_options(dest_pixbuf)
Parameters

dest_pixbuf (GdkPixbuf.Pixbuf) – the destination pixbuf

Returns

TRUE on success.

Return type

bool

Copies the key/value pair options attached to a GdkPixbuf to another GdkPixbuf.

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.

New in version 2.36.

fill(pixel)
Parameters

pixel (int) – RGBA pixel to used to clear (0xffffffff is opaque white, 0x00000000 transparent black)

Clears a pixbuf to the given RGBA value, converting the RGBA value into the pixbuf’s pixel format.

The alpha component will be ignored if the pixbuf doesn’t have an alpha channel.

flip(horizontal)
Parameters

horizontal (bool) – TRUE to flip horizontally, FALSE to flip vertically

Returns

the new pixbuf

Return type

GdkPixbuf.Pixbuf or None

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

New in version 2.6.

get_bits_per_sample()
Returns

Number of bits per color sample.

Return type

int

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

get_byte_length()
Returns

The length of the pixel data.

Return type

int

Returns the length of the pixel data, in bytes.

New in version 2.26.

get_colorspace()
Returns

Color space.

Return type

GdkPixbuf.Colorspace

Queries the color space of a pixbuf.

get_has_alpha()
Returns

TRUE if it has an alpha channel, FALSE otherwise.

Return type

bool

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

get_height()
Returns

Height in pixels.

Return type

int

Queries the height of a pixbuf.

get_n_channels()
Returns

Number of channels.

Return type

int

Queries the number of channels of a pixbuf.

get_option(key)
Parameters

key (str) – a nul-terminated string.

Returns

the value associated with key

Return type

str or None

Looks up key in the list of options that may have been attached to the self when it was loaded, or that may have been attached by another function using GdkPixbuf.Pixbuf.set_option().

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.

get_options()
Returns

a GLib.HashTable of key/values pairs

Return type

{str: str}

Returns a GHashTable with a list of all the options that may have been attached to the pixbuf when it was loaded, or that may have been attached by another function using [method`GdkPixbuf`.Pixbuf.set_option].

New in version 2.32.

get_pixels()
Returns

A pointer to the pixbuf’s pixel data.

Return type

bytes

Queries a pointer to the pixel data of a pixbuf.

This function will cause an implicit copy of the pixbuf data if the pixbuf was created from read-only data.

Please see the section on image data for information about how the pixel data is stored in memory.

New in version 2.26.

get_rowstride()
Returns

Distance between row starts.

Return type

int

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.

get_width()
Returns

Width in pixels.

Return type

int

Queries the width of a pixbuf.

new_subpixbuf(src_x, src_y, width, height)
Parameters
  • src_x (int) – X coord in self

  • src_y (int) – Y coord in self

  • width (int) – width of region in self

  • height (int) – height of region in self

Returns

a new pixbuf

Return type

GdkPixbuf.Pixbuf

Creates a new pixbuf which represents a sub-region of src_pixbuf.

The new pixbuf shares its pixels with the original pixbuf, so writing to one affects both. The new pixbuf holds a reference to src_pixbuf, so src_pixbuf will not be finalized until the new pixbuf is finalized.

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

read_pixel_bytes()
Returns

A new reference to a read-only copy of the pixel data. Note that for mutable pixbufs, this function will incur a one-time copy of the pixel data for conversion into the returned GLib.Bytes.

Return type

GLib.Bytes

Provides a GLib.Bytes buffer containing the raw pixel data; the data must not be modified.

This function allows skipping the implicit copy that must be made if GdkPixbuf.Pixbuf.get_pixels() is called on a read-only pixbuf.

New in version 2.32.

read_pixels()
Returns

a read-only pointer to the raw pixel data

Return type

int

Provides a read-only pointer to the raw pixel data.

This function allows skipping the implicit copy that must be made if GdkPixbuf.Pixbuf.get_pixels() is called on a read-only pixbuf.

New in version 2.32.

remove_option(key)
Parameters

key (str) – a nul-terminated string representing the key to remove.

Returns

TRUE if an option was removed, FALSE if not.

Return type

bool

Removes the key/value pair option attached to a GdkPixbuf.

New in version 2.36.

rotate_simple(angle)
Parameters

angle (GdkPixbuf.PixbufRotation) – the angle to rotate by

Returns

the new pixbuf

Return type

GdkPixbuf.Pixbuf or None

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

If angle is 0, this function will return a copy of src.

New in version 2.6.

saturate_and_pixelate(dest, saturation, pixelate)
Parameters
  • dest (GdkPixbuf.Pixbuf) – place to write modified version of self

  • saturation (float) – saturation factor

  • pixelate (bool) – whether to pixelate

Modifies saturation and optionally pixelates src, placing the result in dest.

The src and dest pixbufs must have the same image format, size, and rowstride.

The src and dest arguments 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.

save_to_bufferv(type, option_keys, option_values)
Parameters
  • type (str) – name of file format.

  • option_keys ([str] or None) – name of options to set

  • option_values ([str] or None) – values for named options

Raises

GLib.Error

Returns

whether an error was set

buffer

location to receive a pointer to the new buffer.

Return type

(bool, buffer: bytes)

Vector version of gdk_pixbuf_save_to_buffer().

Saves pixbuf to a new buffer in format type, which is currently “jpeg”, “tiff”, “png”, “ico” or “bmp”.

See [method`GdkPixbuf`.Pixbuf.save_to_buffer] for more details.

New in version 2.4.

save_to_callbackv(save_func, user_data, type, option_keys, option_values)
Parameters
  • save_func (GdkPixbuf.PixbufSaveFunc) – a function that is called to save each block of data that the save routine generates.

  • user_data (object or None) – user data to pass to the save function.

  • type (str) – name of file format.

  • option_keys ([str] or None) – name of options to set

  • option_values ([str] or None) – values for named options

Raises

GLib.Error

Returns

whether an error was set

Return type

bool

Vector version of gdk_pixbuf_save_to_callback().

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 [method`GdkPixbuf`.Pixbuf.save_to_callback] for more details.

New in version 2.4.

save_to_streamv(stream, type, option_keys, option_values, cancellable)
Parameters
  • stream (Gio.OutputStream) – a GOutputStream to save the pixbuf to

  • type (str) – name of file format

  • option_keys ([str] or None) – name of options to set

  • option_values ([str] or None) – values for named options

  • cancellable (Gio.Cancellable or None) – optional GCancellable object, NULL to ignore

Raises

GLib.Error

Returns

TRUE if the pixbuf was saved successfully, FALSE if an error was set.

Return type

bool

Saves pixbuf to an output stream.

Supported file formats are currently “jpeg”, “tiff”, “png”, “ico” or “bmp”.

See [method`GdkPixbuf`.Pixbuf.save_to_stream] for more details.

New in version 2.36.

save_to_streamv_async(stream, type, option_keys, option_values, cancellable, callback, *user_data)
Parameters
  • stream (Gio.OutputStream) – a GOutputStream to which to save the pixbuf

  • type (str) – name of file format

  • option_keys ([str] or None) – name of options to set

  • option_values ([str] or None) – values for named options

  • cancellable (Gio.Cancellable or None) – optional GCancellable object, NULL to ignore

  • callback (Gio.AsyncReadyCallback or None) – a GAsyncReadyCallback to call when the pixbuf is saved

  • user_data (object or None) – the data to pass to the callback function

Saves pixbuf to an output stream asynchronously.

For more details see GdkPixbuf.Pixbuf.save_to_streamv(), 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 GdkPixbuf.Pixbuf.save_to_stream_finish() to get the result of the operation.

New in version 2.36.

savev(filename, type, option_keys, option_values)
Parameters
  • filename (str) – name of file to save.

  • type (str) – name of file format.

  • option_keys ([str] or None) – name of options to set

  • option_values ([str] or None) – values for named options

Raises

GLib.Error

Returns

whether an error was set

Return type

bool

Vector version of gdk_pixbuf_save().

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 [method`GdkPixbuf`.Pixbuf.save] for more details.

scale(dest, dest_x, dest_y, dest_width, dest_height, offset_x, offset_y, scale_x, scale_y, interp_type)
Parameters
  • dest (GdkPixbuf.Pixbuf) – the GdkPixbuf.Pixbuf into which to render the results

  • dest_x (int) – the left coordinate for region to render

  • dest_y (int) – the top coordinate for region to render

  • dest_width (int) – the width of the region to render

  • dest_height (int) – the height of the region to render

  • offset_x (float) – the offset in the X direction (currently rounded to an integer)

  • offset_y (float) – the offset in the Y direction (currently rounded to an integer)

  • scale_x (float) – the scale factor in the X direction

  • scale_y (float) – the scale factor in the Y direction

  • interp_type (GdkPixbuf.InterpType) – the interpolation type for the transformation.

Creates a transformation of the source image self by scaling by scale_x and scale_y then translating by offset_x and offset_y, then renders the rectangle (dest_x, dest_y, dest_width, dest_height) of the resulting image onto the destination image replacing the previous contents.

Try to use GdkPixbuf.Pixbuf.scale_simple() first; this function is the industrial-strength power tool you can fall back to, if GdkPixbuf.Pixbuf.scale_simple() 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.

scale_simple(dest_width, dest_height, interp_type)
Parameters
  • dest_width (int) – the width of destination image

  • dest_height (int) – the height of destination image

  • interp_type (GdkPixbuf.InterpType) – the interpolation type for the transformation.

Returns

the new pixbuf

Return type

GdkPixbuf.Pixbuf or None

Create a new pixbuf containing a copy of src scaled to dest_width x dest_height.

This function leaves src unaffected.

The interp_type should be GDK_INTERP_NEAREST if you want maximum speed (but when scaling down GDK_INTERP_NEAREST is usually unusably ugly). The default interp_type 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 [method`GdkPixbuf`.Pixbuf.new_subpixbuf].

If dest_width and dest_height are equal to the width and height of src, this function will return an unscaled copy of src.

For more complicated scaling/alpha blending see [method`GdkPixbuf`.Pixbuf.scale] and [method`GdkPixbuf`.Pixbuf.composite].

set_option(key, value)
Parameters
  • key (str) – a nul-terminated string.

  • value (str) – a nul-terminated string.

Returns

TRUE on success

Return type

bool

Attaches a key/value pair as an option to a GdkPixbuf.

If key already exists in the list of options attached to the pixbuf, the new value is ignored and FALSE is returned.

New in version 2.2.

Property Details

GdkPixbuf.Pixbuf.props.bits_per_sample
Name

bits-per-sample

Type

int

Default Value

8

Flags

READABLE, WRITABLE, CONSTRUCT_ONLY, EXPLICIT_NOTIFY

The number of bits per sample.

Currently only 8 bit per sample are supported.

GdkPixbuf.Pixbuf.props.colorspace
Name

colorspace

Type

GdkPixbuf.Colorspace

Default Value

GdkPixbuf.Colorspace.RGB

Flags

READABLE, WRITABLE, CONSTRUCT_ONLY, EXPLICIT_NOTIFY

The color space of the pixbuf.

Currently, only GDK_COLORSPACE_RGB is supported.

GdkPixbuf.Pixbuf.props.has_alpha
Name

has-alpha

Type

bool

Default Value

False

Flags

READABLE, WRITABLE, CONSTRUCT_ONLY, EXPLICIT_NOTIFY

Whether the pixbuf has an alpha channel.

GdkPixbuf.Pixbuf.props.height
Name

height

Type

int

Default Value

1

Flags

READABLE, WRITABLE, CONSTRUCT_ONLY, EXPLICIT_NOTIFY

The number of rows of the pixbuf.

GdkPixbuf.Pixbuf.props.n_channels
Name

n-channels

Type

int

Default Value

3

Flags

READABLE, WRITABLE, CONSTRUCT_ONLY, EXPLICIT_NOTIFY

The number of samples per pixel.

Currently, only 3 or 4 samples per pixel are supported.

GdkPixbuf.Pixbuf.props.pixel_bytes
Name

pixel-bytes

Type

GLib.Bytes

Default Value

None

Flags

READABLE, WRITABLE, CONSTRUCT_ONLY, EXPLICIT_NOTIFY

Readonly pixel data

GdkPixbuf.Pixbuf.props.pixels
Name

pixels

Type

int

Default Value

None

Flags

READABLE, WRITABLE, CONSTRUCT_ONLY, EXPLICIT_NOTIFY

A pointer to the pixel data of the pixbuf.

GdkPixbuf.Pixbuf.props.rowstride
Name

rowstride

Type

int

Default Value

1

Flags

READABLE, WRITABLE, CONSTRUCT_ONLY, EXPLICIT_NOTIFY

The number of bytes between the start of a row and the start of the next row.

This number must (obviously) be at least as large as the width of the pixbuf.

GdkPixbuf.Pixbuf.props.width
Name

width

Type

int

Default Value

1

Flags

READABLE, WRITABLE, CONSTRUCT_ONLY, EXPLICIT_NOTIFY

The number of columns of the pixbuf.