class: GdkPixbuf

[76:7] extends: object

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 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. 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, int x, int y, guchar red, guchar green, guchar blue, guchar alpha) { int n_channels = gdk_pixbuf_get_n_channels (pixbuf); // Ensure that the pixbuf is valid g_assert (gdk_pixbuf_get_colorspace (pixbuf) == GDK_COLORSPACE_RGB); g_assert (gdk_pixbuf_get_bits_per_sample (pixbuf) == 8); g_assert (gdk_pixbuf_get_has_alpha (pixbuf)); g_assert (n_channels == 4); int width = gdk_pixbuf_get_width (pixbuf); int height = gdk_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 = gdk_pixbuf_get_rowstride (pixbuf); // The pixel buffer in the GdkPixbuf instance guchar *pixels = gdk_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 GdkPixbufclass 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.

Members

handleObj
lib
retainedCallbacks
signalHandlerNames
signalSetterHandlers

Methods

GdkPixbuf (colorspace = null, has_alpha = null, bits_per_sample = null, width = null, height = null)

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.
- @p colorspace is Color space for image.
- @p has_alpha is Whether the image should have transparency information.
- @p bits_per_sample is Number of bits per color sample.
- @p width is Width of image in pixels, must be > 0.
- @p height is Height of image in pixels, must be > 0.
toNativeHandle (Source)

Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.
- @p Source is the raw handle, raw buffer, wrapper, or null.
- @r A raw pointer carrier or null when no pointer is present.
getLib ()

Returns the opened native library for this generated wrapper.
- @r The opened native library.
handle ()

Returns the wrapped NativeHandle.
- @r The wrapped NativeHandle.
isNull ()

Returns true when the wrapped handle is null.
- @r A bool.
describe ()

Returns a small string for debugging generated wrappers.
- @r A string.
asObject ()

Wraps this handle as GObject.
- @r A GObject object.
asIcon ()

Wraps this handle as GIcon.
- @r A GIcon object.
asLoadableIcon ()

Wraps this handle as GLoadableIcon.
- @r A GLoadableIcon object.
add_alpha (bool substitute_color, int r, int g, int b)

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.
- @p substitute_color is Whether to set a color to zero opacity..
- @p r is Red value to substitute..
- @p g is Green value to substitute..
- @p b is Blue value to substitute..
- @r A newly-created pixbuf.
apply_embedded_orientation ()

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.
- @r A newly-created pixbuf.
composite (object dest, int dest_x, int dest_y, int dest_width, int dest_height, double offset_x, double offset_y, double scale_x, double scale_y, string interp_type, int overall_alpha)

Creates a transformation of the source image @src 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.
- @p dest is the #GdkPixbuf into which to render the results.
- @p dest_x is the left coordinate for region to render.
- @p dest_y is the top coordinate for region to render.
- @p dest_width is the width of the region to render.
- @p dest_height is the height of the region to render.
- @p offset_x is the offset in the X direction (currently rounded to an integer).
- @p offset_y is the offset in the Y direction (currently rounded to an integer).
- @p scale_x is the scale factor in the X direction.
- @p scale_y is the scale factor in the Y direction.
- @p interp_type is the interpolation type for the transformation..
- @p overall_alpha is overall alpha for source image (0..255).
- @r None.
composite_color (object dest, int dest_x, int dest_y, int dest_width, int dest_height, double offset_x, double offset_y, double scale_x, double scale_y, string interp_type, int overall_alpha, int check_x, int check_y, int check_size, int color1, int color2)

Creates a transformation of the source image @src 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 gdk_pixbuf_composite_color_simple() for a simpler variant of this function suitable for many tasks.
- @p dest is the #GdkPixbuf into which to render the results.
- @p dest_x is the left coordinate for region to render.
- @p dest_y is the top coordinate for region to render.
- @p dest_width is the width of the region to render.
- @p dest_height is the height of the region to render.
- @p offset_x is the offset in the X direction (currently rounded to an integer).
- @p offset_y is the offset in the Y direction (currently rounded to an integer).
- @p scale_x is the scale factor in the X direction.
- @p scale_y is the scale factor in the Y direction.
- @p interp_type is the interpolation type for the transformation..
- @p overall_alpha is overall alpha for source image (0..255).
- @p check_x is the X offset for the checkboard (origin of checkboard is at -@check_x, -@check_y).
- @p check_y is the Y offset for the checkboard.
- @p check_size is the size of checks in the checkboard (must be a power of two).
- @p color1 is the color of check at upper left.
- @p color2 is the color of the other check.
- @r None.
composite_color_simple (int dest_width, int dest_height, string interp_type, int overall_alpha, int check_size, int color1, int color2)

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.
- @p dest_width is the width of destination image.
- @p dest_height is the height of destination image.
- @p interp_type is the interpolation type for the transformation..
- @p overall_alpha is overall alpha for source image (0..255).
- @p check_size is the size of checks in the checkboard (must be a power of two).
- @p color1 is the color of check at upper left.
- @p color2 is the color of the other check.
- @r the new pixbuf.
copy ()

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 gdk_pixbuf_copy_options() for this.
- @r A newly-created pixbuf.
copy_area (int src_x, int src_y, int width, int height, object dest_pixbuf, int dest_x, int dest_y)

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.
- @p src_x is Source X coordinate within @src_pixbuf..
- @p src_y is Source Y coordinate within @src_pixbuf..
- @p width is Width of the area to copy..
- @p height is Height of the area to copy..
- @p dest_pixbuf is Destination pixbuf..
- @p dest_x is X coordinate within @dest_pixbuf..
- @p dest_y is Y coordinate within @dest_pixbuf..
- @r None.
copy_options (object dest_pixbuf)

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.
- @p dest_pixbuf is the destination pixbuf.
- @r TRUE on success..
fill (int pixel)

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.
- @p pixel is RGBA pixel to used to clear (0xffffffff is opaque white, 0x00000000 transparent black).
- @r None.
flip (bool horizontal)

Flips a pixbuf horizontally or vertically and returns the result in a new pixbuf.
- @p horizontal is TRUE to flip horizontally, FALSE to flip vertically.
- @r the new pixbuf.
get_bits_per_sample ()

Queries the number of bits per color sample in a pixbuf.
- @r Number of bits per color sample..
get_byte_length ()

Returns the length of the pixel data, in bytes.
- @r The length of the pixel data..
get_colorspace ()

Queries the color space of a pixbuf.
- @r Color space..
get_has_alpha ()

Queries whether a pixbuf has an alpha channel (opacity information).
- @r TRUE if it has an alpha channel, FALSE otherwise..
get_height ()

Queries the height of a pixbuf.
- @r Height in pixels..
get_n_channels ()

Queries the number of channels of a pixbuf.
- @r Number of channels..
get_option (string key)

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 gdk_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.
- @p key is a nul-terminated string..
- @r the value associated with key.
get_options ()

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].
- @r a #GHashTable of key/values pairs.
get_pixels ()

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.
- @r A pointer to the pixbuf's pixel data..
get_pixels_with_length ()

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.
- @p length is The length of the binary data..
- @r A pointer to the pixbuf's pixel data..
get_rowstride ()

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.
- @r Distance between row starts..
get_width ()

