GdkPixbuf

https://docs.gtk.org/gdk-pixbuf/
Admin
GdkPixbuf is an image loading and manipulation library that provides a simple mechanism for loading,...
Tokens:56,597
Snippets:368
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Installing Modules

Source: https://docs.gtk.org/gdk-pixbuf/struct.PixbufModule.html

Steps required to install custom GdkPixbuf modules into the system.

```APIDOC
## Installing Modules

Installing a GdkPixbuf module involves two main steps:

1.  **Copy Module Files**: Copy the module file(s) to the designated loader directory. The default location is typically `$libdir/gdk-pixbuf-2.0/$version/loaders`. This path can be overridden using the `GDK_PIXBUF_MODULEDIR` environment variable.
2.  **Update Module Cache**: Run the `gdk-pixbuf-query-loaders` utility to update the module cache file. The default location for this cache is usually `$libdir/gdk-pixbuf-2.0/$version/loaders.cache`, which can be overridden by the `GDK_PIXBUF_MODULE_FILE` environment variable.
```

--------------------------------

### GdkPixbufPixbufModulePreparedFunc Callback

Source: https://docs.gtk.org/gdk-pixbuf/callback.PixbufModulePreparedFunc.html

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 'area_prepared' signal.

```APIDOC
## GdkPixbufPixbufModulePreparedFunc

### Description
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 ’area_prepared’ signal.

### Declaration
```c
void
(* GdkPixbufModulePreparedFunc) (
  GdkPixbuf* pixbuf,
  GdkPixbufAnimation* anim,
  gpointer user_data
)
```

### Parameters

`pixbuf`
    
_Type:_ `GdkPixbuf`
The `GdkPixbuf` that is currently being loaded. The data is owned by the caller of the function.

---

`anim`
      
_Type:_ `GdkPixbufAnimation`
If an animation is being loaded, the `GdkPixbufAnimation`, else `NULL`. The data is owned by the caller of the function.

---

`user_data`
      
_Type:_ `gpointer`
The loader. The argument can be `NULL`. The data is owned by the caller of the function.
```

--------------------------------

### Example GdkPixbufModulePattern Array

Source: https://docs.gtk.org/gdk-pixbuf/struct.PixbufModulePattern.html

Illustrates how to define an array of GdkPixbufModulePattern structures to represent a module's signature. The array is terminated by a pattern with a NULL prefix.

```c
GdkPixbufModulePattern *signature[] = {
  { "abcdx", " !x z", 100 },
  { "bla", NULL,  90 },
  { NULL, NULL, 0 }
};
```

--------------------------------

### GET gdk_pixbuf_get_options

Source: https://docs.gtk.org/gdk-pixbuf/method.Pixbuf.get_options.html

Retrieves a hash table of all options attached to a GdkPixbuf object.

```APIDOC
## GET gdk_pixbuf_get_options

### Description
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 gdk_pixbuf_set_option().

### Method
GET

### Parameters
#### Path Parameters
- **pixbuf** (GdkPixbuf*) - Required - The GdkPixbuf object to query.

### Response
#### Success Response (200)
- **GHashTable** (GHashTable*) - A GHashTable of key/values pairs. The caller takes ownership of the returned data container, but not the data inside it.
```

--------------------------------

### Save Pixbuf with Quality Parameter

Source: https://docs.gtk.org/gdk-pixbuf/method.Pixbuf.save.html

Example of saving a pixbuf to a JPEG file with a specified quality setting. The 'quality' parameter controls the compression level.

```c
gdk_pixbuf_save (pixbuf, handle, "jpeg", &error, "quality", "100", NULL);
```

--------------------------------

### Save Pixbuf with ICC Profile

Source: https://docs.gtk.org/gdk-pixbuf/method.Pixbuf.save.html

This example shows how to save a pixbuf as a PNG file and embed an ICC color profile. The profile must be base64 encoded.

```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);
```

--------------------------------

### Get Pixbuf Rowstride

Source: https://docs.gtk.org/gdk-pixbuf/method.Pixbuf.get_rowstride.html

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. This method returns an integer representing the distance between row starts.

```c
int
gdk_pixbuf_get_rowstride (
  const GdkPixbuf* pixbuf
)

```

--------------------------------

### Implementing Modules

Source: https://docs.gtk.org/gdk-pixbuf/struct.PixbufModule.html

Guidelines and requirements for implementing custom image format modules for GdkPixbuf.

```APIDOC
## Implementing Modules

To implement modules for GdkPixbuf, you need to adhere to the interfaces defined in `gdk-pixbuf-io.h` (and `gdk-pixbuf-animation.h` for animations). These interfaces are protected by the `GDK_PIXBUF_ENABLE_BACKEND` pre-processor symbol.

### `fill_vtable` Function
Each loadable module must contain a `GdkPixbufModuleFillVtableFunc` function named `fill_vtable`. This function is called when the module is loaded and is responsible for setting the function pointers within the `GdkPixbufModule` structure.

### `fill_info` Function
To enable format-checking before loading modules (which might involve `dlopen`), modules export their signatures and other information via the `fill_info` function. The `gdk-pixbuf-query-loaders` utility uses this to generate a cache file listing available loaders and their signatures.

### Functionality Subset
Modules can implement a subset of the available `GdkPixbufModule` functionality. If a function pointer is not set in `fill_vtable`, that functionality will not be available. `GdkPixbuf` can provide a generic `load` implementation if a module supports incremental loading (i.e., implements `begin_load`, `stop_load`, and `load_increment`).
```

