Gdk.Pixbuf

Description

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 [classGdkpixbuf.Pixbuf] instance. You can use the [ctorGdkpixbuf.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 [ctorGdkpixbuf.Pixbuf.new] constructor function can be used as a convenience to create a pixbuf with an empty buffer; this is equivalent to allocating a data buffer using malloc and then wrapping it with gdk_pixbuf_new_from_data. The gdk_pixbuf_new function will compute an optimal rowstride so that rendering can be performed with an efficient algorithm.

You can also copy an existing pixbuf with the [methodPixbuf.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 [classPixbuf] 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 [methodGdkpixbuf.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 [methodGdkpixbuf.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.

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 [classGdkpixbuf.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.

<group>GDK</group>
<gtkada_demo>create_pixbuf.adb</gtkada_demo>

"+"

function "+"
  (Widget : access Gdk_Pixbuf_Record'Class)
return Glib.Loadable_Icon.Gloadable_Icon

Parameters

Widget

Return Value

"-"

function "-"
  (Interf : Glib.Loadable_Icon.Gloadable_Icon)
return Gdk_Pixbuf

Parameters

Interf

Return Value

Add_Alpha

function Add_Alpha
   (Self             : not null access Gdk_Pixbuf_Record;
    Substitute_Color : Boolean;
    R                : Guchar;
    G                : Guchar;
    B                : Guchar) return Gdk_Pixbuf

Takes an existing pixbuf and adds an alpha channel to it. If the existing pixbuf already had an alpha channel, the channel values are copied from the original; otherwise, the alpha channel is initialized to 255 (full opacity). If substitute_color is TRUE, then the color specified by the (r, g, b) arguments will be assigned zero opacity. That is, if you pass (255, 255, 255) for the substitute color, all white pixels will become fully transparent. If substitute_color is FALSE, then the (r, g, b) arguments will be ignored.

Parameters

Self
Substitute_Color: Whether to set a color to zero opacity.
R: Red value to substitute.
G: Green value to substitute.
B: Blue value to substitute.

Return Value

A newly-created pixbuf. Has transfer-ownership='full'.

Apply_Embedded_Orientation

function Apply_Embedded_Orientation
   (Self : not null access Gdk_Pixbuf_Record) return Gdk_Pixbuf

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. Since: gtk+ 2.12

Parameters

Self

Return Value

A newly-created pixbuf. Has transfer-ownership='full'.

Bits_Per_Sample_Property

Bits_Per_Sample_Property : constant Glib.Properties.Property_Int;

The number of bits per sample.

Currently only 8 bit per sample are supported.

Calculate_Rowstride

function Calculate_Rowstride
   (Colorspace      : Gdk_Colorspace;
    Has_Alpha       : Boolean;
    Bits_Per_Sample : Glib.Gint;
    Width           : Glib.Gint;
    Height          : Glib.Gint) return Glib.Gint

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. Since: gtk+ 2.36.8

Parameters

Colorspace: Color space for image
Has_Alpha: Whether the image should have transparency information
Bits_Per_Sample: Number of bits per color sample
Width: Width of image in pixels, must be > 0
Height: Height of image in pixels, must be > 0

Return Value

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

Colorspace_Property

Colorspace_Property : constant Property_Gdk_Colorspace :=
Build ("colorspace");

Composite

procedure Composite
   (Self          : not null access Gdk_Pixbuf_Record;
    Dest          : not null access Gdk_Pixbuf_Record'Class;
    Dest_X        : Glib.Gint;
    Dest_Y        : Glib.Gint;
    Dest_Width    : Glib.Gint;
    Dest_Height   : Glib.Gint;
    Offset_X      : Gdouble;
    Offset_Y      : Gdouble;
    Scale_X       : Gdouble;
    Scale_Y       : Gdouble;
    Interp_Type   : Gdk_Interp_Type;
    Overall_Alpha : Glib.Gint)

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.

Parameters

Self
Dest: the Gdk.Pixbuf.Gdk_Pixbuf into which to render the results
Dest_X: the left coordinate for region to render
Dest_Y: the top coordinate for region to render
Dest_Width: the width of the region to render
Dest_Height: the height of the region to render
Offset_X: the offset in the X direction (currently rounded to an integer)
Offset_Y: the offset in the Y direction (currently rounded to an integer)
Scale_X: the scale factor in the X direction
Scale_Y: the scale factor in the Y direction
Interp_Type: the interpolation type for the transformation.
Overall_Alpha: overall alpha for source image (0..255)

Composite_Color

procedure Composite_Color
   (Self          : not null access Gdk_Pixbuf_Record;
    Dest          : not null access Gdk_Pixbuf_Record'Class;
    Dest_X        : Glib.Gint;
    Dest_Y        : Glib.Gint;
    Dest_Width    : Glib.Gint;
    Dest_Height   : Glib.Gint;
    Offset_X      : Gdouble;
    Offset_Y      : Gdouble;
    Scale_X       : Gdouble;
    Scale_Y       : Gdouble;
    Interp_Type   : Gdk_Interp_Type;
    Overall_Alpha : Glib.Gint;
    Check_X       : Glib.Gint;
    Check_Y       : Glib.Gint;
    Check_Size    : Glib.Gint;
    Color1        : Guint32;
    Color2        : Guint32)

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.

Parameters

Self
Dest: the Gdk.Pixbuf.Gdk_Pixbuf into which to render the results
Dest_X: the left coordinate for region to render
Dest_Y: the top coordinate for region to render
Dest_Width: the width of the region to render
Dest_Height: the height of the region to render
Offset_X: the offset in the X direction (currently rounded to an integer)
Offset_Y: the offset in the Y direction (currently rounded to an integer)
Scale_X: the scale factor in the X direction
Scale_Y: the scale factor in the Y direction
Interp_Type: the interpolation type for the transformation.
Overall_Alpha: overall alpha for source image (0..255)
Check_X: the X offset for the checkboard (origin of checkboard is at -Check_X, -Check_Y)
Check_Y: the Y offset for the checkboard
Check_Size: the size of checks in the checkboard (must be a power of two)
Color1: the color of check at upper left
Color2: the color of the other check

Composite_Color_Simple

function Composite_Color_Simple
   (Self          : not null access Gdk_Pixbuf_Record;
    Dest_Width    : Glib.Gint;
    Dest_Height   : Glib.Gint;
    Interp_Type   : Gdk_Interp_Type;
    Overall_Alpha : Glib.Gint;
    Check_Size    : Glib.Gint;
    Color1        : Guint32;
    Color2        : Guint32) return Gdk_Pixbuf

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.

Parameters

Self
Dest_Width: the width of destination image
Dest_Height: the height of destination image
Interp_Type: the interpolation type for the transformation.
Overall_Alpha: overall alpha for source image (0..255)
Check_Size: the size of checks in the checkboard (must be a power of two)
Color1: the color of check at upper left
Color2: the color of the other check

Return Value

the new pixbuf. Has transfer-ownership='full'.

Copy

function Copy
   (Self : not null access Gdk_Pixbuf_Record) return Gdk_Pixbuf

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.

Parameters

Self

Return Value

A newly-created pixbuf. Has transfer-ownership='full'.

Copy_Area

procedure Copy_Area
   (Self        : not null access Gdk_Pixbuf_Record;
    Src_X       : Glib.Gint;
    Src_Y       : Glib.Gint;
    Width       : Glib.Gint;
    Height      : Glib.Gint;
    Dest_Pixbuf : not null access Gdk_Pixbuf_Record'Class;
    Dest_X      : Glib.Gint;
    Dest_Y      : Glib.Gint)

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.

Parameters

Self
Src_X: Source X coordinate within Src_Pixbuf.
Src_Y: Source Y coordinate within Src_Pixbuf.
Width: Width of the area to copy.
Height: Height of the area to copy.
Dest_Pixbuf: Destination pixbuf.
Dest_X: X coordinate within Dest_Pixbuf.
Dest_Y: Y coordinate within Dest_Pixbuf.

Copy_Options

function Copy_Options
   (Self        : not null access Gdk_Pixbuf_Record;
    Dest_Pixbuf : not null access Gdk_Pixbuf_Record'Class) return Boolean

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. Since: gtk+ 2.36

Parameters

Self
Dest_Pixbuf: the destination pixbuf

Return Value

TRUE on success.

Fill

procedure Fill
   (Self  : not null access Gdk_Pixbuf_Record;
    Pixel : Guint32)

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.

Parameters

Self
Pixel: RGBA pixel to used to clear (0xffffffff is opaque white, 0x00000000 transparent black)

Flip

function Flip
   (Self       : not null access Gdk_Pixbuf_Record;
    Horizontal : Boolean) return Gdk_Pixbuf

Flips a pixbuf horizontally or vertically and returns the result in a new pixbuf. Since: gtk+ 2.6

Parameters

Self
Horizontal: TRUE to flip horizontally, FALSE to flip vertically

Return Value

the new pixbuf. Has transfer-ownership='full'.

Gasync_Ready_Callback

type Gasync_Ready_Callback is access procedure
  (Source_Object : access Glib.Object.GObject_Record'Class;
   Res           : Glib.G_Async_Result);

Type definition for a function that will be called back when an asynchronous operation within GIO has been completed. Gasync_Ready_Callback callbacks from Gtask.Gtask are guaranteed to be invoked in a later iteration of the thread-default main context (see [methodGlib.MainContext.push_thread_default]) where the Gtask.Gtask was created. All other users of Gasync_Ready_Callback must likewise call it asynchronously in a later iteration of the main context. The asynchronous operation is guaranteed to have held a reference to Source_Object from the time when the *_async function was called, until after this callback returns.

Parameters

Source_Object: the object the asynchronous operation was started with.
Res: a Glib.G_Async_Result.

Gdk_Colorspace

type Gdk_Colorspace is (
   Gdk_Colorspace_Rgb);

This enumeration defines the color spaces that are supported by the gdk-pixbuf library.

Currently only RGB is supported.

Enumeration Literal

Gdk_Colorspace_Rgb

Gdk_Colorspace_Properties

package Gdk_Colorspace_Properties is
   new Generic_Internal_Discrete_Property (Gdk_Colorspace);

Gdk_Interp_Type

type Gdk_Interp_Type is (
   Gdk_Interp_Nearest,
   Gdk_Interp_Tiles,
   Gdk_Interp_Bilinear,
   Gdk_Interp_Hyper);

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.

Enumeration Literal

Gdk_Interp_Nearest
Gdk_Interp_Tiles
Gdk_Interp_Bilinear
Gdk_Interp_Hyper

Gdk_Interp_Type_Properties

package Gdk_Interp_Type_Properties is
   new Generic_Internal_Discrete_Property (Gdk_Interp_Type);

Gdk_New

procedure Gdk_New
   (Self            : out Gdk_Pixbuf;
    Colorspace      : Gdk_Colorspace;
    Has_Alpha       : Boolean;
    Bits_Per_Sample : Glib.Gint;
    Width           : Glib.Gint;
    Height          : Glib.Gint)

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.

Parameters

Self
Colorspace: Color space for image
Has_Alpha: Whether the image should have transparency information
Bits_Per_Sample: Number of bits per color sample
Width: Width of image in pixels, must be > 0
Height: Height of image in pixels, must be > 0

Gdk_New_From_Bytes

procedure Gdk_New_From_Bytes
   (Self            : out Gdk_Pixbuf;
    Data            : Glib.Bytes.Gbytes;
    Colorspace      : Gdk_Colorspace;
    Has_Alpha       : Boolean;
    Bits_Per_Sample : Glib.Gint;
    Width           : Glib.Gint;
    Height          : Glib.Gint;
    Rowstride       : Glib.Gint)

Parameters

Self
Data: Image data in 8-bit/sample packed format inside a Glib.Bytes.Gbytes
Colorspace: Colorspace for the image data
Has_Alpha: Whether the data has an opacity channel
Bits_Per_Sample: Number of bits per sample
Width: Width of the image in pixels, must be > 0
Height: Height of the image in pixels, must be > 0
Rowstride: Distance in bytes between row starts

Gdk_New_From_Data

procedure Gdk_New_From_Data
   (Self            : out Gdk_Pixbuf;
    Data            : System.Address;
    Colorspace      : Gdk_Colorspace;
    Has_Alpha       : Boolean;
    Bits_Per_Sample : Glib.Gint;
    Width           : Glib.Gint;
    Height          : Glib.Gint;
    Rowstride       : Glib.Gint;
    Destroy_Fn      : Gdk_Pixbuf_Destroy_Notify := null;
    Destroy_Fn_Data : System.Address := System.Null_Address)

Creates a new Gdk.Pixbuf.Gdk_Pixbuf out of in-memory image data. Currently only RGB images with 8 bits per sample are supported. Since you are providing a pre-allocated pixel buffer, you must also specify a way to free that data. This is done with a function of type GdkPixbufDestroyNotify. When a pixbuf created with is finalized, your destroy notification function will be called, and it is its responsibility to free the pixel array. See also: [ctorGdkpixbuf.Pixbuf.new_from_bytes] Data is retained, not copied. Keep it alive until the last pixbuf reference is released. Destroy_Fn uses the C calling convention and receives Data and Destroy_Fn_Data.

Parameters

Self
Data: Image data in 8-bit/sample packed format
Colorspace: Colorspace for the image data
Has_Alpha: Whether the data has an opacity channel
Bits_Per_Sample: Number of bits per sample
Width: Width of the image in pixels, must be > 0
Height: Height of the image in pixels, must be > 0
Rowstride: Distance in bytes between row starts
Destroy_Fn: Function used to free the data when the pixbuf's reference count drops to zero, or NULL if the data should not be freed
Destroy_Fn_Data: Closure data to pass to the destroy notification function

Gdk_New_From_File

procedure Gdk_New_From_File
   (Self     : out Gdk_Pixbuf;
    Filename : UTF8_String;
    Error    : out Glib.Error.GError)

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.

Parameters

Self
Filename: Name of file to load, in the GLib file name encoding
Error: the return location for a recoverable error

Gdk_New_From_File_At_Scale

procedure Gdk_New_From_File_At_Scale
   (Self                  : out Gdk_Pixbuf;
    Filename              : UTF8_String;
    Width                 : Glib.Gint;
    Height                : Glib.Gint;
    Preserve_Aspect_Ratio : Boolean;
    Error                 : out Glib.Error.GError)

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. Since: gtk+ 2.6

Parameters

Self
Filename: Name of file to load, in the GLib file name encoding
Width: The width the image should have or -1 to not constrain the width
Height: The height the image should have or -1 to not constrain the height
Preserve_Aspect_Ratio: TRUE to preserve the image's aspect ratio
Error: the return location for a recoverable error

Gdk_New_From_File_At_Size

procedure Gdk_New_From_File_At_Size
   (Self     : out Gdk_Pixbuf;
    Filename : UTF8_String;
    Width    : Glib.Gint;
    Height   : Glib.Gint;
    Error    : out Glib.Error.GError)

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

Parameters

Self
Filename: Name of file to load, in the GLib file name encoding
Width: The width the image should have or -1 to not constrain the width
Height: The height the image should have or -1 to not constrain the height
Error: the return location for a recoverable error

Gdk_New_From_Inline

procedure Gdk_New_From_Inline
   (Self        : out Gdk_Pixbuf;
    Data_Length : Glib.Gint;
    Data        : Guint8_Array;
    Error       : out Glib.Error.GError)

Creates a GdkPixbuf from a flat representation that is suitable for storing as inline data in a program. This is useful if you want to ship a program with images, but don't want to depend on any external files. GdkPixbuf ships with a program called gdk-pixbuf-csource, which allows for conversion of GdkPixbufs into such a inline representation. In almost all cases, you should pass the --raw option to gdk-pixbuf-csource. A sample invocation would be: gdk-pixbuf-csource --raw --name=myimage_inline myimage.png For the typical case where the inline pixbuf is read-only static data, you don't need to copy the pixel data unless you intend to write to it, so you can pass FALSE for copy_pixels. If you pass --rle to gdk-pixbuf-csource, a copy will be made even if copy_pixels is FALSE, so using this option is generally a bad idea. If you create a pixbuf from const inline data compiled into your program, it's probably safe to ignore errors and disable length checks, since things will always succeed:

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.

Parameters

Self
Data_Length: Length in bytes of the data argument or -1 to disable length checks
Data: Byte data containing a serialized GdkPixdata structure
Error: the return location for a recoverable error

Gdk_New_From_Resource

procedure Gdk_New_From_Resource
   (Self          : out Gdk_Pixbuf;
    Resource_Path : UTF8_String;
    Error         : out Glib.Error.GError)

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. Since: gtk+ 2.26

Parameters

Self
Resource_Path: the path of the resource file
Error: the return location for a recoverable error

Gdk_New_From_Resource_At_Scale

procedure Gdk_New_From_Resource_At_Scale
   (Self                  : out Gdk_Pixbuf;
    Resource_Path         : UTF8_String;
    Width                 : Glib.Gint;
    Height                : Glib.Gint;
    Preserve_Aspect_Ratio : Boolean;
    Error                 : out Glib.Error.GError)

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. Since: gtk+ 2.26

Parameters

Self
Resource_Path: the path of the resource file
Width: The width the image should have or -1 to not constrain the width
Height: The height the image should have or -1 to not constrain the height
Preserve_Aspect_Ratio: TRUE to preserve the image's aspect ratio
Error: the return location for a recoverable error

Gdk_New_From_Stream

procedure Gdk_New_From_Stream
   (Self        : out Gdk_Pixbuf;
    Stream      : not null access Glib.Input_Stream.Ginput_Stream_Record'Class;
    Cancellable : access Glib.Cancellable.Gcancellable_Record'Class;
    Error       : out Glib.Error.GError)

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. Since: gtk+ 2.14

Parameters

Self
Stream: a GInputStream to load the pixbuf from
Cancellable: optional GCancellable object, NULL to ignore
Error: the return location for a recoverable error

Gdk_New_From_Stream_At_Scale

procedure Gdk_New_From_Stream_At_Scale
   (Self                  : out Gdk_Pixbuf;
    Stream                : not null access Glib.Input_Stream.Ginput_Stream_Record'Class;
    Width                 : Glib.Gint;
    Height                : Glib.Gint;
    Preserve_Aspect_Ratio : Boolean;
    Cancellable           : access Glib.Cancellable.Gcancellable_Record'Class;
    Error                 : out Glib.Error.GError)

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. Since: gtk+ 2.14

Parameters

Self
Stream: a GInputStream to load the pixbuf from
Width: The width the image should have or -1 to not constrain the width
Height: The height the image should have or -1 to not constrain the height
Preserve_Aspect_Ratio: TRUE to preserve the image's aspect ratio
Cancellable: optional GCancellable object, NULL to ignore
Error: the return location for a recoverable error

Gdk_New_From_Stream_Finish

procedure Gdk_New_From_Stream_Finish
   (Self         : out Gdk_Pixbuf;
    Async_Result : Glib.G_Async_Result;
    Error        : out Glib.Error.GError)

Finishes an asynchronous pixbuf creation operation started with Gdk.Pixbuf.New_From_Stream_Async. Since: gtk+ 2.24

Parameters

Self
Async_Result: a GAsyncResult
Error: the return location for a recoverable error

Gdk_New_From_Xpm_Data

procedure Gdk_New_From_Xpm_Data
   (Self : out Gdk_Pixbuf;
    Data : GNAT.Strings.String_List)

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.

Parameters

Self
Data: Pointer to inline XPM data.

Gdk_Pixbuf

type Gdk_Pixbuf is access all Gdk_Pixbuf_Record'Class;

Gdk_Pixbuf_Destroy_Notify

type Gdk_Pixbuf_Destroy_Notify is access procedure
  (Pixels : System.Address; Data : System.Address);

Data must remain valid until the callback runs at the last unref. Without a callback, the caller must keep the pixel buffer alive until the pixbuf releases it, then free it.

Parameters

Pixels
Data

Gdk_Pixbuf_Error

type Gdk_Pixbuf_Error is (
   Gdk_Pixbuf_Error_Corrupt_Image,
   Gdk_Pixbuf_Error_Insufficient_Memory,
   Gdk_Pixbuf_Error_Bad_Option,
   Gdk_Pixbuf_Error_Unknown_Type,
   Gdk_Pixbuf_Error_Unsupported_Operation,
   Gdk_Pixbuf_Error_Failed,
   Gdk_Pixbuf_Error_Incomplete_Animation);

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.

Enumeration Literal

Gdk_Pixbuf_Error_Corrupt_Image
Gdk_Pixbuf_Error_Insufficient_Memory
Gdk_Pixbuf_Error_Bad_Option
Gdk_Pixbuf_Error_Unknown_Type
Gdk_Pixbuf_Error_Unsupported_Operation
Gdk_Pixbuf_Error_Failed
Gdk_Pixbuf_Error_Incomplete_Animation

Gdk_Pixbuf_Error_Domain

Gdk_Pixbuf_Error_Domain : constant GQuark := Quark_From_String (Gdk_Pixbuf_Error_Name);

Used to identify error domain in a GError

Gdk_Pixbuf_Error_Matches

function Gdk_Pixbuf_Error_Matches
  (Error : GError; Code : Gdk_Pixbuf_Error) return Boolean

Convenience helper to match error codes

Parameters

Error
Code

Return Value

Gdk_Pixbuf_Error_Name

Gdk_Pixbuf_Error_Name   : constant UTF8_String := "gdk-pixbuf-error-quark";

Used to identify error domain in a GError

Gdk_Pixbuf_Error_Properties

package Gdk_Pixbuf_Error_Properties is
   new Generic_Internal_Discrete_Property (Gdk_Pixbuf_Error);

Gdk_Pixbuf_New

function Gdk_Pixbuf_New
   (Colorspace      : Gdk_Colorspace;
    Has_Alpha       : Boolean;
    Bits_Per_Sample : Glib.Gint;
    Width           : Glib.Gint;
    Height          : Glib.Gint) return Gdk_Pixbuf

Parameters

Colorspace: Color space for image
Has_Alpha: Whether the image should have transparency information
Bits_Per_Sample: Number of bits per color sample
Width: Width of image in pixels, must be > 0
Height: Height of image in pixels, must be > 0

Return Value

Gdk_Pixbuf_New_From_Bytes

function Gdk_Pixbuf_New_From_Bytes
   (Data            : Glib.Bytes.Gbytes;
    Colorspace      : Gdk_Colorspace;
    Has_Alpha       : Boolean;
    Bits_Per_Sample : Glib.Gint;
    Width           : Glib.Gint;
    Height          : Glib.Gint;
    Rowstride       : Glib.Gint) return Gdk_Pixbuf

Parameters

Data: Image data in 8-bit/sample packed format inside a Glib.Bytes.Gbytes
Colorspace: Colorspace for the image data
Has_Alpha: Whether the data has an opacity channel
Bits_Per_Sample: Number of bits per sample
Width: Width of the image in pixels, must be > 0
Height: Height of the image in pixels, must be > 0
Rowstride: Distance in bytes between row starts

Return Value

Gdk_Pixbuf_New_From_Data

function Gdk_Pixbuf_New_From_Data
   (Data            : System.Address;
    Colorspace      : Gdk_Colorspace;
    Has_Alpha       : Boolean;
    Bits_Per_Sample : Glib.Gint;
    Width           : Glib.Gint;
    Height          : Glib.Gint;
    Rowstride       : Glib.Gint;
    Destroy_Fn      : Gdk_Pixbuf_Destroy_Notify := null;
    Destroy_Fn_Data : System.Address := System.Null_Address)
    return Gdk_Pixbuf

Parameters

Data: Image data in 8-bit/sample packed format
Colorspace: Colorspace for the image data
Has_Alpha: Whether the data has an opacity channel
Bits_Per_Sample: Number of bits per sample
Width: Width of the image in pixels, must be > 0
Height: Height of the image in pixels, must be > 0
Rowstride: Distance in bytes between row starts
Destroy_Fn: Function used to free the data when the pixbuf's reference count drops to zero, or NULL if the data should not be freed
Destroy_Fn_Data: Closure data to pass to the destroy notification function

Return Value

Gdk_Pixbuf_New_From_File

function Gdk_Pixbuf_New_From_File
   (Filename : UTF8_String;
    Error    : out Glib.Error.GError) return Gdk_Pixbuf

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.

Parameters

Filename: Name of file to load, in the GLib file name encoding
Error: the return location for a recoverable error

Return Value

Gdk_Pixbuf_New_From_File_At_Scale

function Gdk_Pixbuf_New_From_File_At_Scale
   (Filename              : UTF8_String;
    Width                 : Glib.Gint;
    Height                : Glib.Gint;
    Preserve_Aspect_Ratio : Boolean;
    Error                 : out Glib.Error.GError) return Gdk_Pixbuf

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

Parameters

Filename: Name of file to load, in the GLib file name encoding
Width: The width the image should have or -1 to not constrain the width
Height: The height the image should have or -1 to not constrain the height
Preserve_Aspect_Ratio: TRUE to preserve the image's aspect ratio
Error: the return location for a recoverable error

Return Value

Gdk_Pixbuf_New_From_File_At_Size

function Gdk_Pixbuf_New_From_File_At_Size
   (Filename : UTF8_String;
    Width    : Glib.Gint;
    Height   : Glib.Gint;
    Error    : out Glib.Error.GError) return Gdk_Pixbuf

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

Parameters

Filename: Name of file to load, in the GLib file name encoding
Width: The width the image should have or -1 to not constrain the width
Height: The height the image should have or -1 to not constrain the height
Error: the return location for a recoverable error

Return Value

Gdk_Pixbuf_New_From_Inline

function Gdk_Pixbuf_New_From_Inline
   (Data_Length : Glib.Gint;
    Data        : Guint8_Array;
    Error       : out Glib.Error.GError) return Gdk_Pixbuf

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.

Parameters

Data_Length: Length in bytes of the data argument or -1 to disable length checks
Data: Byte data containing a serialized GdkPixdata structure
Error: the return location for a recoverable error

Return Value

Gdk_Pixbuf_New_From_Resource

function Gdk_Pixbuf_New_From_Resource
   (Resource_Path : UTF8_String;
    Error         : out Glib.Error.GError) return Gdk_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. Since: gtk+ 2.26

Parameters

Resource_Path: the path of the resource file
Error: the return location for a recoverable error

Return Value

Gdk_Pixbuf_New_From_Resource_At_Scale

function Gdk_Pixbuf_New_From_Resource_At_Scale
   (Resource_Path         : UTF8_String;
    Width                 : Glib.Gint;
    Height                : Glib.Gint;
    Preserve_Aspect_Ratio : Boolean;
    Error                 : out Glib.Error.GError) return Gdk_Pixbuf

Parameters

Resource_Path: the path of the resource file
Width: The width the image should have or -1 to not constrain the width
Height: The height the image should have or -1 to not constrain the height
Preserve_Aspect_Ratio: TRUE to preserve the image's aspect ratio
Error: the return location for a recoverable error

Return Value

Gdk_Pixbuf_New_From_Stream

function Gdk_Pixbuf_New_From_Stream
   (Stream      : not null access Glib.Input_Stream.Ginput_Stream_Record'Class;
    Cancellable : access Glib.Cancellable.Gcancellable_Record'Class;
    Error       : out Glib.Error.GError) return Gdk_Pixbuf

Parameters

Stream: a GInputStream to load the pixbuf from
Cancellable: optional GCancellable object, NULL to ignore
Error: the return location for a recoverable error

Return Value

Gdk_Pixbuf_New_From_Stream_At_Scale

function Gdk_Pixbuf_New_From_Stream_At_Scale
   (Stream                : not null access Glib.Input_Stream.Ginput_Stream_Record'Class;
    Width                 : Glib.Gint;
    Height                : Glib.Gint;
    Preserve_Aspect_Ratio : Boolean;
    Cancellable           : access Glib.Cancellable.Gcancellable_Record'Class;
    Error                 : out Glib.Error.GError) return Gdk_Pixbuf

Parameters

Stream: a GInputStream to load the pixbuf from
Width: The width the image should have or -1 to not constrain the width
Height: The height the image should have or -1 to not constrain the height
Preserve_Aspect_Ratio: TRUE to preserve the image's aspect ratio
Cancellable: optional GCancellable object, NULL to ignore
Error: the return location for a recoverable error

Return Value

Gdk_Pixbuf_New_From_Stream_Finish

function Gdk_Pixbuf_New_From_Stream_Finish
   (Async_Result : Glib.G_Async_Result;
    Error        : out Glib.Error.GError) return Gdk_Pixbuf

Finishes an asynchronous pixbuf creation operation started with Gdk.Pixbuf.New_From_Stream_Async. Since: gtk+ 2.24

Parameters

Async_Result: a GAsyncResult
Error: the return location for a recoverable error

Return Value

Gdk_Pixbuf_New_From_Xpm_Data

function Gdk_Pixbuf_New_From_Xpm_Data
   (Data : GNAT.Strings.String_List) return Gdk_Pixbuf

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

Parameters

Data: Pointer to inline XPM data.

Return Value

Gdk_Pixbuf_Record

type Gdk_Pixbuf_Record is new GObject_Record with null record;

Gdk_Pixbuf_Rotation

type Gdk_Pixbuf_Rotation is (
   Gdk_Pixbuf_Rotate_None,
   Gdk_Pixbuf_Rotate_Counterclockwise,
   Gdk_Pixbuf_Rotate_Upsidedown,
   Gdk_Pixbuf_Rotate_Clockwise);

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.

Enumeration Literal

Gdk_Pixbuf_Rotate_None
Gdk_Pixbuf_Rotate_Counterclockwise
Gdk_Pixbuf_Rotate_Upsidedown
Gdk_Pixbuf_Rotate_Clockwise

Gdk_Pixbuf_Rotation_Properties

package Gdk_Pixbuf_Rotation_Properties is
   new Generic_Internal_Discrete_Property (Gdk_Pixbuf_Rotation);

Get_Bits_Per_Sample

function Get_Bits_Per_Sample
   (Self : not null access Gdk_Pixbuf_Record) return Glib.Gint

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

Parameters

Self

Return Value

Number of bits per color sample.

Get_Byte_Length

function Get_Byte_Length
   (Self : not null access Gdk_Pixbuf_Record) return Gsize

Returns the length of the pixel data, in bytes. Since: gtk+ 2.26

Parameters

Self

Return Value

The length of the pixel data.

Get_Colorspace

function Get_Colorspace
   (Self : not null access Gdk_Pixbuf_Record) return Gdk_Colorspace

Queries the color space of a pixbuf.

Parameters

Self

Return Value

Color space.

Get_File_Info

function Get_File_Info
   (Filename : UTF8_String;
    Width    : access Glib.Gint := null;
    Height   : access Glib.Gint := null)
    return Gdk.Pixbuf_Format.Gdk_Pixbuf_Format_Access

Parses an image file far enough to determine its format and size. Since: gtk+ 2.4

Parameters

Filename: The name of the file to identify.
Width: Return location for the width of the image
Height: Return location for the height of the image

Return Value

A GdkPixbufFormat describing the image format of the file

Get_File_Info_Async

procedure Get_File_Info_Async
   (Filename    : UTF8_String;
    Cancellable : access Glib.Cancellable.Gcancellable_Record'Class;
    Callback    : Gasync_Ready_Callback)

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. Since: gtk+ 2.32

Parameters

Filename: The name of the file to identify
Cancellable: optional GCancellable object, NULL to ignore
Callback: a GAsyncReadyCallback to call when the file info is available

Get_File_Info_Finish

function Get_File_Info_Finish
   (Async_Result : Glib.G_Async_Result;
    Width        : out Glib.Gint;
    Height       : out Glib.Gint;
    Error        : out Glib.Error.GError)
    return Gdk.Pixbuf_Format.Gdk_Pixbuf_Format_Access

Finishes an asynchronous pixbuf parsing operation started with Gdk.Pixbuf.Get_File_Info_Async. Since: gtk+ 2.32

Parameters

Async_Result: a GAsyncResult
Width: Return location for the width of the image, or NULL
Height: Return location for the height of the image, or NULL
Error: the return location for a recoverable error

Return Value

A GdkPixbufFormat describing the image format of the file

Get_Formats

function Get_Formats return Gdk.Pixbuf_Format.Format_List.GSlist

Obtains the available information about the image formats supported by GdkPixbuf. Since: gtk+ 2.2

Return Value

A list of support image formats.

Get_Has_Alpha

function Get_Has_Alpha
   (Self : not null access Gdk_Pixbuf_Record) return Boolean

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

Parameters

Self

Return Value

TRUE if it has an alpha channel, FALSE otherwise.

Get_Height

function Get_Height
   (Self : not null access Gdk_Pixbuf_Record) return Glib.Gint

Queries the height of a pixbuf.

Parameters

Self

Return Value

Height in pixels.

Get_N_Channels

function Get_N_Channels
   (Self : not null access Gdk_Pixbuf_Record) return Glib.Gint

Queries the number of channels of a pixbuf.

Parameters

Self

Return Value

Number of channels.

Get_Option

function Get_Option
   (Self : not null access Gdk_Pixbuf_Record;
    Key  : UTF8_String) return UTF8_String

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.

Parameters

Self
Key: a nul-terminated string.

Return Value

the value associated with key

Get_Options

function Get_Options
   (Self : not null access Gdk_Pixbuf_Record) return System.Address

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 [methodGdkpixbuf.Pixbuf.set_option]. Since: gtk+ 2.32

Parameters

Self

Return Value

a GHash_Table of key/values pairs

Get_Pixels

function Get_Pixels
   (Self : not null access Gdk_Pixbuf_Record) return System.Address

Queries a pointer to the pixel data of a pixbuf. This function will cause an implicit copy of the pixbuf data if the pixbuf was created from read-only data. Please see the section on image data for information about how the pixel data is stored in memory. Returns a borrowed pixel buffer. Its size is Get_Byte_Length; use Get_Rowstride to locate each row. Keep the pixbuf alive while accessing the buffer.

Parameters

Self

Return Value

A pointer to the pixbuf's pixel data.

Get_Pixels_With_Length

function Get_Pixels_With_Length
   (Self   : not null access Gdk_Pixbuf_Record;
    Length : out Guint) return System.Address

Parameters

Self
Length: The length of the binary data.

Return Value

A pointer to the pixbuf's pixel data.

Get_Rowstride

function Get_Rowstride
   (Self : not null access Gdk_Pixbuf_Record) return Glib.Gint

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

Self

Return Value

Distance between row starts.

Get_Type

function Get_Type return Glib.GType

Return Value

Get_Width

function Get_Width
   (Self : not null access Gdk_Pixbuf_Record) return Glib.Gint

Queries the width of a pixbuf.

Parameters

Self

Return Value

Width in pixels.

Has_Alpha_Property

Has_Alpha_Property : constant Glib.Properties.Property_Boolean;

Whether the pixbuf has an alpha channel.

Height_Property

Height_Property : constant Glib.Properties.Property_Int;

The number of rows of the pixbuf.

Implements_Gloadable_Icon

package Implements_Gloadable_Icon is new Glib.Types.Implements
  (Glib.Loadable_Icon.Gloadable_Icon, Gdk_Pixbuf_Record, Gdk_Pixbuf);

Init_Modules

function Init_Modules
   (Path  : UTF8_String;
    Error : out Glib.Error.GError) return Boolean

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. Since: gtk+ 2.40

Parameters

Path: Path to directory where the loaders.cache is installed
Error: the return location for a recoverable error

Return Value

Initialize

procedure Initialize
   (Self            : not null access Gdk_Pixbuf_Record'Class;
    Colorspace      : Gdk_Colorspace;
    Has_Alpha       : Boolean;
    Bits_Per_Sample : Glib.Gint;
    Width           : Glib.Gint;
    Height          : Glib.Gint)

Parameters

Self
Colorspace: Color space for image
Has_Alpha: Whether the image should have transparency information
Bits_Per_Sample: Number of bits per color sample
Width: Width of image in pixels, must be > 0
Height: Height of image in pixels, must be > 0

Initialize_From_Bytes

procedure Initialize_From_Bytes
   (Self            : not null access Gdk_Pixbuf_Record'Class;
    Data            : Glib.Bytes.Gbytes;
    Colorspace      : Gdk_Colorspace;
    Has_Alpha       : Boolean;
    Bits_Per_Sample : Glib.Gint;
    Width           : Glib.Gint;
    Height          : Glib.Gint;
    Rowstride       : Glib.Gint)

Creates a new Gdk.Pixbuf.Gdk_Pixbuf out of in-memory readonly image data. Currently only RGB images with 8 bits per sample are supported. This is the GBytes variant of Gdk.Pixbuf.Gdk_New_From_Data, useful for language bindings. Since: gtk+ 2.32 Initialize_From_Bytes does nothing if the object was already created with another call to Initialize* or G_New.

Parameters

Self
Data: Image data in 8-bit/sample packed format inside a Glib.Bytes.Gbytes
Colorspace: Colorspace for the image data
Has_Alpha: Whether the data has an opacity channel
Bits_Per_Sample: Number of bits per sample
Width: Width of the image in pixels, must be > 0
Height: Height of the image in pixels, must be > 0
Rowstride: Distance in bytes between row starts

Initialize_From_Data

procedure Initialize_From_Data
   (Self            : not null access Gdk_Pixbuf_Record'Class;
    Data            : System.Address;
    Colorspace      : Gdk_Colorspace;
    Has_Alpha       : Boolean;
    Bits_Per_Sample : Glib.Gint;
    Width           : Glib.Gint;
    Height          : Glib.Gint;
    Rowstride       : Glib.Gint;
    Destroy_Fn      : Gdk_Pixbuf_Destroy_Notify := null;
    Destroy_Fn_Data : System.Address := System.Null_Address)

Parameters

Self
Data: Image data in 8-bit/sample packed format
Colorspace: Colorspace for the image data
Has_Alpha: Whether the data has an opacity channel
Bits_Per_Sample: Number of bits per sample
Width: Width of the image in pixels, must be > 0
Height: Height of the image in pixels, must be > 0
Rowstride: Distance in bytes between row starts
Destroy_Fn: Function used to free the data when the pixbuf's reference count drops to zero, or NULL if the data should not be freed
Destroy_Fn_Data: Closure data to pass to the destroy notification function

Initialize_From_File

procedure Initialize_From_File
   (Self     : not null access Gdk_Pixbuf_Record'Class;
    Filename : UTF8_String;
    Error    : out Glib.Error.GError)

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. Initialize_From_File does nothing if the object was already created with another call to Initialize* or G_New.

Parameters

Self
Filename: Name of file to load, in the GLib file name encoding
Error: the return location for a recoverable error

Initialize_From_File_At_Scale

procedure Initialize_From_File_At_Scale
   (Self                  : not null access Gdk_Pixbuf_Record'Class;
    Filename              : UTF8_String;
    Width                 : Glib.Gint;
    Height                : Glib.Gint;
    Preserve_Aspect_Ratio : Boolean;
    Error                 : out Glib.Error.GError)

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

Parameters

Self
Filename: Name of file to load, in the GLib file name encoding
Width: The width the image should have or -1 to not constrain the width
Height: The height the image should have or -1 to not constrain the height
Preserve_Aspect_Ratio: TRUE to preserve the image's aspect ratio
Error: the return location for a recoverable error

Initialize_From_File_At_Size

procedure Initialize_From_File_At_Size
   (Self     : not null access Gdk_Pixbuf_Record'Class;
    Filename : UTF8_String;
    Width    : Glib.Gint;
    Height   : Glib.Gint;
    Error    : out Glib.Error.GError)

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 [ctorGdkpixbuf.Pixbuf.new_from_file_at_scale]. Since: gtk+ 2.4 Initialize_From_File_At_Size does nothing if the object was already created with another call to Initialize* or G_New.

Parameters

Self
Filename: Name of file to load, in the GLib file name encoding
Width: The width the image should have or -1 to not constrain the width
Height: The height the image should have or -1 to not constrain the height
Error: the return location for a recoverable error

Initialize_From_Inline

procedure Initialize_From_Inline
   (Self        : not null access Gdk_Pixbuf_Record'Class;
    Data_Length : Glib.Gint;
    Data        : Guint8_Array;
    Error       : out Glib.Error.GError)

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.
Initialize_From_Inline does nothing if the object was already created
with another call to Initialize* or G_New.

Parameters

Self
Data_Length: Length in bytes of the data argument or -1 to disable length checks
Data: Byte data containing a serialized GdkPixdata structure
Error: the return location for a recoverable error

Initialize_From_Resource

procedure Initialize_From_Resource
   (Self          : not null access Gdk_Pixbuf_Record'Class;
    Resource_Path : UTF8_String;
    Error         : out Glib.Error.GError)

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. Since: gtk+ 2.26 Initialize_From_Resource does nothing if the object was already created with another call to Initialize* or G_New.

Parameters

Self
Resource_Path: the path of the resource file
Error: the return location for a recoverable error

Initialize_From_Resource_At_Scale

procedure Initialize_From_Resource_At_Scale
   (Self                  : not null access Gdk_Pixbuf_Record'Class;
    Resource_Path         : UTF8_String;
    Width                 : Glib.Gint;
    Height                : Glib.Gint;
    Preserve_Aspect_Ratio : Boolean;
    Error                 : out Glib.Error.GError)

Parameters

Self
Resource_Path: the path of the resource file
Width: The width the image should have or -1 to not constrain the width
Height: The height the image should have or -1 to not constrain the height
Preserve_Aspect_Ratio: TRUE to preserve the image's aspect ratio
Error: the return location for a recoverable error

Initialize_From_Stream

procedure Initialize_From_Stream
   (Self        : not null access Gdk_Pixbuf_Record'Class;
    Stream      : not null access Glib.Input_Stream.Ginput_Stream_Record'Class;
    Cancellable : access Glib.Cancellable.Gcancellable_Record'Class;
    Error       : out Glib.Error.GError)

Parameters

Self
Stream: a GInputStream to load the pixbuf from
Cancellable: optional GCancellable object, NULL to ignore
Error: the return location for a recoverable error

Initialize_From_Stream_At_Scale

procedure Initialize_From_Stream_At_Scale
   (Self                  : not null access Gdk_Pixbuf_Record'Class;
    Stream                : not null access Glib.Input_Stream.Ginput_Stream_Record'Class;
    Width                 : Glib.Gint;
    Height                : Glib.Gint;
    Preserve_Aspect_Ratio : Boolean;
    Cancellable           : access Glib.Cancellable.Gcancellable_Record'Class;
    Error                 : out Glib.Error.GError)

Parameters

Self
Stream: a GInputStream to load the pixbuf from
Width: The width the image should have or -1 to not constrain the width
Height: The height the image should have or -1 to not constrain the height
Preserve_Aspect_Ratio: TRUE to preserve the image's aspect ratio
Cancellable: optional GCancellable object, NULL to ignore
Error: the return location for a recoverable error

Initialize_From_Stream_Finish

procedure Initialize_From_Stream_Finish
   (Self         : not null access Gdk_Pixbuf_Record'Class;
    Async_Result : Glib.G_Async_Result;
    Error        : out Glib.Error.GError)

Finishes an asynchronous pixbuf creation operation started with Gdk.Pixbuf.New_From_Stream_Async. Since: gtk+ 2.24 Initialize_From_Stream_Finish does nothing if the object was already created with another call to Initialize* or G_New.

Parameters

Self
Async_Result: a GAsyncResult
Error: the return location for a recoverable error

Initialize_From_Xpm_Data

procedure Initialize_From_Xpm_Data
   (Self : not null access Gdk_Pixbuf_Record'Class;
    Data : GNAT.Strings.String_List)

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. Initialize_From_Xpm_Data does nothing if the object was already created with another call to Initialize* or G_New.

Parameters

Self
Data: Pointer to inline XPM data.

Load

function Load
   (Self        : not null access Gdk_Pixbuf_Record;
    Size        : Glib.Gint;
    The_Type    : access UTF8_String := null;
    Cancellable : access Glib.Cancellable.Gcancellable_Record'Class;
    Error       : out Glib.Error.GError)
    return Glib.Input_Stream.Ginput_Stream

Parameters

Self
Size
The_Type
Cancellable
Error

Return Value

Load_Async

procedure Load_Async
   (Self        : not null access Gdk_Pixbuf_Record;
    Size        : Glib.Gint;
    Cancellable : access Glib.Cancellable.Gcancellable_Record'Class;
    Callback    : Gasync_Ready_Callback)

Loads an icon asynchronously. To finish this function, see Glib.Loadable_Icon.Load_Finish. For the synchronous, blocking version of this function, see Glib.Loadable_Icon.Load.

Parameters

Self
Size: an integer.
Cancellable: optional Glib.Cancellable.Gcancellable object, null to ignore.
Callback: a Gasync_Ready_Callback to call when the request is satisfied

Load_Finish

function Load_Finish
   (Self     : not null access Gdk_Pixbuf_Record;
    Res      : Glib.G_Async_Result;
    The_Type : access UTF8_String := null;
    Error    : out Glib.Error.GError)
    return Glib.Input_Stream.Ginput_Stream

Parameters

Self
Res
The_Type
Error

Return Value

N_Channels_Property

N_Channels_Property : constant Glib.Properties.Property_Int;

The number of samples per pixel.

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

New_From_Stream_Async

procedure New_From_Stream_Async
   (Stream      : not null access Glib.Input_Stream.Ginput_Stream_Record'Class;
    Cancellable : access Glib.Cancellable.Gcancellable_Record'Class;
    Callback    : Gasync_Ready_Callback)

Creates a new pixbuf by asynchronously loading an image from an input stream. For more details see Gdk.Pixbuf.Gdk_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.Gdk_New_From_Stream_Finish to get the result of the operation. Since: gtk+ 2.24

Parameters

Stream: a GInputStream from which to load the pixbuf
Cancellable: optional GCancellable object, NULL to ignore
Callback: a GAsyncReadyCallback to call when the pixbuf is loaded

New_From_Stream_At_Scale_Async

procedure New_From_Stream_At_Scale_Async
   (Stream                : not null access Glib.Input_Stream.Ginput_Stream_Record'Class;
    Width                 : Glib.Gint;
    Height                : Glib.Gint;
    Preserve_Aspect_Ratio : Boolean;
    Cancellable           : access Glib.Cancellable.Gcancellable_Record'Class;
    Callback              : Gasync_Ready_Callback)

Creates a new pixbuf by asynchronously loading an image from an input stream. For more details see Gdk.Pixbuf.Gdk_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.Gdk_New_From_Stream_Finish to get the result of the operation. Since: gtk+ 2.24

Parameters

Stream: a GInputStream from which to load the pixbuf
Width: the width the image should have or -1 to not constrain the width
Height: the height the image should have or -1 to not constrain the height
Preserve_Aspect_Ratio: TRUE to preserve the image's aspect ratio
Cancellable: optional GCancellable object, NULL to ignore
Callback: a GAsyncReadyCallback to call when the pixbuf is loaded

New_Subpixbuf

function New_Subpixbuf
   (Self   : not null access Gdk_Pixbuf_Record;
    Src_X  : Glib.Gint;
    Src_Y  : Glib.Gint;
    Width  : Glib.Gint;
    Height : Glib.Gint) return Gdk_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.

Parameters

Self
Src_X: X coord in Src_Pixbuf
Src_Y: Y coord in Src_Pixbuf
Width: width of region in Src_Pixbuf
Height: height of region in Src_Pixbuf

Return Value

a new pixbuf. Has transfer-ownership='full'.

Pixel_Bytes_Property

Pixel_Bytes_Property : constant Glib.Properties.Property_Boxed;

Type: GLib.Bytes

Pixels_Property

Pixels_Property : constant Glib.Properties.Property_Address :=
Glib.Properties.Build ("pixels");

Property_Gdk_Colorspace

type Property_Gdk_Colorspace is new Gdk_Colorspace_Properties.Property;

Property_Gdk_Interp_Type

type Property_Gdk_Interp_Type is new Gdk_Interp_Type_Properties.Property;

Property_Gdk_Pixbuf_Error

type Property_Gdk_Pixbuf_Error is new Gdk_Pixbuf_Error_Properties.Property;

Property_Gdk_Pixbuf_Rotation

type Property_Gdk_Pixbuf_Rotation is new Gdk_Pixbuf_Rotation_Properties.Property;

Read_Pixel_Bytes

function Read_Pixel_Bytes
   (Self : not null access Gdk_Pixbuf_Record) return Glib.Bytes.Gbytes

Provides a Glib.Bytes.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. Since: gtk+ 2.32

Parameters

Self

Return Value

A new reference to a read-only copy of the pixel data. Note that for mutable pixbufs, this function will incur a one-time copy of the pixel data for conversion into the returned Glib.Bytes.Gbytes. Has transfer-ownership='full'.

Read_Pixels

function Read_Pixels
   (Self : not null access Gdk_Pixbuf_Record) return System.Address

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. Since: gtk+ 2.32

Parameters

Self

Return Value

a read-only pointer to the raw pixel data

Remove_Option

function Remove_Option
   (Self : not null access Gdk_Pixbuf_Record;
    Key  : UTF8_String) return Boolean

Removes the key/value pair option attached to a GdkPixbuf. Since: gtk+ 2.36

Parameters

Self
Key: a nul-terminated string representing the key to remove.

Return Value

TRUE if an option was removed, FALSE if not.

Rotate_Simple

function Rotate_Simple
   (Self  : not null access Gdk_Pixbuf_Record;
    Angle : Gdk_Pixbuf_Rotation) return Gdk_Pixbuf

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. Since: gtk+ 2.6

Parameters

Self
Angle: the angle to rotate by

Return Value

the new pixbuf. Has transfer-ownership='full'.

Rowstride_Property

Rowstride_Property : constant Glib.Properties.Property_Int;

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.

Saturate_And_Pixelate

procedure Saturate_And_Pixelate
   (Self       : not null access Gdk_Pixbuf_Record;
    Dest       : not null access Gdk_Pixbuf_Record'Class;
    Saturation : Gfloat;
    Pixelate   : Boolean)

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.

Parameters

Self
Dest: place to write modified version of Src
Saturation: saturation factor
Pixelate: whether to pixelate

Save_To_Bufferv

function Save_To_Bufferv
   (Self          : not null access Gdk_Pixbuf_Record;
    Buffer        : out System.Address;
    Buffer_Size   : out Gsize;
    The_Type      : UTF8_String;
    Option_Keys   : GNAT.Strings.String_List;
    Option_Values : GNAT.Strings.String_List;
    Error         : out Glib.Error.GError) return Boolean

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 [methodGdkpixbuf.Pixbuf.save_to_buffer] for more details. On success, Buffer is owned by the caller; release it with Glib.G_Free after consuming Buffer_Size bytes. Since: gtk+ 2.4

Parameters

Self
Buffer: location to receive a pointer to the new buffer.
Buffer_Size: location to receive the size of the new buffer.
The_Type: name of file format.
Option_Keys: name of options to set
Option_Values: values for named options
Error: the return location for a recoverable error

Return Value

whether an error was set

Save_To_Stream_Finish

function Save_To_Stream_Finish
   (Async_Result : Glib.G_Async_Result;
    Error        : out Glib.Error.GError) return Boolean

Finishes an asynchronous pixbuf save operation started with gdk_pixbuf_save_to_stream_async. Since: gtk+ 2.24

Parameters

Async_Result: a GAsyncResult
Error: the return location for a recoverable error

Return Value

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

Save_To_Streamv

function Save_To_Streamv
   (Self          : not null access Gdk_Pixbuf_Record;
    Stream        : not null access Glib.Output_Stream.Goutput_Stream_Record'Class;
    The_Type      : UTF8_String;
    Option_Keys   : GNAT.Strings.String_List;
    Option_Values : GNAT.Strings.String_List;
    Cancellable   : access Glib.Cancellable.Gcancellable_Record'Class;
    Error         : out Glib.Error.GError) return Boolean

Saves pixbuf to an output stream. Supported file formats are currently "jpeg", "tiff", "png", "ico" or "bmp". See [methodGdkpixbuf.Pixbuf.save_to_stream] for more details. Since: gtk+ 2.36

Parameters

Self
Stream: a GOutputStream to save the pixbuf to
The_Type: name of file format
Option_Keys: name of options to set
Option_Values: values for named options
Cancellable: optional GCancellable object, NULL to ignore
Error: the return location for a recoverable error

Return Value

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

Save_To_Streamv_Async

procedure Save_To_Streamv_Async
   (Self          : not null access Gdk_Pixbuf_Record;
    Stream        : not null access Glib.Output_Stream.Goutput_Stream_Record'Class;
    The_Type      : UTF8_String;
    Option_Keys   : GNAT.Strings.String_List;
    Option_Values : GNAT.Strings.String_List;
    Cancellable   : access Glib.Cancellable.Gcancellable_Record'Class;
    Callback      : Gasync_Ready_Callback)

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. Since: gtk+ 2.36

Parameters

Self
Stream: a GOutputStream to which to save the pixbuf
The_Type: name of file format
Option_Keys: name of options to set
Option_Values: values for named options
Cancellable: optional GCancellable object, NULL to ignore
Callback: a GAsyncReadyCallback to call when the pixbuf is saved

Savev

function Savev
   (Self          : not null access Gdk_Pixbuf_Record;
    Filename      : UTF8_String;
    The_Type      : UTF8_String;
    Option_Keys   : GNAT.Strings.String_List;
    Option_Values : GNAT.Strings.String_List;
    Error         : out Glib.Error.GError) return Boolean

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

Parameters

Self
Filename: name of file to save.
The_Type: name of file format.
Option_Keys: name of options to set
Option_Values: values for named options
Error: the return location for a recoverable error

Return Value

whether an error was set

Scale

procedure Scale
   (Self        : not null access Gdk_Pixbuf_Record;
    Dest        : not null access Gdk_Pixbuf_Record'Class;
    Dest_X      : Glib.Gint;
    Dest_Y      : Glib.Gint;
    Dest_Width  : Glib.Gint;
    Dest_Height : Glib.Gint;
    Offset_X    : Gdouble;
    Offset_Y    : Gdouble;
    Scale_X     : Gdouble;
    Scale_Y     : Gdouble;
    Interp_Type : Gdk_Interp_Type)

Creates a transformation of the source image Src by scaling by Scale_X and Scale_Y then translating by Offset_X and Offset_Y, then renders the rectangle (Dest_X, Dest_Y, Dest_Width, Dest_Height) of the resulting image onto the destination image replacing the previous contents. Try to use Gdk.Pixbuf.Scale_Simple first; this function is the industrial-strength power tool you can fall back to, if Gdk.Pixbuf.Scale_Simple isn't powerful enough. If the source rectangle overlaps the destination rectangle on the same pixbuf, it will be overwritten during the scaling which results in rendering artifacts.

Parameters

Self
Dest: the Gdk.Pixbuf.Gdk_Pixbuf into which to render the results
Dest_X: the left coordinate for region to render
Dest_Y: the top coordinate for region to render
Dest_Width: the width of the region to render
Dest_Height: the height of the region to render
Offset_X: the offset in the X direction (currently rounded to an integer)
Offset_Y: the offset in the Y direction (currently rounded to an integer)
Scale_X: the scale factor in the X direction
Scale_Y: the scale factor in the Y direction
Interp_Type: the interpolation type for the transformation.

Scale_Simple

function Scale_Simple
   (Self        : not null access Gdk_Pixbuf_Record;
    Dest_Width  : Glib.Gint;
    Dest_Height : Glib.Gint;
    Interp_Type : Gdk_Interp_Type) return Gdk_Pixbuf

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 [methodGdkpixbuf.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 [methodGdkpixbuf.Pixbuf.scale] and [methodGdkpixbuf.Pixbuf.composite].

Parameters

Self
Dest_Width: the width of destination image
Dest_Height: the height of destination image
Interp_Type: the interpolation type for the transformation.

Return Value

the new pixbuf. Has transfer-ownership='full'.

Set_Option

function Set_Option
   (Self  : not null access Gdk_Pixbuf_Record;
    Key   : UTF8_String;
    Value : UTF8_String) return Boolean

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. Since: gtk+ 2.2

Parameters

Self
Key: a nul-terminated string.
Value: a nul-terminated string.

Return Value

TRUE on success

Width_Property

Width_Property : constant Glib.Properties.Property_Int;

The number of columns of the pixbuf.