Queries the width of a pixbuf.
- @r Width in pixels..
new_subpixbuf (int src_x, int src_y, int width, int height)

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.
- @p src_x is X coord in @src_pixbuf.
- @p src_y is Y coord in @src_pixbuf.
- @p width is width of region in @src_pixbuf.
- @p height is height of region in @src_pixbuf.
- @r a new pixbuf.
read_pixel_bytes ()

Provides a #GBytes buffer containing the raw pixel data; the 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.
- @r 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 #GBytes..
read_pixels ()

Provides a read-only pointer to the raw pixel data. This function allows skipping the implicit copy that must be made if gdk_pixbuf_get_pixels() is called on a read-only pixbuf.
- @r a read-only pointer to the raw pixel data.
ref ()

Adds a reference to a pixbuf.
- @r The same as the @pixbuf argument..
remove_option (string key)

Removes the key/value pair option attached to a GdkPixbuf.
- @p key is a nul-terminated string representing the key to remove..
- @r TRUE if an option was removed, FALSE if not..
rotate_simple (string angle)

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.
- @p angle is the angle to rotate by.
- @r the new pixbuf.
saturate_and_pixelate (object dest, double saturation, bool 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.
- @p dest is place to write modified version of @src.
- @p saturation is saturation factor.
- @p pixelate is whether to pixelate.
- @r None.
save (string filename, string type, object error, list varargs)

Saves pixbuf to a file in format @type. By default, "jpeg", "png", "ico" and "bmp" are possible file formats to save in, but more formats may be installed. The list of all writable formats can be determined in the following way: c void add_if_writable (GdkPixbufFormat *data, GSList **list) { if (gdk_pixbuf_format_is_writable (data)) *list = g_slist_prepend (*list, data); } GSList *formats = gdk_pixbuf_get_formats (); GSList *writable_formats = NULL; g_slist_foreach (formats, add_if_writable, &writable_formats); g_slist_free (formats); If error is set, FALSE will be returned. Possible errors include those in the GDK_PIXBUF_ERROR domain and those in the G_FILE_ERROR domain. The variable argument list should be NULL-terminated; if not empty, it should contain pairs of strings that modify the save parameters. For example: c gdk_pixbuf_save (pixbuf, handle, "jpeg", &error, "quality", "100", NULL); Currently only few parameters exist. JPEG images can be saved with a "quality" parameter; its value should be in the range [0, 100]. JPEG and PNG density can be set by setting the "x-dpi" and "y-dpi" parameters to the appropriate values in dots per inch. Text chunks can be attached to PNG images by specifying parameters of the form "tEXt::key", where key is an ASCII string of length 1-79. The values are UTF-8 encoded strings. The PNG compression level can be specified using the "compression" parameter; it's value is in an integer in the range of [0, 9]. ICC color profiles can also be embedded into PNG, JPEG and TIFF images. The "icc-profile" value should be the complete ICC profile encoded into base64. c char *contents; gsize length; // icm_path is set elsewhere g_file_get_contents (icm_path, &contents, &length, NULL); char *contents_encode = g_base64_encode ((const guchar *) contents, length); gdk_pixbuf_save (pixbuf, handle, "png", &error, "icc-profile", contents_encode, NULL); TIFF images recognize: 1. a "bits-per-sample" option (integer) which can be either 1 for saving bi-level CCITTFAX4 images, or 8 for saving 8-bits per sample 2. a "compression" option (integer) which can be 1 for no compression, 2 for Huffman, 5 for LZW, 7 for JPEG and 8 for DEFLATE (see the libtiff documentation and tiff.h for all supported codec values) 3. an "icc-profile" option (zero-terminated string) containing a base64 encoded ICC color profile. ICO images can be saved in depth 16, 24, or 32, by using the "depth" parameter. When the ICO saver is given "x_hot" and "y_hot" parameters, it produces a CUR instead of an ICO.
- @p filename is name of file to save..
- @p type is name of file format..
- @p error is return location for error.
- @p ... is list of key-value save options, followed by NULL.
- @r TRUE on success, and FALSE otherwise.
save_to_buffer (string type, object error, list varargs)

Saves pixbuf to a new buffer in format type, which is currently "jpeg", "png", "tiff", "ico" or "bmp". This is a convenience function that uses gdk_pixbuf_save_to_callback() to do the real work. Note that the buffer is not NUL-terminated and may contain embedded NUL characters. If
- @error is set, FALSE will be returned and @buffer will be set to NULL. Possible errors include those in the GDK_PIXBUF_ERROR domain. See gdk_pixbuf_save() for more details.
- @p buffer is location to receive a pointer to the new buffer..
- @p buffer_size is location to receive the size of the new buffer..
- @p type is name of file format..
- @p error is return location for error, or NULL.
- @p ... is list of key-value save options.
- @r whether an error was set.
save_to_bufferv (string type, list option_keys, list option_values)

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.
- @p buffer is location to receive a pointer to the new buffer..
- @p buffer_size is location to receive the size of the new buffer..
- @p type is name of file format..
- @p option_keys is name of options to set.
- @p option_values is values for named options.
- @r whether an error was set.
save_to_callback (user_data, string type, object error, list varargs)

Saves pixbuf in format type by feeding the produced data to a callback. This function can be used when you want to store the image to something other than a file, such as an in-memory buffer or a socket. If @error is set, FALSE will be returned. Possible errors include those in the GDK_PIXBUF_ERROR domain and whatever the save function generates. See [method@GdkPixbuf.Pixbuf.save] for more details.
- @p save_func is a function that is called to save each block of data that the save routine generates..
- @p user_data is user data to pass to the save function..
- @p type is name of file format..
- @p error is return location for error, or NULL.
- @p ... is list of key-value save options.
- @r whether an error was set.
save_to_callbackv (user_data, string type, list option_keys, list option_values)

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.
- @p save_func is a function that is called to save each block of data that the save routine generates.
- @p user_data is user data to pass to the save function.
- @p type is name of file format.
- @p option_keys is name of options to set.
- @p option_values is values for named options.
- @r whether an error was set.
save_to_stream (object stream, string type, object cancellable, object error, list varargs)

Saves pixbuf to an output stream. Supported file formats are currently "jpeg", "tiff", "png", "ico" or "bmp". See gdk_pixbuf_save_to_buffer() for more details. 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 at the end of this call.
- @p stream is a GOutputStream to save the pixbuf to.
- @p type is name of file format.
- @p cancellable is optional GCancellable object, NULL to ignore.
- @p error is return location for error, or NULL.
- @p ... is list of key-value save options.
- @r TRUE if the pixbuf was saved successfully, FALSE if an error was set..
save_to_stream_async (object stream, string type, object cancellable, user_data, list varargs)

Saves pixbuf to an output stream asynchronously. For more details see gdk_pixbuf_save_to_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 gdk_pixbuf_save_to_stream_finish() to get the result of the operation.
- @p stream is a GOutputStream to which to save the pixbuf.
- @p type is name of file format.
- @p cancellable is optional GCancellable object, NULL to ignore.
- @p callback is a GAsyncReadyCallback to call when the pixbuf is saved.
- @p user_data is the data to pass to the callback function.
- @p ... is list of key-value save options.
- @r None.
save_to_streamv (object stream, string type, list option_keys, list option_values, object cancellable)

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.
- @p stream is a GOutputStream to save the pixbuf to.
- @p type is name of file format.
- @p option_keys is name of options to set.
- @p option_values is values for named options.
- @p cancellable is optional GCancellable object, NULL to ignore.
- @r TRUE if the pixbuf was saved successfully, FALSE if an error was set..
save_to_streamv_async (object stream, string type, list option_keys, list option_values, object cancellable, user_data)

Saves pixbuf to an output stream asynchronously. For more details see gdk_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 gdk_pixbuf_save_to_stream_finish() to get the result of the operation.
- @p stream is a GOutputStream to which to save the pixbuf.
- @p type is name of file format.
- @p option_keys is name of options to set.
- @p option_values is values for named options.
- @p cancellable is optional GCancellable object, NULL to ignore.
- @p callback is a GAsyncReadyCallback to call when the pixbuf is saved.
- @p user_data is the data to pass to the callback function.
- @r None.
savev (string filename, string type, list option_keys, list option_values)

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.
- @p filename is name of file to save..
- @p type is name of file format..
- @p option_keys is name of options to set.
- @p option_values is values for named options.
- @r whether an error was set.
scale (object dest, int dest_x, int dest_y, int dest_width, int dest_height, double offset_x, double offset_y, double scale_x, double scale_y, string interp_type)

Creates a transformation of the source image @src 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 gdk_pixbuf_scale_simple() first; this function is the industrial-strength power tool you can fall back to, if gdk_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.
- @p dest is the #GdkPixbuf into which to render the results.
- @p dest_x is the left coordinate for region to render.
- @p dest_y is the top coordinate for region to render.
- @p dest_width is the width of the region to render.
- @p dest_height is the height of the region to render.
- @p offset_x is the offset in the X direction (currently rounded to an integer).
- @p offset_y is the offset in the Y direction (currently rounded to an integer).
- @p scale_x is the scale factor in the X direction.
- @p scale_y is the scale factor in the Y direction.
- @p interp_type is the interpolation type for the transformation..
- @r None.
scale_simple (int dest_width, int dest_height, string interp_type)

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].
- @p dest_width is the width of destination image.
- @p dest_height is the height of destination image.
- @p interp_type is the interpolation type for the transformation..
- @r the new pixbuf.
set_option (string key, string value)

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.
- @p key is a nul-terminated string..
- @p value is a nul-terminated string..
- @r TRUE on success.
unref ()