--------------------------------

### GET gdk_pixbuf_get_rowstride

Source: https://docs.gtk.org/gdk-pixbuf/method.Pixbuf.get_rowstride.html

Retrieves the rowstride of a GdkPixbuf, representing the number of bytes between the start of consecutive rows.

```APIDOC
## GET gdk_pixbuf_get_rowstride

### Description
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.

### Parameters
#### Path Parameters
- **pixbuf** (const GdkPixbuf*) - Required - The pixbuf object to query.

### Response
#### Success Response (200)
- **Return value** (int) - The distance in bytes between the start of consecutive rows.
```

--------------------------------

### GdkPixbufAnimation Instance Methods

Source: https://docs.gtk.org/gdk-pixbuf/class.PixbufAnimation.html

Methods to query properties and state of a GdkPixbufAnimation instance.

```APIDOC
## Instance Methods

### gdk_pixbuf_animation_get_height
Queries the height of the bounding box of a pixbuf animation.

### gdk_pixbuf_animation_get_width
Queries the width of the bounding box of a pixbuf animation.

### gdk_pixbuf_animation_get_iter
Get an iterator for displaying an animation.

### gdk_pixbuf_animation_get_static_image
Retrieves a static image for the animation.

### gdk_pixbuf_animation_is_static_image
Checks whether the animation is a static image.
```

--------------------------------

### GdkPixbufPixbuf:rowstride Property

Source: https://docs.gtk.org/gdk-pixbuf/property.Pixbuf.rowstride.html

The 'rowstride' property defines the number of bytes from the start of one row to the start of the next row in a GdkPixbuf. This value must be at least as large as the pixbuf's width.

```APIDOC
## GdkPixbufPixbuf:rowstride Property

### Description
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.

### Type
`gint`

### Flags
- Readable: yes
- Writable: yes
- Construct only: yes

### Default Value
1

### Getter Method
`gdk_pixbuf_get_rowstride()`
```

--------------------------------

### GdkPixbufModuleBeginLoadFunc

Source: https://docs.gtk.org/gdk-pixbuf/callback.PixbufModuleBeginLoadFunc.html

Sets up the image loading state for a GdkPixbuf module by storing callback functions and user data.

```APIDOC
## GdkPixbufModuleBeginLoadFunc

### Description
Sets up the image loading state. The image loader is responsible for storing the given function pointers and user data, and calling them when needed. It returns an internal state object to be used by subsequent load functions.

### Parameters
#### Path Parameters
- **size_func** (GdkPixbufModuleSizeFunc) - Required - The function to be called when the size is known.
- **prepared_func** (GdkPixbufModulePreparedFunc) - Required - The function to be called when the data has been prepared.
- **updated_func** (GdkPixbufModuleUpdatedFunc) - Required - The function to be called when the data has been updated.
- **user_data** (gpointer) - Optional - The data to be passed to the functions.
- **error** (GError **) - Optional - The return location for a recoverable error.

### Response
#### Success Response
- **Return Value** (gpointer) - The data to be passed to GdkPixbufModuleIncrementLoadFunc and GdkPixbufModuleStopLoadFunc, or NULL in case of error.
```

--------------------------------

### gdk_pixbuf_save_to_stream_finish

Source: https://docs.gtk.org/gdk-pixbuf/type_func.Pixbuf.save_to_stream_finish.html

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

```APIDOC
## gdk_pixbuf_save_to_stream_finish

### Description
Finishes an asynchronous pixbuf save operation started with gdk_pixbuf_save_to_stream_async(). Available since: 2.24.

### Parameters
- **async_result** (GAsyncResult*) - Required - A GAsyncResult.
- **error** (GError**) - Optional - The return location for a recoverable error.

### Return Value
- **gboolean** - TRUE if the pixbuf was saved successfully, FALSE if an error was set.
```

--------------------------------

### GdkPixbufAnimation Constructors

Source: https://docs.gtk.org/gdk-pixbuf/class.PixbufAnimation.html

Methods for creating new GdkPixbufAnimation instances from various sources.

```APIDOC
## Constructors

### gdk_pixbuf_animation_new_from_file
Creates a new animation by loading it from a file.

### gdk_pixbuf_animation_new_from_resource
Creates a new pixbuf animation by loading an image from a resource.

### gdk_pixbuf_animation_new_from_stream
Creates a new animation by loading it from an input stream.

### gdk_pixbuf_animation_new_from_stream_finish
Finishes an asynchronous pixbuf animation creation operation started with gdk_pixbuf_animation_new_from_stream_async().
```

