Pixbuf.this

gdkpixbuf Pixbuf Pixbuf

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.

  1. this(GdkPixbuf* gdkPixbuf, bool ownedRef)
  2. this(GdkColorspace colorspace, bool hasAlpha, int bitsPerSample, int width, int height)
  3. this(Bytes data, GdkColorspace colorspace, bool hasAlpha, int bitsPerSample, int width, int height, int rowstride)
  4. this(char[] data, GdkColorspace colorspace, bool hasAlpha, int bitsPerSample, int width, int height, int rowstride, GdkPixbufDestroyNotify destroyFn, void* destroyFnData)
  5. this(string filename)
  6. this(string filename, int width, int height, bool preserveAspectRatio)
  7. this(string filename, int width, int height)
  8. this(ubyte[] data, bool copyPixels)
  9. this(InputStream stream, Cancellable cancellable)
  10. this(InputStream stream, int width, int height, bool preserveAspectRatio, Cancellable cancellable)
    class Pixbuf
  11. this(AsyncResultIF asyncResult)
  12. this(string[] data)

Parameters

stream InputStream

a gio.InputStream to load the pixbuf from

width int

The width the image should have or -1 to not constrain the width

height int

The height the image should have or -1 to not constrain the height

preserveAspectRatio bool

TRUE to preserve the image's aspect ratio

cancellable Cancellable

optional gio.Cancellable object, NULL to ignore

Return Value

A newly-created pixbuf, or NULL if any of several error conditions occurred: the file could not be opened, the image format is not supported, there was not enough memory to allocate the image buffer, the stream contained invalid data, or the operation was cancelled.

Throws

GException on failure. ConstructionException GTK+ fails to create the object.

Meta

Since

2.14

gdkpixbuf Pixbuf Pixbuf constructorsfunctionsstatic functionsvariables
Page generated by adrdox