Removes a reference from a pixbuf.
- @r None.
options ()

Returns get_options as an Aussom map. This companion materializes the full hash table up front; use get_options() for the raw native GHashTable handle.
- @r An Aussom map of the hash table entries.

class: GdkPixbufCtors

[1051:14] static extends: object

Alternate constructors for GdkPixbuf. Usage: GdkPixbufCtors.<name>(...). The primary constructor lives directly on GdkPixbuf.

Methods

newFromBytes (object data, string colorspace, bool has_alpha, int bits_per_sample, int width, int height, int rowstride)

Creates a new #GdkPixbuf out of in-memory readonly image data. Currently only RGB images with 8 bits per sample are supported. This is the GBytes variant of gdk_pixbuf_new_from_data(), useful for language bindings.
- @p data is Image data in 8-bit/sample packed format inside a #GBytes.
- @p colorspace is Colorspace for the image data.
- @p has_alpha is Whether the data has an opacity channel.
- @p bits_per_sample is Number of bits per sample.
- @p width is Width of the image in pixels, must be > 0.
- @p height is Height of the image in pixels, must be > 0.
- @p rowstride is Distance in bytes between row starts.
- @r A new GdkPixbuf.
newFromData (list data, string colorspace, bool has_alpha, int bits_per_sample, int width, int height, int rowstride, object destroy_fn)