--------------------------------

### GdkPixbufPixbufget_file_info_finish

Source: https://docs.gtk.org/gdk-pixbuf/type_func.Pixbuf.get_file_info_finish.html

Finishes an asynchronous pixbuf parsing operation started with gdk_pixbuf_get_file_info_async().

```APIDOC
## GdkPixbufPixbufget_file_info_finish

### Description
Finishes an asynchronous pixbuf parsing operation started with gdk_pixbuf_get_file_info_async().

### Method
(Implied asynchronous operation, typically called after an async start)

### Endpoint
(N/A for function calls)

### Parameters
#### Path Parameters
(N/A)

#### Query Parameters
(N/A)

#### Request Body
(N/A)

### Request Example
(N/A)

### Response
#### Success Response
- **GdkPixbufFormat***: A `GdkPixbufFormat` describing the image format of the file. The data is owned by the called function. The return value can be `NULL`.

#### Response Example
(N/A - function return value and output parameters)

### Error Handling
- **GError***: The return location for a recoverable error. If the return location is not `NULL`, then you must initialize it to a `NULL` `GError*`. The argument will be left initialized to `NULL` by the function if there are no errors. In case of error, the argument will be set to a newly allocated `GError`; the caller will take ownership of the data, and be responsible for freeing it.
```

--------------------------------

### GdkPixbufPixbufSimpleAnim Constructors

Source: https://docs.gtk.org/gdk-pixbuf/class.PixbufSimpleAnim.html

Constructors for creating GdkPixbufPixbufSimpleAnim objects.

```APIDOC
## gdk_pixbuf_simple_anim_new

### Description
Creates a new, empty animation.

### Deprecated
Version: 2.44
Since: 2.8
```

--------------------------------

### GdkPixbufPixbufnew_from_stream_finish

Source: https://docs.gtk.org/gdk-pixbuf/ctor.Pixbuf.new_from_stream_finish.html

Finishes an asynchronous pixbuf creation operation started with gdk_pixbuf_new_from_stream_async().

```APIDOC
## GdkPixbufPixbufnew_from_stream_finish

### Description
Finishes an asynchronous pixbuf creation operation started with gdk_pixbuf_new_from_stream_async().

### Method
(Implied asynchronous operation completion, typically part of a callback)

### Endpoint
(N/A - This is a function call, not a network endpoint)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(N/A - This is a function call)

### Response
#### Success Response (200)
- **GdkPixbuf** (GdkPixbuf*) - The newly created pixbuf. The caller of the function takes ownership of the data, and is responsible for freeing it. The return value can be NULL.

#### Response Example
(N/A - Function return value)

### Error Handling
- **GError ** (GError **) - The return location for a recoverable error. The argument can be NULL. If the return location is not NULL, then you must initialize it to a NULL GError*. The argument will be left initialized to NULL by the constructor if there are no errors. In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.
```

--------------------------------

### Create a new GdkPixbufLoader

Source: https://docs.gtk.org/gdk-pixbuf/ctor.PixbufLoader.new.html

Initializes a new pixbuf loader object. The caller is responsible for freeing the returned object.

```C
GdkPixbufLoader*
gdk_pixbuf_loader_new (
  void
)
```

--------------------------------

### GET gdk_pixbuf_loader_get_animation

Source: https://docs.gtk.org/gdk-pixbuf/method.PixbufLoader.get_animation.html

Queries the GdkPixbufAnimation that a pixbuf loader is currently creating.

```APIDOC
## GET gdk_pixbuf_loader_get_animation

### Description
Queries the GdkPixbufAnimation that a pixbuf loader is currently creating. It is recommended to call this after the GdkPixbufLoader::area-prepared signal has been emitted.

### Method
GET

### Parameters
#### Path Parameters
- **loader** (GdkPixbufLoader*) - Required - The pixbuf loader instance.

### Response
#### Success Response (200)
- **Return value** (GdkPixbufAnimation*) - The animation that the loader is currently loading. Returns NULL if the loader does not have enough data or the area-prepared signal has not been emitted.
```

--------------------------------

### GdkPixbufPixbufnew_from_resource_at_scale

Source: https://docs.gtk.org/gdk-pixbuf/ctor.Pixbuf.new_from_resource_at_scale.html

Creates a new pixbuf by loading an image from a resource and scaling it to the specified dimensions. The image format is detected automatically. Aspect ratio can be preserved during scaling. Errors are reported via a GError pointer.

```APIDOC
## GdkPixbufPixbufnew_from_resource_at_scale

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

### Method
`GdkPixbuf*`

### Endpoint
`gdk_pixbuf_new_from_resource_at_scale`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```c
GdkPixbuf* pixbuf = gdk_pixbuf_new_from_resource_at_scale (
  "/path/to/your/resource.png",
  200, 
  150, 
  TRUE, 
  NULL
);
```

### Response
#### Success Response (200)
- **GdkPixbuf*** (GdkPixbuf) - A newly-created pixbuf. The caller of the function takes ownership of the data, and is responsible for freeing it.

#### Response Example
```json
{
  "pixbuf_data": "..."
}
```

#### Error Response
- **GError** - If an error occurs during pixbuf creation, this will be set with details.
```

