This enumeration defines the color spaces that are supported by the gdk-pixbuf library. Currently only RGB is supported. Indicates a red/green/blue additive color space. Interpolation modes for scaling functions. The `GDK_INTERP_NEAREST` mode is the fastest scaling method, but has horrible quality when scaling down; `GDK_INTERP_BILINEAR` is the best choice if you aren't sure what to choose, it has a good speed/quality balance. **Note**: Cubic filtering is missing from the list; hyperbolic interpolation is just as fast and results in higher quality. Nearest neighbor sampling; this is the fastest and lowest quality mode. Quality is normally unacceptable when scaling down, but may be OK when scaling up. This is an accurate simulation of the PostScript image operator without any interpolation enabled. Each pixel is rendered as a tiny parallelogram of solid color, the edges of which are implemented with antialiasing. It resembles nearest neighbor for enlargement, and bilinear for reduction. Best quality/speed balance; use this mode by default. Bilinear interpolation. For enlargement, it is equivalent to point-sampling the ideal bilinear-interpolated image. For reduction, it is equivalent to laying down small tiles and integrating over the coverage area. This is the slowest and highest quality reconstruction function. It is derived from the hyperbolic filters in Wolberg's "Digital Image Warping", and is formally defined as the hyperbolic-filter sampling the ideal hyperbolic-filter interpolated image (the filter is designed to be idempotent for 1:1 pixel mapping). **Deprecated**: this interpolation filter is deprecated, as in reality it has a lower quality than the @GDK_INTERP_BILINEAR filter (Since: 2.38) Macro to test the version of GdkPixbuf being compiled against. major version (e.g. 2 for version 2.34.0) minor version (e.g. 34 for version 2.34.0) micro version (e.g. 0 for version 2.34.0) Major version of gdk-pixbuf library, that is the "0" in "0.8.2" for example. Micro version of gdk-pixbuf library, that is the "2" in "0.8.2" for example. Minor version of gdk-pixbuf library, that is the "8" in "0.8.2" for example. Contains the full version of GdkPixbuf as a string. This is the version being compiled against; contrast with `gdk_pixbuf_version`. 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. 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, 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 `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. 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. A newly-created pixel buffer Color space for image Whether the image should have transparency information Number of bits per color sample Width of image in pixels, must be > 0 Height of image in pixels, must be > 0 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. A newly-created pixbuf Image data in 8-bit/sample packed format inside a #GBytes Colorspace for the image data Whether the data has an opacity channel Number of bits per sample Width of the image in pixels, must be > 0 Height of the image in pixels, must be > 0 Distance in bytes between row starts 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] A newly-created pixbuf Image data in 8-bit/sample packed format Colorspace for the image data Whether the data has an opacity channel Number of bits per sample Width of the image in pixels, must be > 0 Height of the image in pixels, must be > 0 Distance in bytes between row starts Function used to free the data when the pixbuf's reference count drops to zero, or %NULL if the data should not be freed Closure data to pass to the destroy notification function 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`. A newly-created pixbuf Name of file to load, in the GLib file name encoding 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. A newly-created pixbuf Name of file to load, in the GLib file name encoding The width the image should have or -1 to not constrain the width The height the image should have or -1 to not constrain the height `TRUE` to preserve the image's 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, 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]. A newly-created pixbuf Name of file to load, in the GLib file name encoding The width the image should have or -1 to not constrain the width The height the image should have or -1 to not constrain the height 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 `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. Use `GResource` instead. A newly-created pixbuf Length in bytes of the `data` argument or -1 to disable length checks Byte data containing a serialized `GdkPixdata` structure Whether to copy the pixel data, or use direct pointers `data` for the resulting pixbuf 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. A newly-created pixbuf the path of the resource file 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. A newly-created pixbuf the path of the resource file The width the image should have or -1 to not constrain the width The height the image should have or -1 to not constrain the height `TRUE` to preserve the image's aspect ratio 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. A newly-created pixbuf a `GInputStream` to load the pixbuf from optional `GCancellable` object, `NULL` to ignore 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. A newly-created pixbuf a `GInputStream` to load the pixbuf from The width the image should have or -1 to not constrain the width The height the image should have or -1 to not constrain the height `TRUE` to preserve the image's aspect ratio optional `GCancellable` object, `NULL` to ignore Finishes an asynchronous pixbuf creation operation started with gdk_pixbuf_new_from_stream_async(). the newly created pixbuf a `GAsyncResult` 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. A newly-created pixbuf Pointer to inline XPM data. 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`. the rowstride for the given values, or -1 in case of error. Color space for image Whether the image should have transparency information Number of bits per color sample Width of image in pixels, must be > 0 Height of image in pixels, must be > 0 Parses an image file far enough to determine its format and size. A `GdkPixbufFormat` describing the image format of the file The name of the file to identify. Return location for the width of the image Return location for the height of the image Asynchronously parses an image file far enough to determine its format and size. For more details see gdk_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 gdk_pixbuf_get_file_info_finish() to get the result of the operation. The name of the file to identify optional `GCancellable` object, `NULL` to ignore a `GAsyncReadyCallback` to call when the file info is available the data to pass to the callback function Finishes an asynchronous pixbuf parsing operation started with gdk_pixbuf_get_file_info_async(). A `GdkPixbufFormat` describing the image format of the file a `GAsyncResult` Return location for the width of the image, or `NULL` Return location for the height of the image, or `NULL` Obtains the available information about the image formats supported by GdkPixbuf. A list of support image formats. 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. Path to directory where the `loaders.cache` is installed Creates a new pixbuf by asynchronously loading an image from an input stream. For more details see gdk_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 gdk_pixbuf_new_from_stream_finish() to get the result of the operation. a `GInputStream` from which to load the pixbuf optional `GCancellable` object, `NULL` to ignore a `GAsyncReadyCallback` to call when the pixbuf is loaded 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 gdk_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 gdk_pixbuf_new_from_stream_finish() to get the result of the operation. a `GInputStream` from which to load the pixbuf the width the image should have or -1 to not constrain the width the height the image should have or -1 to not constrain the height `TRUE` to preserve the image's aspect ratio optional `GCancellable` object, `NULL` to ignore a `GAsyncReadyCallback` to call when the pixbuf is loaded the data to pass to the callback function Finishes an asynchronous pixbuf save operation started with gdk_pixbuf_save_to_stream_async(). `TRUE` if the pixbuf was saved successfully, `FALSE` if an error was set. a `GAsyncResult` 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. A newly-created pixbuf A #GdkPixbuf. Whether to set a color to zero opacity. Red value to substitute. Green value to substitute. Blue value to substitute. 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. A newly-created pixbuf a pixbuf with an orientation option 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. ![](composite.png) a #GdkPixbuf the #GdkPixbuf into which to render the results the left coordinate for region to render the top coordinate for region to render the width of the region to render the height of the region to render the offset in the X direction (currently rounded to an integer) the offset in the Y direction (currently rounded to an integer) the scale factor in the X direction the scale factor in the Y direction the interpolation type for the transformation. overall alpha for source image (0..255) 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. a #GdkPixbuf the #GdkPixbuf into which to render the results the left coordinate for region to render the top coordinate for region to render the width of the region to render the height of the region to render the offset in the X direction (currently rounded to an integer) the offset in the Y direction (currently rounded to an integer) the scale factor in the X direction the scale factor in the Y direction the interpolation type for the transformation. overall alpha for source image (0..255) the X offset for the checkboard (origin of checkboard is at -@check_x, -@check_y) the Y offset for the checkboard the size of checks in the checkboard (must be a power of two) the color of check at upper left the color of the other check 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`. the new pixbuf a #GdkPixbuf the width of destination image the height of destination image the interpolation type for the transformation. overall alpha for source image (0..255) the size of checks in the checkboard (must be a power of two) the color of check at upper left the color of the other check 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. A newly-created pixbuf A 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. Source pixbuf. Source X coordinate within @src_pixbuf. Source Y coordinate within @src_pixbuf. Width of the area to copy. Height of the area to copy. Destination pixbuf. X coordinate within @dest_pixbuf. Y coordinate within @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. `TRUE` on success. the source pixbuf the destination pixbuf 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. a `GdkPixbuf` RGBA pixel to used to clear (`0xffffffff` is opaque white, `0x00000000` transparent black) Flips a pixbuf horizontally or vertically and returns the result in a new pixbuf. the new pixbuf a #GdkPixbuf `TRUE` to flip horizontally, `FALSE` to flip vertically Queries the number of bits per color sample in a pixbuf. Number of bits per color sample. A pixbuf. Returns the length of the pixel data, in bytes. The length of the pixel data. A pixbuf Queries the color space of a pixbuf. Color space. A pixbuf. Queries whether a pixbuf has an alpha channel (opacity information). `TRUE` if it has an alpha channel, `FALSE` otherwise. A pixbuf. Queries the height of a pixbuf. Height in pixels. A pixbuf. Queries the number of channels of a pixbuf. Number of channels. 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 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. the value associated with `key` a `GdkPixbuf` a nul-terminated string. 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]. a #GHashTable of key/values pairs a `GdkPixbuf` 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](class.Pixbuf.html#image-data) for information about how the pixel data is stored in memory. A pointer to the pixbuf's pixel data. A pixbuf. 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](class.Pixbuf.html#image-data) for information about how the pixel data is stored in memory. A pointer to the pixbuf's pixel data. A pixbuf. The length of the binary data. 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. Distance between row starts. A pixbuf. Queries the width of a pixbuf. Width in pixels. A 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. a new pixbuf a `GdkPixbuf` X coord in @src_pixbuf Y coord in @src_pixbuf width of region in @src_pixbuf height of region in @src_pixbuf 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. 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. A pixbuf 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. a read-only pointer to the raw pixel data A pixbuf Adds a reference to a pixbuf. Use g_object_ref(). The same as the @pixbuf argument. A pixbuf. Removes the key/value pair option attached to a `GdkPixbuf`. `TRUE` if an option was removed, `FALSE` if not. a `GdkPixbuf` a nul-terminated string representing the key to remove. 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`. the new pixbuf a #GdkPixbuf the angle to rotate by 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. source image place to write modified version of @src saturation factor whether to pixelate 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. `TRUE` on success, and `FALSE` otherwise a `GdkPixbuf`. name of file to save. name of file format. return location for error list of key-value save options, followed by `NULL` 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. whether an error was set a `GdkPixbuf`. location to receive a pointer to the new buffer. location to receive the size of the new buffer. name of file format. return location for error, or `NULL` list of key-value save options 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. whether an error was set a `GdkPixbuf`. location to receive a pointer to the new buffer. location to receive the size of the new buffer. name of file format. name of options to set values for named options 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. whether an error was set a `GdkPixbuf`. a function that is called to save each block of data that the save routine generates. user data to pass to the save function. name of file format. return location for error, or `NULL` list of key-value save options 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. whether an error was set a `GdkPixbuf`. a function that is called to save each block of data that the save routine generates. user data to pass to the save function. name of file format. name of options to set values for named options 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. `TRUE` if the pixbuf was saved successfully, `FALSE` if an error was set. a `GdkPixbuf` a `GOutputStream` to save the pixbuf to name of file format optional `GCancellable` object, `NULL` to ignore return location for error, or `NULL` list of key-value save options 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. a `GdkPixbuf` a `GOutputStream` to which to save the pixbuf name of file format optional `GCancellable` object, `NULL` to ignore a `GAsyncReadyCallback` to call when the pixbuf is saved the data to pass to the callback function list of key-value save options 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. `TRUE` if the pixbuf was saved successfully, `FALSE` if an error was set. a `GdkPixbuf` a `GOutputStream` to save the pixbuf to name of file format name of options to set values for named options optional `GCancellable` object, `NULL` to ignore 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. a `GdkPixbuf` a `GOutputStream` to which to save the pixbuf name of file format name of options to set values for named options optional `GCancellable` object, `NULL` to ignore a `GAsyncReadyCallback` to call when the pixbuf is saved the data to pass to the callback function 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. whether an error was set a `GdkPixbuf`. name of file to save. name of file format. name of options to set values for named options 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. a #GdkPixbuf the #GdkPixbuf into which to render the results the left coordinate for region to render the top coordinate for region to render the width of the region to render the height of the region to render the offset in the X direction (currently rounded to an integer) the offset in the Y direction (currently rounded to an integer) the scale factor in the X direction the scale factor in the Y direction the interpolation type for the transformation. 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]. the new pixbuf a #GdkPixbuf the width of destination image the height of destination image the interpolation type for the transformation. 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. `TRUE` on success a `GdkPixbuf` a nul-terminated string. a nul-terminated string. Removes a reference from a pixbuf. Use g_object_unref(). A pixbuf. The number of bits per sample. Currently only 8 bit per sample are supported. The color space of the pixbuf. Currently, only `GDK_COLORSPACE_RGB` is supported. Whether the pixbuf has an alpha channel. The number of rows of the pixbuf. The number of samples per pixel. Currently, only 3 or 4 samples per pixel are supported. A pointer to the pixel data of the pixbuf. 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. The number of columns of the pixbuf. Control the alpha channel for drawables. These values can be passed to gdk_pixbuf_xlib_render_to_drawable_alpha() in gdk-pixbuf-xlib to control how the alpha channel of an image should be handled. This function can create a bilevel clipping mask (black and white) and use it while painting the image. In the future, when the X Window System gets an alpha channel extension, it will be possible to do full alpha compositing onto arbitrary drawables. For now both cases fall back to a bilevel clipping mask. There is no user of GdkPixbufAlphaMode in GdkPixbuf, and the Xlib utility functions have been split out to their own library, gdk-pixbuf-xlib A bilevel clipping mask (black and white) will be created and used to draw the image. Pixels below 0.5 opacity will be considered fully transparent, and all others will be considered fully opaque. For now falls back to #GDK_PIXBUF_ALPHA_BILEVEL. In the future it will do full alpha compositing. An opaque object representing an animation. The GdkPixBuf library provides a simple mechanism to load and represent animations. An animation is conceptually a series of frames to be displayed over time. The animation may not be represented as a series of frames internally; for example, it may be stored as a sprite and instructions for moving the sprite around a background. To display an animation you don't need to understand its representation, however; you just ask `GdkPixbuf` what should be displayed at a given point in time. Creates a new animation by loading it from a file. The file format is detected automatically. If the file's format does not support multi-frame images, then an animation with a single frame will be created. Possible errors are in the `GDK_PIXBUF_ERROR` and `G_FILE_ERROR` domains. A newly-created animation Name of file to load, in the GLib file name encoding Creates a new pixbuf animation by loading an image from an resource. The file format is detected automatically. If `NULL` is returned, then @error will be set. A newly-created animation the path of the resource file Creates a new animation by loading it 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. A newly-created animation a `GInputStream` to load the pixbuf from optional `GCancellable` object Finishes an asynchronous pixbuf animation creation operation started with [func@GdkPixbuf.PixbufAnimation.new_from_stream_async]. the newly created animation a #GAsyncResult Creates a new animation by asynchronously loading an image from an input stream. For more details see gdk_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 gdk_pixbuf_animation_new_from_stream_finish() to get the result of the operation. a #GInputStream from which to load the animation optional #GCancellable object a `GAsyncReadyCallback` to call when the pixbuf is loaded the data to pass to the callback function Get an iterator for displaying an animation. The iterator provides the frames that should be displayed at a given time. @start_time would normally come from g_get_current_time(), and marks the beginning of animation playback. After creating an iterator, you should immediately display the pixbuf returned by gdk_pixbuf_animation_iter_get_pixbuf(). Then, you should install a timeout (with g_timeout_add()) or by some other mechanism ensure that you'll update the image after gdk_pixbuf_animation_iter_get_delay_time() milliseconds. Each time the image is updated, you should reinstall the timeout with the new, possibly-changed delay time. As a shortcut, if @start_time is `NULL`, the result of g_get_current_time() will be used automatically. To update the image (i.e. possibly change the result of gdk_pixbuf_animation_iter_get_pixbuf() to a new frame of the animation), call gdk_pixbuf_animation_iter_advance(). If you're using #GdkPixbufLoader, in addition to updating the image after the delay time, you should also update it whenever you receive the area_updated signal and gdk_pixbuf_animation_iter_on_currently_loading_frame() returns `TRUE`. In this case, the frame currently being fed into the loader has received new data, so needs to be refreshed. The delay time for a frame may also be modified after an area_updated signal, for example if the delay time for a frame is encoded in the data after the frame itself. So your timeout should be reinstalled after any area_updated signal. A delay time of -1 is possible, indicating "infinite". an iterator to move over the animation a #GdkPixbufAnimation time when the animation starts playing fills @width and @height with the frame size of the animation. Retrieves a static image for the animation. If an animation is really just a plain image (has only one frame), this function returns that image. If the animation is an animation, this function returns a reasonable image to use as a static unanimated image, which might be the first frame, or something more sophisticated depending on the file format. If an animation hasn't loaded any frames yet, this function will return `NULL`. unanimated image representing the animation a #GdkPixbufAnimation Checks whether the animation is a static image. If you load a file with gdk_pixbuf_animation_new_from_file() and it turns out to be a plain, unanimated image, then this function will return `TRUE`. Use gdk_pixbuf_animation_get_static_image() to retrieve the image. `TRUE` if the "animation" was really just an image a #GdkPixbufAnimation Queries the height of the bounding box of a pixbuf animation. Height of the bounding box of the animation. An animation. Get an iterator for displaying an animation. The iterator provides the frames that should be displayed at a given time. @start_time would normally come from g_get_current_time(), and marks the beginning of animation playback. After creating an iterator, you should immediately display the pixbuf returned by gdk_pixbuf_animation_iter_get_pixbuf(). Then, you should install a timeout (with g_timeout_add()) or by some other mechanism ensure that you'll update the image after gdk_pixbuf_animation_iter_get_delay_time() milliseconds. Each time the image is updated, you should reinstall the timeout with the new, possibly-changed delay time. As a shortcut, if @start_time is `NULL`, the result of g_get_current_time() will be used automatically. To update the image (i.e. possibly change the result of gdk_pixbuf_animation_iter_get_pixbuf() to a new frame of the animation), call gdk_pixbuf_animation_iter_advance(). If you're using #GdkPixbufLoader, in addition to updating the image after the delay time, you should also update it whenever you receive the area_updated signal and gdk_pixbuf_animation_iter_on_currently_loading_frame() returns `TRUE`. In this case, the frame currently being fed into the loader has received new data, so needs to be refreshed. The delay time for a frame may also be modified after an area_updated signal, for example if the delay time for a frame is encoded in the data after the frame itself. So your timeout should be reinstalled after any area_updated signal. A delay time of -1 is possible, indicating "infinite". an iterator to move over the animation a #GdkPixbufAnimation time when the animation starts playing Retrieves a static image for the animation. If an animation is really just a plain image (has only one frame), this function returns that image. If the animation is an animation, this function returns a reasonable image to use as a static unanimated image, which might be the first frame, or something more sophisticated depending on the file format. If an animation hasn't loaded any frames yet, this function will return `NULL`. unanimated image representing the animation a #GdkPixbufAnimation Queries the width of the bounding box of a pixbuf animation. Width of the bounding box of the animation. An animation. Checks whether the animation is a static image. If you load a file with gdk_pixbuf_animation_new_from_file() and it turns out to be a plain, unanimated image, then this function will return `TRUE`. Use gdk_pixbuf_animation_get_static_image() to retrieve the image. `TRUE` if the "animation" was really just an image a #GdkPixbufAnimation Adds a reference to an animation. Use g_object_ref(). The same as the @animation argument. An animation. Removes a reference from an animation. Use g_object_unref(). An animation. Modules supporting animations must derive a type from #GdkPixbufAnimation, providing suitable implementations of the virtual functions. the parent class returns whether the given animation is just a static image. `TRUE` if the "animation" was really just an image a #GdkPixbufAnimation returns a static image representing the given animation. unanimated image representing the animation a #GdkPixbufAnimation fills @width and @height with the frame size of the animation. returns an iterator for the given animation. an iterator to move over the animation a #GdkPixbufAnimation time when the animation starts playing An opaque object representing an iterator which points to a certain position in an animation. Possibly advances an animation to a new frame. Chooses the frame based on the start time passed to gdk_pixbuf_animation_get_iter(). @current_time would normally come from g_get_current_time(), and must be greater than or equal to the time passed to gdk_pixbuf_animation_get_iter(), and must increase or remain unchanged each time gdk_pixbuf_animation_iter_get_pixbuf() is called. That is, you can't go backward in time; animations only play forward. As a shortcut, pass `NULL` for the current time and g_get_current_time() will be invoked on your behalf. So you only need to explicitly pass @current_time if you're doing something odd like playing the animation at double speed. If this function returns `FALSE`, there's no need to update the animation display, assuming the display had been rendered prior to advancing; if `TRUE`, you need to call gdk_pixbuf_animation_iter_get_pixbuf() and update the display with the new pixbuf. `TRUE` if the image may need updating a #GdkPixbufAnimationIter current time Gets the number of milliseconds the current pixbuf should be displayed, or -1 if the current pixbuf should be displayed forever. The `g_timeout_add()` function conveniently takes a timeout in milliseconds, so you can use a timeout to schedule the next update. Note that some formats, like GIF, might clamp the timeout values in the image file to avoid updates that are just too quick. The minimum timeout for GIF images is currently 20 milliseconds. delay time in milliseconds (thousandths of a second) an animation iterator Gets the current pixbuf which should be displayed. The pixbuf might not be the same size as the animation itself (gdk_pixbuf_animation_get_width(), gdk_pixbuf_animation_get_height()). This pixbuf should be displayed for gdk_pixbuf_animation_iter_get_delay_time() milliseconds. The caller of this function does not own a reference to the returned pixbuf; the returned pixbuf will become invalid when the iterator advances to the next frame, which may happen anytime you call gdk_pixbuf_animation_iter_advance(). Copy the pixbuf to keep it (don't just add a reference), as it may get recycled as you advance the iterator. the pixbuf to be displayed an animation iterator Used to determine how to respond to the area_updated signal on #GdkPixbufLoader when loading an animation. The `::area_updated` signal is emitted for an area of the frame currently streaming in to the loader. So if you're on the currently loading frame, you will need to redraw the screen for the updated area. `TRUE` if the frame we're on is partially loaded, or the last frame a #GdkPixbufAnimationIter Possibly advances an animation to a new frame. Chooses the frame based on the start time passed to gdk_pixbuf_animation_get_iter(). @current_time would normally come from g_get_current_time(), and must be greater than or equal to the time passed to gdk_pixbuf_animation_get_iter(), and must increase or remain unchanged each time gdk_pixbuf_animation_iter_get_pixbuf() is called. That is, you can't go backward in time; animations only play forward. As a shortcut, pass `NULL` for the current time and g_get_current_time() will be invoked on your behalf. So you only need to explicitly pass @current_time if you're doing something odd like playing the animation at double speed. If this function returns `FALSE`, there's no need to update the animation display, assuming the display had been rendered prior to advancing; if `TRUE`, you need to call gdk_pixbuf_animation_iter_get_pixbuf() and update the display with the new pixbuf. `TRUE` if the image may need updating a #GdkPixbufAnimationIter current time Gets the number of milliseconds the current pixbuf should be displayed, or -1 if the current pixbuf should be displayed forever. The `g_timeout_add()` function conveniently takes a timeout in milliseconds, so you can use a timeout to schedule the next update. Note that some formats, like GIF, might clamp the timeout values in the image file to avoid updates that are just too quick. The minimum timeout for GIF images is currently 20 milliseconds. delay time in milliseconds (thousandths of a second) an animation iterator Gets the current pixbuf which should be displayed. The pixbuf might not be the same size as the animation itself (gdk_pixbuf_animation_get_width(), gdk_pixbuf_animation_get_height()). This pixbuf should be displayed for gdk_pixbuf_animation_iter_get_delay_time() milliseconds. The caller of this function does not own a reference to the returned pixbuf; the returned pixbuf will become invalid when the iterator advances to the next frame, which may happen anytime you call gdk_pixbuf_animation_iter_advance(). Copy the pixbuf to keep it (don't just add a reference), as it may get recycled as you advance the iterator. the pixbuf to be displayed an animation iterator Used to determine how to respond to the area_updated signal on #GdkPixbufLoader when loading an animation. The `::area_updated` signal is emitted for an area of the frame currently streaming in to the loader. So if you're on the currently loading frame, you will need to redraw the screen for the updated area. `TRUE` if the frame we're on is partially loaded, or the last frame a #GdkPixbufAnimationIter Modules supporting animations must derive a type from #GdkPixbufAnimationIter, providing suitable implementations of the virtual functions. the parent class returns the time in milliseconds that the current frame should be shown. delay time in milliseconds (thousandths of a second) an animation iterator returns the current frame. the pixbuf to be displayed an animation iterator returns whether the current frame of @iter is being loaded. `TRUE` if the frame we're on is partially loaded, or the last frame a #GdkPixbufAnimationIter advances the iterator to @current_time, possibly changing the current frame. `TRUE` if the image may need updating a #GdkPixbufAnimationIter current time A function of this type is responsible for freeing the pixel array of a pixbuf. The gdk_pixbuf_new_from_data() function lets you pass in a pre-allocated pixel array so that a pixbuf can be created from it; in this case you will need to pass in a function of type `GdkPixbufDestroyNotify` so that the pixel data can be freed when the pixbuf is finalized. The pixel array of the pixbuf that is being finalized. User closure data. An error code in the `GDK_PIXBUF_ERROR` domain. Many gdk-pixbuf operations can cause errors in this domain, or in the `G_FILE_ERROR` domain. An image file was broken somehow. Not enough memory. A bad option was passed to a pixbuf save module. Unknown image type. Don't know how to perform the given operation on the type of image at hand. Generic failure code, something went wrong. Only part of the animation was loaded. A `GdkPixbufFormat` contains information about the image format accepted by a module. Only modules should access the fields directly, applications should use the `gdk_pixbuf_format_*` family of functions. the name of the image format the signature of the module the message domain for the `description` a description of the image format the MIME types for the image format typical filename extensions for the image format a combination of `GdkPixbufFormatFlags` a boolean determining whether the loader is disabled` a string containing license information, typically set to shorthands like "GPL", "LGPL", etc. Creates a copy of `format`. the newly allocated copy of a `GdkPixbufFormat`. Use gdk_pixbuf_format_free() to free the resources when done a pixbuf format Frees the resources allocated when copying a `GdkPixbufFormat` using gdk_pixbuf_format_copy() a pixbuf format Returns a description of the format. a description of the format. a `GdkPixbufFormat` Returns the filename extensions typically used for files in the given format. an array of filename extensions a `GdkPixbufFormat` Returns information about the license of the image loader for the format. The returned string should be a shorthand for a well known license, e.g. "LGPL", "GPL", "QPL", "GPL/QPL", or "other" to indicate some other license. a string describing the license of the pixbuf format a pixbuf format Returns the mime types supported by the format. an array of mime types a `GdkPixbufFormat` Returns the name of the format. the name of the format. a `GdkPixbufFormat` Returns whether this image format is disabled. See gdk_pixbuf_format_set_disabled(). whether this image format is disabled. a `GdkPixbufFormat` Returns `TRUE` if the save option specified by @option_key is supported when saving a pixbuf using the module implementing @format. See gdk_pixbuf_save() for more information about option keys. `TRUE` if the specified option is supported a pixbuf format the name of an option Returns whether this image format is scalable. If a file is in a scalable format, it is preferable to load it at the desired size, rather than loading it at the default size and scaling the resulting pixbuf to the desired size. whether this image format is scalable. a `GdkPixbufFormat` Returns whether pixbufs can be saved in the given format. whether pixbufs can be saved in the given format. a `GdkPixbufFormat` Disables or enables an image format. If a format is disabled, GdkPixbuf won't use the image loader for this format to load images. Applications can use this to avoid using image loaders with an inappropriate license, see gdk_pixbuf_format_get_license(). a `GdkPixbufFormat` `TRUE` to disable the format @format Flags which allow a module to specify further details about the supported operations. the module can write out images in the format. the image format is scalable the module is threadsafe. gdk-pixbuf ignores modules that are not marked as threadsafe. (Since 2.28). Incremental image loader. `GdkPixbufLoader` provides a way for applications to drive the process of loading an image, by letting them send the image data directly to the loader instead of having the loader read the data from a file. Applications can use this functionality instead of `gdk_pixbuf_new_from_file()` or `gdk_pixbuf_animation_new_from_file()` when they need to parse image data in small chunks. For example, it should be used when reading an image from a (potentially) slow network connection, or when loading an extremely large file. To use `GdkPixbufLoader` to load an image, create a new instance, and call [method@GdkPixbuf.PixbufLoader.write] to send the data to it. When done, [method@GdkPixbuf.PixbufLoader.close] should be called to end the stream and finalize everything. The loader will emit three important signals throughout the process: - [signal@GdkPixbuf.PixbufLoader::size-prepared] will be emitted as soon as the image has enough information to determine the size of the image to be used. If you want to scale the image while loading it, you can call [method@GdkPixbuf.PixbufLoader.set_size] in response to this signal. - [signal@GdkPixbuf.PixbufLoader::area-prepared] will be emitted as soon as the pixbuf of the desired has been allocated. You can obtain the `GdkPixbuf` instance by calling [method@GdkPixbuf.PixbufLoader.get_pixbuf]. If you want to use it, simply acquire a reference to it. You can also call `gdk_pixbuf_loader_get_pixbuf()` later to get the same pixbuf. - [signal@GdkPixbuf.PixbufLoader::area-updated] will be emitted every time a region is updated. This way you can update a partially completed image. Note that you do not know anything about the completeness of an image from the updated area. For example, in an interlaced image you will need to make several passes before the image is done loading. ## Loading an animation Loading an animation is almost as easy as loading an image. Once the first [signal@GdkPixbuf.PixbufLoader::area-prepared] signal has been emitted, you can call [method@GdkPixbuf.PixbufLoader.get_animation] to get the [class@GdkPixbuf.PixbufAnimation] instance, and then call and [method@GdkPixbuf.PixbufAnimation.get_iter] to get a [class@GdkPixbuf.PixbufAnimationIter] to retrieve the pixbuf for the desired time stamp. Creates a new pixbuf loader object. A newly-created pixbuf loader. Creates a new pixbuf loader object that always attempts to parse image data as if it were an image of MIME type @mime_type, instead of identifying the type automatically. This function is useful if you want an error if the image isn't the expected MIME type; for loading image formats that can't be reliably identified by looking at the data; or if the user manually forces a specific MIME type. The list of supported mime types depends on what image loaders are installed, but typically "image/png", "image/jpeg", "image/gif", "image/tiff" and "image/x-xpixmap" are among the supported mime types. To obtain the full list of supported mime types, call gdk_pixbuf_format_get_mime_types() on each of the #GdkPixbufFormat structs returned by gdk_pixbuf_get_formats(). A newly-created pixbuf loader. the mime type to be loaded Creates a new pixbuf loader object that always attempts to parse image data as if it were an image of type @image_type, instead of identifying the type automatically. This function is useful if you want an error if the image isn't the expected type; for loading image formats that can't be reliably identified by looking at the data; or if the user manually forces a specific type. The list of supported image formats depends on what image loaders are installed, but typically "png", "jpeg", "gif", "tiff" and "xpm" are among the supported formats. To obtain the full list of supported image formats, call gdk_pixbuf_format_get_name() on each of the #GdkPixbufFormat structs returned by gdk_pixbuf_get_formats(). A newly-created pixbuf loader. name of the image format to be loaded with the image Informs a pixbuf loader that no further writes with gdk_pixbuf_loader_write() will occur, so that it can free its internal loading structures. This function also tries to parse any data that hasn't yet been parsed; if the remaining data is partial or corrupt, an error will be returned. If `FALSE` is returned, `error` will be set to an error from the `GDK_PIXBUF_ERROR` or `G_FILE_ERROR` domains. If you're just cancelling a load rather than expecting it to be finished, passing `NULL` for `error` to ignore it is reasonable. Remember that this function does not release a reference on the loader, so you will need to explicitly release any reference you hold. `TRUE` if all image data written so far was successfully passed out via the update_area signal A pixbuf loader. Queries the #GdkPixbufAnimation that a pixbuf loader is currently creating. In general it only makes sense to call this function after the [signal@GdkPixbuf.PixbufLoader::area-prepared] signal has been emitted by the loader. If the loader doesn't have enough bytes yet, and hasn't emitted the `area-prepared` signal, this function will return `NULL`. The animation that the loader is currently loading A pixbuf loader Obtains the available information about the format of the currently loading image file. A #GdkPixbufFormat A pixbuf loader. Queries the #GdkPixbuf that a pixbuf loader is currently creating. In general it only makes sense to call this function after the [signal@GdkPixbuf.PixbufLoader::area-prepared] signal has been emitted by the loader; this means that enough data has been read to know the size of the image that will be allocated. If the loader has not received enough data via gdk_pixbuf_loader_write(), then this function returns `NULL`. The returned pixbuf will be the same in all future calls to the loader, so if you want to keep using it, you should acquire a reference to it. Additionally, if the loader is an animation, it will return the "static image" of the animation (see gdk_pixbuf_animation_get_static_image()). The pixbuf that the loader is creating A pixbuf loader. Causes the image to be scaled while it is loaded. The desired image size can be determined relative to the original size of the image by calling gdk_pixbuf_loader_set_size() from a signal handler for the ::size-prepared signal. Attempts to set the desired image size are ignored after the emission of the ::size-prepared signal. A pixbuf loader. The desired width of the image being loaded. The desired height of the image being loaded. Parses the next `count` bytes in the given image buffer. `TRUE` if the write was successful, or `FALSE` if the loader cannot parse the buffer A pixbuf loader. Pointer to image data. Length of the @buf buffer in bytes. Parses the next contents of the given image buffer. `TRUE` if the write was successful, or `FALSE` if the loader cannot parse the buffer A pixbuf loader. The image data as a `GBytes` buffer. This signal is emitted when the pixbuf loader has allocated the pixbuf in the desired size. After this signal is emitted, applications can call gdk_pixbuf_loader_get_pixbuf() to fetch the partially-loaded pixbuf. This signal is emitted when a significant area of the image being loaded has been updated. Normally it means that a complete scanline has been read in, but it could be a different area as well. Applications can use this signal to know when to repaint areas of an image that is being loaded. X offset of upper-left corner of the updated area. Y offset of upper-left corner of the updated area. Width of updated area. Height of updated area. This signal is emitted when gdk_pixbuf_loader_close() is called. It can be used by different parts of an application to receive notification when an image loader is closed by the code that drives it. This signal is emitted when the pixbuf loader has been fed the initial amount of data that is required to figure out the size of the image that it will create. Applications can call gdk_pixbuf_loader_set_size() in response to this signal to set the desired size to which the image should be scaled. the original width of the image the original height of the image A `GdkPixbufModule` contains the necessary functions to load and save images in a certain file format. If `GdkPixbuf` has been compiled with `GModule` support, it can be extended by modules which can load (and perhaps also save) new image and animation formats. ## Implementing modules The `GdkPixbuf` interfaces needed for implementing modules are contained in `gdk-pixbuf-io.h` (and `gdk-pixbuf-animation.h` if the module supports animations). They are not covered by the same stability guarantees as the regular GdkPixbuf API. To underline this fact, they are protected by the `GDK_PIXBUF_ENABLE_BACKEND` pre-processor symbol. Each loadable module must contain a `GdkPixbufModuleFillVtableFunc` function named `fill_vtable`, which will get called when the module is loaded and must set the function pointers of the `GdkPixbufModule`. In order to make format-checking work before actually loading the modules (which may require calling `dlopen` to load image libraries), modules export their signatures (and other information) via the `fill_info` function. An external utility, `gdk-pixbuf-query-loaders`, uses this to create a text file containing a list of all available loaders and their signatures. This file is then read at runtime by `GdkPixbuf` to obtain the list of available loaders and their signatures. Modules may only implement a subset of the functionality available via `GdkPixbufModule`. If a particular functionality is not implemented, the `fill_vtable` function will simply not set the corresponding function pointers of the `GdkPixbufModule` structure. If a module supports incremental loading (i.e. provides `begin_load`, `stop_load` and `load_increment`), it doesn't have to implement `load`, since `GdkPixbuf` can supply a generic `load` implementation wrapping the incremental loading. ## Installing modules Installing a module is a two-step process: - copy the module file(s) to the loader directory (normally `$libdir/gdk-pixbuf-2.0/$version/loaders`, unless overridden by the environment variable `GDK_PIXBUF_MODULEDIR`) - call `gdk-pixbuf-query-loaders` to update the module file (normally `$libdir/gdk-pixbuf-2.0/$version/loaders.cache`, unless overridden by the environment variable `GDK_PIXBUF_MODULE_FILE`) the name of the module, usually the same as the usual file extension for images of this type, eg. "xpm", "jpeg" or "png". the path from which the module is loaded. the loaded `GModule`. a `GdkPixbufFormat` holding information about the module. loads an image from a file. loads an image from data in memory. begins an incremental load. stops an incremental load. continues an incremental load. loads an animation from a file. saves a `GdkPixbuf` to a file. saves a `GdkPixbuf` by calling the given `GdkPixbufSaveFunc`. returns whether a save option key is supported by the module Sets up the image loading state. The image loader is responsible for storing the given function pointers and user data, and call them when needed. The image loader should set up an internal state object, and return it from this function; the state object will then be updated from the [callback@GdkPixbuf.PixbufModuleIncrementLoadFunc] callback, and will be freed by [callback@GdkPixbuf.PixbufModuleStopLoadFunc] callback. the data to be passed to [callback@GdkPixbuf.PixbufModuleIncrementLoadFunc] and [callback@GdkPixbuf.PixbufModuleStopLoadFunc], or `NULL` in case of error the function to be called when the size is known the function to be called when the data has been prepared the function to be called when the data has been updated the data to be passed to the functions Defines the type of the function used to fill a #GdkPixbufFormat structure with information about a module. a #GdkPixbufFormat. Defines the type of the function used to set the vtable of a #GdkPixbufModule when it is loaded. a #GdkPixbufModule. Incrementally loads a buffer into the image data. `TRUE` if the incremental load was successful the state object created by [callback@GdkPixbuf.PixbufModuleBeginLoadFunc] the data to load the length of the data to load Loads a file from a standard C file stream into a new `GdkPixbufAnimation`. In case of error, this function should return `NULL` and set the `error` argument. a newly created `GdkPixbufAnimation` for the contents of the file the file stream from which the image should be loaded Loads a file from a standard C file stream into a new `GdkPixbuf`. In case of error, this function should return `NULL` and set the `error` argument. a newly created `GdkPixbuf` for the contents of the file the file stream from which the image should be loaded Loads XPM data into a new `GdkPixbuf`. a newly created `GdkPixbuf` for the XPM data the XPM data The signature prefix for a module. The signature of a module is a set of prefixes. Prefixes are encoded as pairs of ordinary strings, where the second string, called the mask, if not `NULL`, must be of the same length as the first one and may contain ' ', '!', 'x', 'z', and 'n' to indicate bytes that must be matched, not matched, "don't-care"-bytes, zeros and non-zeros, respectively. Each prefix has an associated integer that describes the relevance of the prefix, with 0 meaning a mismatch and 100 a "perfect match". Starting with gdk-pixbuf 2.8, the first byte of the mask may be '*', indicating an unanchored pattern that matches not only at the beginning, but also in the middle. Versions prior to 2.8 will interpret the '*' like an 'x'. The signature of a module is stored as an array of `GdkPixbufModulePatterns`. The array is terminated by a pattern where the `prefix` is `NULL`. ```c GdkPixbufModulePattern *signature[] = { { "abcdx", " !x z", 100 }, { "bla", NULL, 90 }, { NULL, NULL, 0 } }; ``` In the example above, the signature matches e.g. "auud\0" with relevance 100, and "blau" with relevance 90. the prefix for this pattern mask containing bytes which modify how the prefix is matched against test data relevance of this pattern Defines the type of the function that gets called once the initial setup of @pixbuf is done. #GdkPixbufLoader uses a function of this type to emit the "<link linkend="GdkPixbufLoader-area-prepared">area_prepared</link>" signal. the #GdkPixbuf that is currently being loaded. if an animation is being loaded, the #GdkPixbufAnimation, else %NULL. the loader. Saves a `GdkPixbuf` by calling the provided function. The optional `option_keys` and `option_values` arrays contain the keys and values (in the same order) for attributes to be saved alongside the image data. `TRUE` on success; in case of failure, `FALSE` is returned and the `error` is set the function to call when saving the data to pass to @save_func the `GdkPixbuf` to save an array of option names an array of option values Saves a `GdkPixbuf` into a standard C file stream. The optional `param_keys` and `param_values` arrays contain the keys and values (in the same order) for attributes to be saved alongside the image data. `TRUE` on success; in case of failure, `FALSE` is returned and the `error` is set the file stream into which the image should be saved the image to save parameter keys to save parameter values to save Checks whether the given `option_key` is supported when saving. `TRUE` if the option is supported the option key to check Defines the type of the function that gets called once the size of the loaded image is known. The function is expected to set @width and @height to the desired size to which the image should be scaled. If a module has no efficient way to achieve the desired scaling during the loading of the image, it may either ignore the size request, or only approximate it - gdk-pixbuf will then perform the required scaling on the completely loaded image. If the function sets @width or @height to zero, the module should interpret this as a hint that it will be closed soon and shouldn't allocate further resources. This convention is used to implement gdk_pixbuf_get_file_info() efficiently. pointer to a location containing the current image width pointer to a location containing the current image height the loader. Finalizes the image loading state. This function is called on success and error states. `TRUE` if the loading operation was successful the state object created by [callback@GdkPixbuf.PixbufModuleBeginLoadFunc] Defines the type of the function that gets called every time a region of @pixbuf is updated. #GdkPixbufLoader uses a function of this type to emit the "<link linkend="GdkPixbufLoader-area-updated">area_updated</link>" signal. the #GdkPixbuf that is currently being loaded. the X origin of the updated area. the Y origin of the updated area. the width of the updated area. the height of the updated area. the loader. The possible rotations which can be passed to gdk_pixbuf_rotate_simple(). To make them easier to use, their numerical values are the actual degrees. No rotation. Rotate by 90 degrees. Rotate by 180 degrees. Rotate by 270 degrees. Save functions used by [method@GdkPixbuf.Pixbuf.save_to_callback]. This function is called once for each block of bytes that is "written" by `gdk_pixbuf_save_to_callback()`. If successful it should return `TRUE`; if an error occurs it should set `error` and return `FALSE`, in which case `gdk_pixbuf_save_to_callback()` will fail with the same error. `TRUE` if successful, `FALSE` otherwise bytes to be written. number of bytes in @buf. A location to return an error. user data passed to gdk_pixbuf_save_to_callback(). An opaque struct representing a simple animation. Creates a new, empty animation. a newly allocated #GdkPixbufSimpleAnim the width of the animation the height of the animation the speed of the animation, in frames per second Adds a new frame to @animation. The @pixbuf must have the dimensions specified when the animation was constructed. a #GdkPixbufSimpleAnim the pixbuf to add Gets whether @animation should loop indefinitely when it reaches the end. %TRUE if the animation loops forever, %FALSE otherwise a #GdkPixbufSimpleAnim Sets whether @animation should loop indefinitely when it reaches the end. a #GdkPixbufSimpleAnim whether to loop the animation Whether the animation should loop when it reaches the end.