Creates a new #GdkPixbuf 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]
- @p data is Image data in 8-bit/sample packed format.
- @p colorspace is Colorspace for the image data.
- @p has_alpha is Whether the data has an opacity channel.
- @p bits_per_sample is Number of bits per sample.
- @p width is Width of the image in pixels, must be > 0.
- @p height is Height of the image in pixels, must be > 0.
- @p rowstride is Distance in bytes between row starts.
- @p destroy_fn is Function used to free the data when the pixbuf's reference count drops to zero, or NULL if the data should not be freed.
- @p destroy_fn_data is Closure data to pass to the destroy notification function.
- @r A new GdkPixbuf.
newFromFile (string filename)

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.
- @p filename is Name of file to load, in the GLib file name encoding.
- @r A new GdkPixbuf.
newFromFileAtScale (string filename, int width, int height, bool preserve_aspect_ratio)

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.
- @p filename is Name of file to load, in the GLib file name encoding.
- @p width is The width the image should have or -1 to not constrain the width.
- @p height is The height the image should have or -1 to not constrain the height.
- @p preserve_aspect_ratio is TRUE to preserve the image's aspect ratio.
- @r A new GdkPixbuf.
newFromFileAtSize (string filename, int width, int height)

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].
- @p filename is Name of file to load, in the GLib file name encoding.
- @p width is The width the image should have or -1 to not constrain the width.
- @p height is The height the image should have or -1 to not constrain the height.
- @r A new GdkPixbuf.
newFromInline (list data, bool copy_pixels)

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 ships with a program called 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 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.
- @p data_length is Length in bytes of the data argument or -1 to disable length checks.
- @p data is Byte data containing a serialized GdkPixdata structure.
- @p copy_pixels is Whether to copy the pixel data, or use direct pointers data for the resulting pixbuf.
- @r A new GdkPixbuf.
newFromResource (string resource_path)

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.
- @p resource_path is the path of the resource file.
- @r A new GdkPixbuf.
newFromResourceAtScale (string resource_path, int width, int height, bool preserve_aspect_ratio)

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.
- @p resource_path is the path of the resource file.
- @p width is The width the image should have or -1 to not constrain the width.
- @p height is The height the image should have or -1 to not constrain the height.
- @p preserve_aspect_ratio is TRUE to preserve the image's aspect ratio.
- @r A new GdkPixbuf.
newFromStream (object stream, object cancellable)

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.
- @p stream is a GInputStream to load the pixbuf from.
- @p cancellable is optional GCancellable object, NULL to ignore.
- @r A new GdkPixbuf.
newFromStreamAtScale (object stream, int width, int height, bool preserve_aspect_ratio, object cancellable)

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.
- @p stream is a GInputStream to load the pixbuf from.
- @p width is The width the image should have or -1 to not constrain the width.
- @p height is The height the image should have or -1 to not constrain the height.
- @p preserve_aspect_ratio is TRUE to preserve the image's aspect ratio.
- @p cancellable is optional GCancellable object, NULL to ignore.
- @r A new GdkPixbuf.
newFromStreamFinish (object async_result)

Finishes an asynchronous pixbuf creation operation started with gdk_pixbuf_new_from_stream_async().
- @p async_result is a GAsyncResult.
- @r A new GdkPixbuf.
newFromXpmData (list data)

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.
- @p data is Pointer to inline XPM data..
- @r A new GdkPixbuf.

class: GdkPixbufMeta

[1371:14] static extends: object

Generated metadata helpers for Pixbuf class surfaces.

Methods

properties ()

Returns property metadata for Pixbuf.
- @r A list.