--------------------------------

### gdk_pixbuf_animation_new_from_stream_finish

Source: https://docs.gtk.org/gdk-pixbuf/ctor.PixbufAnimation.new_from_stream_finish.html

Finishes an asynchronous pixbuf animation creation operation started with gdk_pixbuf_animation_new_from_stream_async().

```APIDOC
## gdk_pixbuf_animation_new_from_stream_finish

### Description
Finishes an asynchronous pixbuf animation creation operation started with gdk_pixbuf_animation_new_from_stream_async(). Note that this function is deprecated since 2.44.

### Parameters
#### Path Parameters
- **async_result** (GAsyncResult) - Required - A GAsyncResult from the asynchronous operation.
- **error** (GError **) - Optional - The return location for a recoverable error.

### Response
#### Success Response
- **Return Value** (GdkPixbufAnimation) - The newly created animation. The caller takes ownership of the data.
```

--------------------------------

### Virtual Method: area_prepared

Source: https://docs.gtk.org/gdk-pixbuf/vfunc.PixbufLoader.area_prepared.html

Documentation for the area_prepared virtual method within the GdkPixbufLoader class.

```APIDOC
## Virtual Method: area_prepared

### Description
This virtual method is part of the GdkPixbufLoader class. No specific description is provided for this method.

### Declaration
void area_prepared (GdkPixbufLoader* loader)
```

--------------------------------

### GdkPixbufPixbufSimpleAnim Instance Methods

Source: https://docs.gtk.org/gdk-pixbuf/class.PixbufSimpleAnim.html

Methods specific to the GdkPixbufPixbufSimpleAnim class.

```APIDOC
## gdk_pixbuf_simple_anim_add_frame

### Description
Adds a new frame to `animation`. The `pixbuf` must have the dimensions specified when the animation was constructed.

### Deprecated
Version: 2.44
Since: 2.8
```

```APIDOC
## gdk_pixbuf_simple_anim_get_loop

### Description
Gets whether `animation` should loop indefinitely when it reaches the end.

### Deprecated
Version: 2.44
Since: 2.18
```

```APIDOC
## gdk_pixbuf_simple_anim_set_loop

### Description
Sets whether `animation` should loop indefinitely when it reaches the end.

### Deprecated
Version: 2.44
Since: 2.18
```

--------------------------------

### GET gdk_pixbuf_get_has_alpha

Source: https://docs.gtk.org/gdk-pixbuf/method.Pixbuf.get_has_alpha.html

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

```APIDOC
## GET gdk_pixbuf_get_has_alpha

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

### Parameters
#### Path Parameters
- **pixbuf** (const GdkPixbuf*) - Required - The GdkPixbuf to query.

### Response
#### Success Response (200)
- **return** (gboolean) - TRUE if it has an alpha channel, FALSE otherwise.
```

--------------------------------

### GdkPixbufPixbufNonAnim Instance Methods

Source: https://docs.gtk.org/gdk-pixbuf/class.PixbufNonAnim.html

Instance methods available for GdkPixbufPixbufNonAnim, including inherited methods.

```APIDOC
## Methods inherited from GdkPixbufAnimation

### gdk_pixbuf_animation_get_height

Queries the height of the bounding box of a pixbuf animation.

* **deprecated**: 2.44

### gdk_pixbuf_animation_get_iter

Get an iterator for displaying an animation.

* **deprecated**: 2.44

### gdk_pixbuf_animation_get_static_image

Retrieves a static image for the animation.

* **deprecated**: 2.44

### gdk_pixbuf_animation_get_width

Queries the width of the bounding box of a pixbuf animation.

* **deprecated**: 2.44

### gdk_pixbuf_animation_is_static_image

Checks whether the animation is a static image.

* **deprecated**: 2.44

### gdk_pixbuf_animation_ref

Adds a reference to an animation.

* **deprecated**: 2.0

### gdk_pixbuf_animation_unref

Removes a reference from an animation.

* **deprecated**: 2.0
```

```APIDOC
## Methods inherited from GObject

Please see GObject for a full list of methods.
```

--------------------------------

### GdkPixbuf Constructors

Source: https://docs.gtk.org/gdk-pixbuf/class.Pixbuf.html

Methods for creating new GdkPixbuf instances from various sources such as files, streams, and memory buffers.

```APIDOC
## Constructors

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

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

### gdk_pixbuf_new_from_stream
Creates a new pixbuf by loading an image from an input stream (since 2.14).

### gdk_pixbuf_new_from_resource
Creates a new pixbuf by loading an image from a resource (since 2.26).
```

--------------------------------

### GdkPixbuf Option Management

Source: https://docs.gtk.org/gdk-pixbuf/class.Pixbuf.html

Functions for getting, setting, and removing options associated with a GdkPixbuf.

