Pixbuf

open class Pixbuf : GLibObject.Object, PixbufProtocol

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 usingmalloc()and then wrapping it withgdk_pixbuf_new_from_data(). Thegdk_pixbuf_new()“ function will compute an optimal rowstride so that rendering can be performed with an efficient algorithm.

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

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:

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.

static void
put_pixel (GdkPixbuf *pixbuf,
           int x,
       int y,
       guchar red,
       guchar green,
       guchar blue,
       guchar alpha)
{
  int n_channels = gdk_pixbuf_get_n_channels (pixbuf);

  // Ensure that the pixbuf is valid
  g_assert (gdk_pixbuf_get_colorspace (pixbuf) == GDK_COLORSPACE_RGB);
  g_assert (gdk_pixbuf_get_bits_per_sample (pixbuf) == 8);
  g_assert (gdk_pixbuf_get_has_alpha (pixbuf));
  g_assert (n_channels == 4);

  int width = gdk_pixbuf_get_width (pixbuf);
  int height = gdk_pixbuf_get_height (pixbuf);

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

  int rowstride = gdk_pixbuf_get_rowstride (pixbuf);

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

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

Loading images

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

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

Additionally, GdkPixbuf provides the [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.

The Pixbuf type acts as a reference-counted owner of an underlying GdkPixbuf instance. It provides the methods that can operate on this data type through PixbufProtocol conformance. Use Pixbuf as a strong reference or owner of a GdkPixbuf instance.

Show on GitHub 
  • Designated initialiser from the underlying `C` data type.

    This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Pixbuf instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafeMutablePointer<GdkPixbuf>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Pixbuf instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafePointer<GdkPixbuf>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Pixbuf instance.

    Declaration

    Swift

    @inlinable
override public init!(gpointer op: gpointer?)

    Parameters

    op

    gpointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gconstpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Pixbuf instance.

    Declaration

    Swift

    @inlinable
override public init!(gconstpointer op: gconstpointer?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Pixbuf instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafePointer<GdkPixbuf>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Pixbuf instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafeMutablePointer<GdkPixbuf>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from the underlying C data type. Will retain GdkPixbuf. i.e., ownership is transferred to the Pixbuf instance.

    Declaration

    Swift

    @inlinable
public init(retaining op: UnsafeMutablePointer<GdkPixbuf>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Reference intialiser for a related type that implements PixbufProtocol Will retain GdkPixbuf.

    Declaration

    Swift

    @inlinable
public init<T>(pixbuf other: T) where T : PixbufProtocol

    Parameters

    other

    an instance of a related type that implements PixbufProtocol
    Show on GitHub

  • Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to PixbufProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(cPointer p: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe typed, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to PixbufProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(retainingCPointer cPointer: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to PixbufProtocol.

    Declaration

    Swift

    @inlinable
override public init(raw p: UnsafeRawPointer)

    Parameters

    p

    raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to PixbufProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingRaw raw: UnsafeRawPointer)
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to PixbufProtocol.

    Declaration

    Swift

    @inlinable
public required init(raw p: UnsafeMutableRawPointer)

    Parameters

    p

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to PixbufProtocol.

    Declaration

    Swift

    @inlinable
required public init(retainingRaw raw: UnsafeMutableRawPointer)

    Parameters

    raw

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to PixbufProtocol.

    Declaration

    Swift

    @inlinable
override public init(opaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to PixbufProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingOpaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public init(colorspace: GdkColorspace, hasAlpha: Bool, bitsPerSample: Int, width: Int, height: Int)
    Show on GitHub

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

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

    This is the GBytes variant of gdk_pixbuf_new_from_data(), useful for language bindings.

    Declaration

    Swift

    @inlinable
public init<GLibBytesT>(bytes data: GLibBytesT, colorspace: GdkColorspace, hasAlpha: Bool, bitsPerSample: Int, width: Int, height: Int, rowstride: Int) where GLibBytesT : BytesProtocol
    Show on GitHub

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

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

    Since you are providing a pre-allocated pixel buffer, you must also specify a way to free that data. This is done with a function of type GdkPixbufDestroyNotify. When a pixbuf created with is finalized, your destroy notification function will be called, and it is its responsibility to free the pixel array.

    See also: [ctorGdkPixbuf.Pixbuf.new_from_bytes]

    Declaration

    Swift

    @inlinable
public init(data: UnsafePointer<guchar>!, colorspace: GdkColorspace, hasAlpha: Bool, bitsPerSample: Int, width: Int, height: Int, rowstride: Int, destroyFn: GdkPixbufDestroyNotify? = nil, destroyFnData: gpointer? = nil)
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public init(file filename: UnsafePointer<CChar>!) throws
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public init(fileAtScale filename: UnsafePointer<CChar>!, width: Int, height: Int, preserveAspectRatio: Bool) throws
    Show on GitHub

  • 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].

    Declaration

    Swift

    @inlinable
public init(fileAtSize filename: UnsafePointer<CChar>!, width: Int, height: Int) throws
    Show on GitHub

  • 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:

    pixbuf = gdk_pixbuf_new_from_inline (-1, myimage_inline, FALSE, NULL);

    For non-const inline data, you could get out of memory. For untrusted inline data located at runtime, you could have corrupt inline data in addition.

    new_from_inline is deprecated: Use GResource instead.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
public init(inline dataLength: Int, data: UnsafePointer<guint8>!, copyPixels: Bool) throws
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public init(resource resourcePath: UnsafePointer<CChar>!) throws
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public init(resourceAtScale resourcePath: UnsafePointer<CChar>!, width: Int, height: Int, preserveAspectRatio: Bool) throws
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public init<GioCancellableT, GioInputStreamT>(stream: GioInputStreamT, cancellable: GioCancellableT?) throws where GioCancellableT : CancellableProtocol, GioInputStreamT : InputStreamProtocol
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public init<GioCancellableT, GioInputStreamT>(streamAtScale stream: GioInputStreamT, width: Int, height: Int, preserveAspectRatio: Bool, cancellable: GioCancellableT?) throws where GioCancellableT : CancellableProtocol, GioInputStreamT : InputStreamProtocol
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public init<GioAsyncResultT>(streamFinish asyncResult: GioAsyncResultT) throws where GioAsyncResultT : AsyncResultProtocol
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public init(xpmData data: UnsafeMutablePointer<UnsafePointer<CChar>?>!)
    Show on GitHub

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

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

    This is the GBytes variant of gdk_pixbuf_new_from_data(), useful for language bindings.

    Declaration

    Swift

    @inlinable
public static func newFrom<GLibBytesT>(bytes data: GLibBytesT, colorspace: GdkColorspace, hasAlpha: Bool, bitsPerSample: Int, width: Int, height: Int, rowstride: Int) -> GdkPixBuf.Pixbuf! where GLibBytesT : BytesProtocol
    Show on GitHub

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

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

    Since you are providing a pre-allocated pixel buffer, you must also specify a way to free that data. This is done with a function of type GdkPixbufDestroyNotify. When a pixbuf created with is finalized, your destroy notification function will be called, and it is its responsibility to free the pixel array.

    See also: [ctorGdkPixbuf.Pixbuf.new_from_bytes]

    Declaration

    Swift

    @inlinable
public static func newFrom(data: UnsafePointer<guchar>!, colorspace: GdkColorspace, hasAlpha: Bool, bitsPerSample: Int, width: Int, height: Int, rowstride: Int, destroyFn: GdkPixbufDestroyNotify? = nil, destroyFnData: gpointer? = nil) -> GdkPixBuf.Pixbuf!
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public static func newFrom(file filename: UnsafePointer<CChar>!) throws -> GdkPixBuf.Pixbuf!
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public static func newFrom(fileAtScale filename: UnsafePointer<CChar>!, width: Int, height: Int, preserveAspectRatio: Bool) throws -> GdkPixBuf.Pixbuf!
    Show on GitHub

  • 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].

    Declaration

    Swift

    @inlinable
public static func newFrom(fileAtSize filename: UnsafePointer<CChar>!, width: Int, height: Int) throws -> GdkPixBuf.Pixbuf!
    Show on GitHub

  • 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:

    pixbuf = gdk_pixbuf_new_from_inline (-1, myimage_inline, FALSE, NULL);

    For non-const inline data, you could get out of memory. For untrusted inline data located at runtime, you could have corrupt inline data in addition.

    new_from_inline is deprecated: Use GResource instead.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
public static func newFrom(inline dataLength: Int, data: UnsafePointer<guint8>!, copyPixels: Bool) throws -> GdkPixBuf.Pixbuf!
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public static func newFrom(resource resourcePath: UnsafePointer<CChar>!) throws -> GdkPixBuf.Pixbuf!
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public static func newFrom(resourceAtScale resourcePath: UnsafePointer<CChar>!, width: Int, height: Int, preserveAspectRatio: Bool) throws -> GdkPixBuf.Pixbuf!
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public static func newFrom<GioCancellableT, GioInputStreamT>(stream: GioInputStreamT, cancellable: GioCancellableT?) throws -> GdkPixBuf.Pixbuf! where GioCancellableT : CancellableProtocol, GioInputStreamT : InputStreamProtocol
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public static func newFrom<GioCancellableT, GioInputStreamT>(streamAtScale stream: GioInputStreamT, width: Int, height: Int, preserveAspectRatio: Bool, cancellable: GioCancellableT?) throws -> GdkPixBuf.Pixbuf! where GioCancellableT : CancellableProtocol, GioInputStreamT : InputStreamProtocol
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public static func newFrom<GioAsyncResultT>(streamFinish asyncResult: GioAsyncResultT) throws -> GdkPixBuf.Pixbuf! where GioAsyncResultT : AsyncResultProtocol
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public static func newFromXpm(xpmData data: UnsafeMutablePointer<UnsafePointer<CChar>?>!) -> GdkPixBuf.Pixbuf!
    Show on GitHub