```APIDOC
## gdk_pixbuf_get_option

### Description
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().

### Method
GET (assumed)

### Endpoint
/pixbuf/{pixbuf}/options/{key}

### Parameters
#### Path Parameters
- **pixbuf** (GdkPixbuf) - Required - The pixbuf to get the option from.
- **key** (string) - Required - The key of the option to retrieve.

### Response
#### Success Response (200)
- **value** (string) - The value of the option.

## gdk_pixbuf_set_option

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

### Method
POST

### Endpoint
/pixbuf/{pixbuf}/options

### Parameters
#### Path Parameters
- **pixbuf** (GdkPixbuf) - Required - The pixbuf to attach the option to.

#### Request Body
- **key** (string) - Required - The key for the option.
- **value** (string) - Required - The value for the option.

### Response
#### Success Response (200)
- **status** (string) - Indicates success.

## gdk_pixbuf_remove_option

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

### Method
DELETE

### Endpoint
/pixbuf/{pixbuf}/options/{key}

### Parameters
#### Path Parameters
- **pixbuf** (GdkPixbuf) - Required - The pixbuf to remove the option from.
- **key** (string) - Required - The key of the option to remove.

### Response
#### Success Response (200)
- **status** (string) - Indicates success.
```

--------------------------------

### GET gdk_pixbuf_get_pixels_with_length

Source: https://docs.gtk.org/gdk-pixbuf/method.Pixbuf.get_pixels_with_length.html

Retrieves a pointer to the pixel data of a pixbuf, including the length of the data.

```APIDOC
## GET gdk_pixbuf_get_pixels_with_length

### Description
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.

### Parameters
#### Path Parameters
- **pixbuf** (const GdkPixbuf*) - Required - The pixbuf instance.

#### Output Parameters
- **length** (guint*) - Required - The length of the binary data, set by the function.

### Response
- **Return value** (guchar*) - A pointer to the pixbuf’s pixel data. The returned data is owned by the instance.
```

--------------------------------

### gdk_pixbuf_new_from_file_at_size

Source: https://docs.gtk.org/gdk-pixbuf/ctor.Pixbuf.new_from_file_at_size.html

Creates a new pixbuf by loading an image from a file, automatically detecting the format and scaling it to fit the requested dimensions while preserving aspect ratio.

```APIDOC
## gdk_pixbuf_new_from_file_at_size

### Description
Creates a new pixbuf by loading an image from a file. The file format is detected automatically. The image will be scaled to fit in the requested size, preserving the image’s aspect ratio.

### Parameters
- **filename** (const char*) - Required - Name of file to load, in the GLib file name encoding.
- **width** (int) - Required - The width the image should have or -1 to not constrain the width.
- **height** (int) - Required - The height the image should have or -1 to not constrain the height.
- **error** (GError**) - Optional - The return location for a recoverable error.

### Return value
- **GdkPixbuf*** - A newly-created pixbuf. The caller takes ownership of the data.
```

--------------------------------

### Constructor: gdk_pixbuf_new

Source: https://docs.gtk.org/gdk-pixbuf/ctor.Pixbuf.new.html

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

```APIDOC
## gdk_pixbuf_new

### Description
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 and is not cleared.

### Parameters
- **colorspace** (GdkColorspace) - Required - Color space for image.
- **has_alpha** (gboolean) - Required - Whether the image should have transparency information.
- **bits_per_sample** (int) - Required - Number of bits per color sample.
- **width** (int) - Required - Width of image in pixels, must be > 0.
- **height** (int) - Required - Height of image in pixels, must be > 0.

### Response
- **Return value** (GdkPixbuf*) - A newly-created pixel buffer. The caller takes ownership of the data and is responsible for freeing it. Returns NULL on failure.
```

--------------------------------

### GET gdk_pixbuf_get_option

Source: https://docs.gtk.org/gdk-pixbuf/method.Pixbuf.get_option.html

Retrieves a specific option value associated with a GdkPixbuf instance, such as metadata or loader-specific tags.

```APIDOC
## GET gdk_pixbuf_get_option

### Description
Looks up a key in the list of options attached to the pixbuf when it was loaded or set via gdk_pixbuf_set_option().

### Method
GET

### Parameters
#### Path Parameters
- **pixbuf** (GdkPixbuf*) - Required - The GdkPixbuf instance.
- **key** (const gchar*) - Required - The key to look up.

### Response
#### Success Response (200)
- **Return value** (const gchar*) - The value associated with the key, or NULL if not found. The returned data is owned by the instance.
```

--------------------------------

### Signal: area-prepared

Source: https://docs.gtk.org/gdk-pixbuf/signal.PixbufLoader.area-prepared.html

Documentation for the area-prepared signal emitted by GdkPixbufLoader.

```APIDOC
## Signal: area-prepared

### Description
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.

### Parameters
- **self** (GdkPixbufLoader*) - Required - The GdkPixbufLoader instance.
- **user_data** (gpointer) - Required - User data passed to the signal handler.
```

--------------------------------

### GdkPixbufAnimationIter.advance

Source: https://docs.gtk.org/gdk-pixbuf/method.PixbufAnimationIter.advance.html

Advances an animation to a new frame based on the provided time. The frame is chosen based on the start time passed to gdk_pixbuf_animation_get_iter().

```APIDOC
## GdkPixbufAnimationIter.advance

### Description
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. As a shortcut, pass `NULL` for the current time and `g_get_current_time()` will be invoked on your behalf. If this function returns `FALSE`, there’s no need to update the animation display; if `TRUE`, you need to call `gdk_pixbuf_animation_iter_get_pixbuf()` and update the display with the new pixbuf.

Deprecated since: 2.44. Use a different image loading library for animatable assets.

### Method
`gboolean`

### Endpoint
`gdk_pixbuf_animation_iter_advance`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **return value** (`gboolean`) - `TRUE` if the image may need updating.

#### Response Example
None
```

--------------------------------

### GdkPixbufLoader Methods

Source: https://docs.gtk.org/gdk-pixbuf/class.PixbufLoader.html

Methods for managing the lifecycle and data processing of a GdkPixbufLoader instance.

```APIDOC
## gdk_pixbuf_loader_write

### Description
Pareses the next count bytes in the given image buffer.

### Method
POST

### Endpoint
gdk_pixbuf_loader_write

## gdk_pixbuf_loader_close

### Description
Informs a pixbuf loader that no further writes will occur, allowing it to free internal structures.

### Method
POST

### Endpoint
gdk_pixbuf_loader_close

## gdk_pixbuf_loader_set_size

### Description
Causes the image to be scaled while it is loaded.

### Method
POST

### Endpoint
gdk_pixbuf_loader_set_size

## gdk_pixbuf_loader_get_pixbuf

### Description
Queries the GdkPixbuf that a pixbuf loader is currently creating.

### Method
GET

### Endpoint
gdk_pixbuf_loader_get_pixbuf
```

--------------------------------

### GdkPixbufAnimationget_iter

Source: https://docs.gtk.org/gdk-pixbuf/method.PixbufAnimation.get_iter.html

Retrieves an iterator for displaying an animated pixbuf. This iterator provides the frames to be displayed at a given time, starting from a specified time.

```APIDOC
## GdkPixbufAnimationget_iter

### Description
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”.

Deprecated since: 2.44
Use a different image loading library for animatable assets.

### Method
GET

### Endpoint
/websites/gtk_gdk-pixbuf/gdk_pixbuf_animation_get_iter

### Parameters
#### Query Parameters
- **animation** (GdkPixbufAnimation*) - Required - The pixbuf animation object.
- **start_time** (GTimeVal) - Optional - Time when the animation starts playing. The argument can be NULL.

### Response
#### Success Response (200)
- **GdkPixbufAnimationIter** (GdkPixbufAnimationIter*) - An iterator to move over the animation. The caller of the method takes ownership of the returned data, and is responsible for freeing it.

#### Response Example
{
  "animation_iter": "<pointer_to_GdkPixbufAnimationIter>"
}

```

--------------------------------

### GET gdk_pixbuf_animation_get_static_image

Source: https://docs.gtk.org/gdk-pixbuf/method.PixbufAnimation.get_static_image.html

Retrieves a static image for the animation. If the animation is a single frame, it returns that frame; otherwise, it returns a reasonable static representation.

```APIDOC
## GET gdk_pixbuf_animation_get_static_image

### Description
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. If an animation hasn’t loaded any frames yet, this function will return NULL.

### Method
GET

### Parameters
#### Path Parameters
- **animation** (GdkPixbufAnimation*) - Required - The animation object to retrieve the static image from.

### Response
#### Success Response (200)
- **Return value** (GdkPixbuf*) - Unanimated image representing the animation. The returned data is owned by the instance.

### Notes
- Deprecated since: 2.44. Use a different image loading library for animatable assets.
```

--------------------------------

### GdkPixbufPixbufnew_from_stream_at_scale_async

Source: https://docs.gtk.org/gdk-pixbuf/type_func.Pixbuf.new_from_stream_at_scale_async.html

Asynchronously creates a new pixbuf by loading an image from an input stream and scaling it. This is the asynchronous counterpart to gdk_pixbuf_new_from_stream_at_scale().

```APIDOC
## GdkPixbufPixbufnew_from_stream_at_scale_async

### Description
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. This function completes asynchronously. Use `()` inside the `GAsyncReadyCallback` to obtain the result of the operation.

### Method
Asynchronous Function Call

### Endpoint
N/A (This is a function call, not an HTTP endpoint)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A (This is a function call, not an HTTP request)

### Response
#### Success Response (Asynchronous Callback)
- **result** (GdkPixbuf) - The loaded and scaled pixbuf. This is obtained by calling `gdk_pixbuf_new_from_stream_finish()` within the `GAsyncReadyCallback`.

#### Response Example
N/A (This is a function call, not an HTTP response. The result is handled within the callback.)

### Parameters Details
- **stream** (GInputStream) - A `GInputStream` from which to load the pixbuf. The data is owned by the caller of the function.
- **width** (gint) - The width the image should have or -1 to not constrain the width.
- **height** (gint) - The height the image should have or -1 to not constrain the height.
- **preserve_aspect_ratio** (gboolean) - `TRUE` to preserve the image’s aspect ratio.
- **cancellable** (GCancellable) - Optional `GCancellable` object, `NULL` to ignore. The argument can be `NULL`. The data is owned by the caller of the function.
- **callback** (GAsyncReadyCallback) - A `GAsyncReadyCallback` to call when the pixbuf is loaded.
- **user_data** (gpointer) - The data to pass to the callback function. The argument can be `NULL`. The data is owned by the caller of the function.
```

--------------------------------

### gdk_pixbuf_new_from_file_at_scale

Source: https://docs.gtk.org/gdk-pixbuf/ctor.Pixbuf.new_from_file_at_scale.html

Creates a new pixbuf by loading an image from a file and scaling it to the requested dimensions.

```APIDOC
## gdk_pixbuf_new_from_file_at_scale

### Description
Creates a new pixbuf by loading an image from a file. The file format is detected automatically. The image will be scaled to fit in the requested size, optionally preserving the image’s aspect ratio.

### Parameters
#### Path Parameters
- **filename** (const char*) - Required - Name of file to load, in the GLib file name encoding.
- **width** (int) - Required - The width the image should have or -1 to not constrain the width.
- **height** (int) - Required - The height the image should have or -1 to not constrain the height.
- **preserve_aspect_ratio** (gboolean) - Required - TRUE to preserve the image’s aspect ratio.
- **error** (GError **) - Optional - The return location for a recoverable error.

### Response
#### Success Response
- **Return value** (GdkPixbuf) - A newly-created pixbuf.
```

--------------------------------

### GdkPixbufModuleSizeFunc Declaration

Source: https://docs.gtk.org/gdk-pixbuf/callback.PixbufModuleSizeFunc.html

Defines the signature for a callback function that gets called once the size of a loaded image is known. It's used to set the desired image dimensions.

```c
void
(* GdkPixbufModuleSizeFunc) (
  gint* width,
  gint* height,
  gpointer user_data
)
```

--------------------------------

### GdkPixbufAnimationNewFromFile

Source: https://docs.gtk.org/gdk-pixbuf/ctor.PixbufAnimation.new_from_file.html

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.

```APIDOC
## GdkPixbufAnimationNewFromFile

### Description
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.

Deprecated since: 2.44
Use a different image loading library for animatable assets.

### Method
POST

### Endpoint
/websites/gtk_gdk-pixbuf

### Parameters
#### Path Parameters
- **filename** (const char*) - Required - Name of file to load, in the GLib file name encoding. The data is owned by the caller of the function.
- **error** (GError **) - Optional - The return location for a recoverable error. The argument can be NULL.

### Return value
- **GdkPixbufAnimation** - A newly-created animation. The caller of the function takes ownership of the data, and is responsible for freeing it. The return value can be NULL.
```

--------------------------------

### GdkPixbufLoader Constructor

Source: https://docs.gtk.org/gdk-pixbuf/ctor.PixbufLoader.new.html

Creates a new pixbuf loader object.

```APIDOC
## GdkPixbufLoader* gdk_pixbuf_loader_new (void)

### Description
Creates a new pixbuf loader object.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **GdkPixbufLoader** (GdkPixbufLoader*) - A newly-created pixbuf loader. The caller of the function takes ownership of the data, and is responsible for freeing it.

#### Response Example
None
```

--------------------------------

### GdkPixbufAnimationIter Instance Methods

Source: https://docs.gtk.org/gdk-pixbuf/class.PixbufAnimationIter.html

Instance methods for the GdkPixbufAnimationIter class. All methods are deprecated since version 2.44.

```APIDOC
## Instance methods

### gdk_pixbuf_animation_iter_advance
Possibly advances an animation to a new frame.

**Deprecated:** 2.44

### gdk_pixbuf_animation_iter_get_delay_time
Gets the number of milliseconds the current pixbuf should be displayed, or -1 if the current pixbuf should be displayed forever.

**Deprecated:** 2.44

### gdk_pixbuf_animation_iter_get_pixbuf
Gets the current pixbuf which should be displayed.

**Deprecated:** 2.44

### gdk_pixbuf_animation_iter_on_currently_loading_frame
Used to determine how to respond to the area_updated signal on `GdkPixbufLoader` when loading an animation.

**Deprecated:** 2.44
```

--------------------------------

### GdkPixbufModuleSizeFunc Callback

Source: https://docs.gtk.org/gdk-pixbuf/callback.PixbufModuleSizeFunc.html

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.

```APIDOC
## GdkPixbufModuleSizeFunc

### Description
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.

Available since: 2.2

### Parameters

#### `width`
- **Type**: `gint*`
- **Description**: Pointer to a location containing the current image width. The data is owned by the caller of the function.

#### `height`
- **Type**: `gint*`
- **Description**: Pointer to a location containing the current image height. The data is owned by the caller of the function.

#### `user_data`
- **Type**: `gpointer`
- **Description**: The loader. The argument can be `NULL`. The data is owned by the caller of the function.
```

--------------------------------

### Get Static Image for GdkPixbufAnimation

Source: https://docs.gtk.org/gdk-pixbuf/vfunc.PixbufAnimation.get_static_image.html

Retrieves a static image for the animation. This function returns the single frame if the animation is not animated, or a reasonable static image (like the first frame) if it is. Returns NULL if no frames have been loaded yet. Deprecated since 2.44.

```c
GdkPixbuf*
get_static_image (
  GdkPixbufAnimation* animation
)

```

--------------------------------

### GdkPixbufPixbufNonAnimnew Constructor

Source: https://docs.gtk.org/gdk-pixbuf/ctor.PixbufNonAnim.new.html

Creates a new non-animated GdkPixbufAnimation from a GdkPixbuf.

```APIDOC
## GdkPixbufPixbufNonAnimnew

### Description
Creates a new non-animated GdkPixbufAnimation from a GdkPixbuf.

### Method
Constructor

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **pixbuf** (GdkPixbuf) - Required - The GdkPixbuf to create the animation from. The data is owned by the caller of the function.

### Request Example
```json
{
  "pixbuf": "<GdkPixbuf object>"
}
```

### Response
#### Success Response (200)
- **GdkPixbufAnimation** (GdkPixbufAnimation) - The newly created non-animated GdkPixbufAnimation. The caller of the function takes ownership of the data, and is responsible for freeing it.

#### Response Example
```json
{
  "animation": "<GdkPixbufAnimation object>"
}
```
```

--------------------------------

### List Writable Pixbuf Formats

Source: https://docs.gtk.org/gdk-pixbuf/method.Pixbuf.save.html

This code snippet demonstrates how to list all writable pixbuf formats. It iterates through available formats and checks if they can be written to.

```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);
```

--------------------------------

### Get Static Image from GdkPixbufAnimation

Source: https://docs.gtk.org/gdk-pixbuf/method.PixbufAnimation.get_static_image.html

Retrieves a static image for the animation. This function returns a reasonable image to use as a static, unanimated image, which might be the first frame or something more sophisticated. Returns NULL if the animation hasn't loaded any frames yet. Deprecated since 2.44.

```c
GdkPixbuf*
gdk_pixbuf_animation_get_static_image (
  GdkPixbufAnimation* animation
)
```

--------------------------------

### Get Delay Time for Pixbuf Animation

Source: https://docs.gtk.org/gdk-pixbuf/vfunc.PixbufAnimationIter.get_delay_time.html

Retrieves the number of milliseconds the current pixbuf should be displayed. Returns -1 if the pixbuf should be displayed indefinitely. This value can be used with g_timeout_add for scheduling updates. Note that some formats, like GIF, may clamp timeout values to a minimum of 20 milliseconds.

```c
int
get_delay_time (
  GdkPixbufAnimationIter* iter
)
```

--------------------------------

### GdkPixbufPixbufinit_modules

Source: https://docs.gtk.org/gdk-pixbuf/type_func.Pixbuf.init_modules.html

Initializes 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.

```APIDOC
## GdkPixbufPixbufinit_modules

### Description
Initializes 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.

### Method
`gboolean`

### Endpoint
N/A (This is a function, not an API endpoint)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (gboolean)
- `TRUE` if the modules were initialized successfully.
- `FALSE` if an error occurred.

#### Response Example
N/A

### Error Handling
- `error` (GError **): The return location for a recoverable error. If an error occurs, this will be set to a newly allocated `GError`.
```

--------------------------------

### GdkPixbufLoader::size_prepared

Source: https://docs.gtk.org/gdk-pixbuf/vfunc.PixbufLoader.size_prepared.html

This virtual method is called when the size of the pixbuf is known.

```APIDOC
## GdkPixbufLoader::size_prepared

### Description
This virtual method is called when the size of the pixbuf is known.

### Method
Virtual Method

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A

### Parameters
#### Path Parameters
- **loader** (GdkPixbufLoader*) - Description not available.
- **width** (int) - Description not available.
- **height** (int) - Description not available.
```

--------------------------------

### GdkPixbuf Versioning and Constants

Source: https://docs.gtk.org/gdk-pixbuf/index.html

Information on how to check the GdkPixbuf version and related constants.

```APIDOC
## GdkPixbuf Versioning

### Description
This section provides details on how to check the version of the GdkPixbuf library and lists the constants associated with its versioning.

### Function Macros
- **PIXBUF_CHECK_VERSION (major, minor, micro)**: Macro to test the version of GdkPixbuf being compiled against.

### Constants
- **PIXBUF_MAJOR**: Major version number of the GdkPixbuf library.
- **PIXBUF_MINOR**: Minor version number of the GdkPixbuf library.
- **PIXBUF_MICRO**: Micro version number of the GdkPixbuf library.
- **PIXBUF_VERSION**: The full version of GdkPixbuf as a string.
```
Tokens:
Raw