Pixbuf

A pixel buffer.

GdkPixbuf contains information about an image's pixel data, its color space, bits per sample, width and height, and the rowstride (the number of bytes between the start of one row and the start of the next).

Creating new `GdkPixbuf`

The most basic way to create a pixbuf is to wrap an existing pixel buffer with a [class@GdkPixbuf.Pixbuf] instance. You can use the [ctor@GdkPixbuf.Pixbuf.new_from_data] function to do this.

Every time you create a new GdkPixbuf instance for some data, you will need to specify the destroy notification function that will be called when the data buffer needs to be freed; this will happen when a GdkPixbuf is finalized by the reference counting functions. If you have a chunk of static data compiled into your application, you can pass in NULL as the destroy notification function so that the data will not be freed.

The [ctor@GdkPixbuf.Pixbuf.new] constructor function can be used as a convenience to create a pixbuf with an empty buffer; this is equivalent to allocating a data buffer using malloc() and then wrapping it with gdk_pixbuf_new_from_data(). The gdk_pixbuf_new() function will compute an optimal rowstride so that rendering can be performed with an efficient algorithm.

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

You can also copy an existing pixbuf with the [method@Pixbuf.copy] function. This is not the same as just acquiring a reference to the old pixbuf instance: the copy function will actually duplicate the pixel data in memory and create a new [class@Pixbuf] instance for it.

Reference counting

GdkPixbuf structures are reference counted. This means that an application can share a single pixbuf among many parts of the code. When a piece of the program needs to use a pixbuf, it should acquire a reference to it by calling g_object_ref(); when it no longer needs the pixbuf, it should release the reference it acquired by calling g_object_unref(). The resources associated with a GdkPixbuf will be freed when its reference count drops to zero. Newly-created GdkPixbuf instances start with a reference count of one.

Image Data

Image data in a pixbuf is stored in memory in an uncompressed, packed format. Rows in the image are stored top to bottom, and in each row pixels are stored from left to right.

There may be padding at the end of a row.

The "rowstride" value of a pixbuf, as returned by [method@GdkPixbuf.Pixbuf.get_rowstride], indicates the number of bytes between rows.

**NOTE**: If you are copying raw pixbuf data with memcpy() note that the last row in the pixbuf may not be as wide as the full rowstride, but rather just as wide as the pixel data needs to be; that is: it is unsafe to do memcpy (dest, pixels, rowstride * height) to copy a whole pixbuf. Use [method@GdkPixbuf.Pixbuf.copy] instead, or compute the width in bytes of the last row as:

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 [class@GdkPixbuf.PixbufLoader`] API for progressive image loading.

Saving images

The GdkPixbuf class provides methods for saving image data in a number of file formats. The formatted data can be written to a file or to a memory buffer. GdkPixbuf can also call a user-defined callback on the data, which allows to e.g. write the image to a socket or store it in a database.

class Pixbuf : ObjectG , IconIF , LoadableIconIF {

protected

GdkPixbuf* gdkPixbuf;

GdkPixbuf* getPixbufStruct(bool transferOwnership);

void* getStruct();

this(GdkPixbuf* gdkPixbuf, bool ownedRef);

mixin IconT!(GdkPixbuf) ;

mixin LoadableIconT!(GdkPixbuf) ;

bool saveToBuffer(ubyte[] buffer, string type, string[] optionKeys, string[] optionValues);

static Pixbuf newFromResource(string resourcePath);

static Pixbuf newFromResource(string resourcePath, int width, int height, bool preserveAspectRatio);

char* getPixels();

static GType getType();

this(GdkColorspace colorspace, bool hasAlpha, int bitsPerSample, int width, int height);

this(Bytes data, GdkColorspace colorspace, bool hasAlpha, int bitsPerSample, int width, int height, int rowstride);

this(char[] data, GdkColorspace colorspace, bool hasAlpha, int bitsPerSample, int width, int height, int rowstride, GdkPixbufDestroyNotify destroyFn, void* destroyFnData);

this(string filename);

this(string filename, int width, int height, bool preserveAspectRatio);

this(string filename, int width, int height);

this(ubyte[] data, bool copyPixels);

this(InputStream stream, Cancellable cancellable);

this(InputStream stream, int width, int height, bool preserveAspectRatio, Cancellable cancellable);

this(AsyncResultIF asyncResult);

this(string[] data);

static int calculateRowstride(GdkColorspace colorspace, bool hasAlpha, int bitsPerSample, int width, int height);

static PixbufFormat getFileInfo(string filename, int width, int height);

static void getFileInfoAsync(string filename, Cancellable cancellable, GAsyncReadyCallback callback, void* userData);

static PixbufFormat getFileInfoFinish(AsyncResultIF asyncResult, int width, int height);

static ListSG getFormats();

static bool initModules(string path);

static void newFromStreamAsync(InputStream stream, Cancellable cancellable, GAsyncReadyCallback callback, void* userData);

static void newFromStreamAtScaleAsync(InputStream stream, int width, int height, bool preserveAspectRatio, Cancellable cancellable, GAsyncReadyCallback callback, void* userData);

static bool saveToStreamFinish(AsyncResultIF asyncResult);

Pixbuf addAlpha(bool substituteColor, char r, char g, char b);

Pixbuf applyEmbeddedOrientation();

void composite(Pixbuf dest, int destX, int destY, int destWidth, int destHeight, double offsetX, double offsetY, double scaleX, double scaleY, GdkInterpType interpType, int overallAlpha);

void compositeColor(Pixbuf dest, int destX, int destY, int destWidth, int destHeight, double offsetX, double offsetY, double scaleX, double scaleY, GdkInterpType interpType, int overallAlpha, int checkX, int checkY, int checkSize, uint color1, uint color2);

Pixbuf compositeColorSimple(int destWidth, int destHeight, GdkInterpType interpType, int overallAlpha, int checkSize, uint color1, uint color2);

Pixbuf copy();

void copyArea(int srcX, int srcY, int width, int height, Pixbuf destPixbuf, int destX, int destY);

bool copyOptions(Pixbuf destPixbuf);

void fill(uint pixel);

Pixbuf flip(bool horizontal);

int getBitsPerSample();

size_t getByteLength();

GdkColorspace getColorspace();

bool getHasAlpha();

int getHeight();

int getNChannels();

string getOption(string key);

HashTable getOptions();

char[] getPixelsWithLength();

int getRowstride();

int getWidth();

Pixbuf newSubpixbuf(int srcX, int srcY, int width, int height);

Bytes readPixelBytes();

ubyte* readPixels();

bool removeOption(string key);

Pixbuf rotateSimple(GdkPixbufRotation angle);

void saturateAndPixelate(Pixbuf dest, float saturation, bool pixelate);

bool saveToCallbackv(GdkPixbufSaveFunc saveFunc, void* userData, string type, string[] optionKeys, string[] optionValues);

bool saveToStreamv(OutputStream stream, string type, string[] optionKeys, string[] optionValues, Cancellable cancellable);

void saveToStreamvAsync(OutputStream stream, string type, string[] optionKeys, string[] optionValues, Cancellable cancellable, GAsyncReadyCallback callback, void* userData);

bool savev(string filename, string type, string[] optionKeys, string[] optionValues);

void scale(Pixbuf dest, int destX, int destY, int destWidth, int destHeight, double offsetX, double offsetY, double scaleX, double scaleY, GdkInterpType interpType);

Pixbuf scaleSimple(int destWidth, int destHeight, GdkInterpType interpType);

bool setOption(string key, string value);

}

Constructors

this this(GdkPixbuf* gdkPixbuf, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(GdkColorspace colorspace, bool hasAlpha, int bitsPerSample, int width, int height): Creates a new GdkPixbuf structure and allocates a buffer for it.
this this(Bytes data, GdkColorspace colorspace, bool hasAlpha, int bitsPerSample, int width, int height, int rowstride): Creates a new #GdkPixbuf out of in-memory readonly image data.
this this(char[] data, GdkColorspace colorspace, bool hasAlpha, int bitsPerSample, int width, int height, int rowstride, GdkPixbufDestroyNotify destroyFn, void* destroyFnData): Creates a new #GdkPixbuf out of in-memory image data.
this this(string filename): Creates a new pixbuf by loading an image from a file.
this this(string filename, int width, int height, bool preserveAspectRatio): Creates a new pixbuf by loading an image from a file.
this this(string filename, int width, int height): Creates a new pixbuf by loading an image from a file.
this this(ubyte[] data, bool copyPixels): Creates a GdkPixbuf from a flat representation that is suitable for storing as inline data in a program.
this this(InputStream stream, Cancellable cancellable): Creates a new pixbuf by loading an image from an input stream.
this this(InputStream stream, int width, int height, bool preserveAspectRatio, Cancellable cancellable): Creates a new pixbuf by loading an image from an input stream.
this this(AsyncResultIF asyncResult): Finishes an asynchronous pixbuf creation operation started with gdk_pixbuf_new_from_stream_async().
this this(string[] data): Creates a new pixbuf by parsing XPM data in memory.

Members

Functions

addAlpha Pixbuf addAlpha(bool substituteColor, char r, char g, char b): Takes an existing pixbuf and adds an alpha channel to it.
applyEmbeddedOrientation Pixbuf applyEmbeddedOrientation(): Takes an existing pixbuf and checks for the presence of an associated "orientation" option.
composite void composite(Pixbuf dest, int destX, int destY, int destWidth, int destHeight, double offsetX, double offsetY, double scaleX, double scaleY, GdkInterpType interpType, int overallAlpha): Creates a transformation of the source image @src by scaling by @scale_x and @scale_y then translating by @offset_x and @offset_y.
compositeColor void compositeColor(Pixbuf dest, int destX, int destY, int destWidth, int destHeight, double offsetX, double offsetY, double scaleX, double scaleY, GdkInterpType interpType, int overallAlpha, int checkX, int checkY, int checkSize, uint color1, uint color2): 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.
compositeColorSimple Pixbuf compositeColorSimple(int destWidth, int destHeight, GdkInterpType interpType, int overallAlpha, int checkSize, uint color1, uint color2): 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.
copy Pixbuf copy(): Creates a new GdkPixbuf with a copy of the information in the specified pixbuf.
copyArea void copyArea(int srcX, int srcY, int width, int height, Pixbuf destPixbuf, int destX, int destY): Copies a rectangular area from src_pixbuf to dest_pixbuf.
copyOptions bool copyOptions(Pixbuf destPixbuf): Copies the key/value pair options attached to a GdkPixbuf to another GdkPixbuf.
fill void fill(uint pixel): Clears a pixbuf to the given RGBA value, converting the RGBA value into the pixbuf's pixel format.
flip Pixbuf flip(bool horizontal): Flips a pixbuf horizontally or vertically and returns the result in a new pixbuf.
getBitsPerSample int getBitsPerSample(): Queries the number of bits per color sample in a pixbuf.
getByteLength size_t getByteLength(): Returns the length of the pixel data, in bytes.
getColorspace GdkColorspace getColorspace(): Queries the color space of a pixbuf.
getHasAlpha bool getHasAlpha(): Queries whether a pixbuf has an alpha channel (opacity information).
getHeight int getHeight(): Queries the height of a pixbuf.
getNChannels int getNChannels(): Queries the number of channels of a pixbuf.
getOption string getOption(string key): 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().
getOptions HashTable getOptions(): Returns a GHashTable with a list of all the options that may have been attached to the pixbuf when it was loaded, or that may have been attached by another function using [method@GdkPixbuf.Pixbuf.set_option].
getPixbufStruct GdkPixbuf* getPixbufStruct(bool transferOwnership): Get the main Gtk struct
getPixels char* getPixels(): Queries a pointer to the pixel data of a pixbuf.
getPixelsWithLength char[] getPixelsWithLength(): Queries a pointer to the pixel data of a pixbuf.
getRowstride int getRowstride(): 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.
getStruct void* getStruct(): the main Gtk struct as a void*
getWidth int getWidth(): Queries the width of a pixbuf.
newSubpixbuf Pixbuf newSubpixbuf(int srcX, int srcY, int width, int height): Creates a new pixbuf which represents a sub-region of src_pixbuf.
readPixelBytes Bytes readPixelBytes(): Provides a #GBytes buffer containing the raw pixel data; the data must not be modified.
readPixels ubyte* readPixels(): Provides a read-only pointer to the raw pixel data.
removeOption bool removeOption(string key): Removes the key/value pair option attached to a GdkPixbuf.
rotateSimple Pixbuf rotateSimple(GdkPixbufRotation angle): Rotates a pixbuf by a multiple of 90 degrees, and returns the result in a new pixbuf.
saturateAndPixelate void saturateAndPixelate(Pixbuf dest, float saturation, bool pixelate): Modifies saturation and optionally pixelates src, placing the result in dest.
saveToBuffer bool saveToBuffer(ubyte[] buffer, string type, string[] optionKeys, string[] optionValues): Saves pixbuf to a new buffer in format @type, which is currently "jpeg", "tiff", "png", "ico" or "bmp". See gdk_pixbuf_save_to_buffer() for more details.
saveToCallbackv bool saveToCallbackv(GdkPixbufSaveFunc saveFunc, void* userData, string type, string[] optionKeys, string[] optionValues): Vector version of gdk_pixbuf_save_to_callback().
saveToStreamv bool saveToStreamv(OutputStream stream, string type, string[] optionKeys, string[] optionValues, Cancellable cancellable): Saves pixbuf to an output stream.
saveToStreamvAsync void saveToStreamvAsync(OutputStream stream, string type, string[] optionKeys, string[] optionValues, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Saves pixbuf to an output stream asynchronously.
savev bool savev(string filename, string type, string[] optionKeys, string[] optionValues): Vector version of gdk_pixbuf_save().
scale void scale(Pixbuf dest, int destX, int destY, int destWidth, int destHeight, double offsetX, double offsetY, double scaleX, double scaleY, GdkInterpType interpType): 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.
scaleSimple Pixbuf scaleSimple(int destWidth, int destHeight, GdkInterpType interpType): Create a new pixbuf containing a copy of src scaled to dest_width x dest_height.
setOption bool setOption(string key, string value): Attaches a key/value pair as an option to a GdkPixbuf.

Mixins

__anonymous mixin IconT!(GdkPixbuf): Undocumented in source.
__anonymous mixin LoadableIconT!(GdkPixbuf): Undocumented in source.

Static functions

calculateRowstride int calculateRowstride(GdkColorspace colorspace, bool hasAlpha, int bitsPerSample, int width, int height): Calculates the rowstride that an image created with those values would have.
getFileInfo PixbufFormat getFileInfo(string filename, int width, int height): Parses an image file far enough to determine its format and size.
getFileInfoAsync void getFileInfoAsync(string filename, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Asynchronously parses an image file far enough to determine its format and size.
getFileInfoFinish PixbufFormat getFileInfoFinish(AsyncResultIF asyncResult, int width, int height): Finishes an asynchronous pixbuf parsing operation started with gdk_pixbuf_get_file_info_async().
getFormats ListSG getFormats(): Obtains the available information about the image formats supported by GdkPixbuf.
getType GType getType()
initModules bool initModules(string path): Initalizes the gdk-pixbuf loader modules referenced by the loaders.cache file present inside that directory.
newFromResource Pixbuf newFromResource(string resourcePath): Creates a new pixbuf by loading an image from an resource.
newFromResource Pixbuf newFromResource(string resourcePath, int width, int height, bool preserveAspectRatio): Creates a new pixbuf by loading an image from an resource.
newFromStreamAsync void newFromStreamAsync(InputStream stream, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Creates a new pixbuf by asynchronously loading an image from an input stream.
newFromStreamAtScaleAsync void newFromStreamAtScaleAsync(InputStream stream, int width, int height, bool preserveAspectRatio, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Creates a new pixbuf by asynchronously loading an image from an input stream.
saveToStreamFinish bool saveToStreamFinish(AsyncResultIF asyncResult): Finishes an asynchronous pixbuf save operation started with gdk_pixbuf_save_to_stream_async().

Variables

gdkPixbuf GdkPixbuf* gdkPixbuf;: the main Gtk struct

Inherited Members

From ObjectG

gObject GObject* gObject;: the main Gtk struct
ownedRef bool ownedRef;: Undocumented in source.
getObjectGStruct GObject* getObjectGStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
isGcRoot bool isGcRoot;: Undocumented in source.
signals DClosure[gulong] signals;: Undocumented in source.
destroyNotify void destroyNotify(ObjectG obj): Undocumented in source. Be warned that the author may not have intended to support it.
toggleNotify void toggleNotify(ObjectG obj, GObject* object, int isLastRef): Undocumented in source. Be warned that the author may not have intended to support it.
~this ~this(): Undocumented in source.
opCast T opCast()
getDObject RT getDObject(U obj, bool ownedRef): Gets a D Object from the objects table of associations.
removeGcRoot void removeGcRoot(): Undocumented in source. Be warned that the author may not have intended to support it.
setProperty void setProperty(string propertyName, T value)
unref deprecated void unref(ObjectG obj): Undocumented in source. Be warned that the author may not have intended to support it.
doref deprecated ObjectG doref(ObjectG obj): Undocumented in source. Be warned that the author may not have intended to support it.
addOnNotify gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property, ConnectFlags connectFlags): The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.
getType GType getType()
compatControl size_t compatControl(size_t what, void* data)
interfaceFindProperty ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName): Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
interfaceInstallProperty void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec): Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
interfaceListProperties ParamSpec[] interfaceListProperties(TypeInterface gIface): Lists the properties of an interface.Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
addToggleRef void addToggleRef(GToggleNotify notify, void* data): Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.
addWeakPointer void addWeakPointer(void* weakPointerLocation): Adds a weak reference from weak_pointer to @object to indicate that the pointer located at @weak_pointer_location is only valid during the lifetime of @object. When the @object is finalized, @weak_pointer will be set to %NULL.
bindProperty Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags): Creates a binding between @source_property on @source and @target_property on @target. Whenever the @source_property is changed the @target_property is updated using the same value. For instance:
bindPropertyFull Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify): Complete version of g_object_bind_property().
bindPropertyWithClosures Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, Closure transformFrom): Creates a binding between @source_property on @source and @target_property on @target, allowing you to set the transformation functions to be used by the binding.
dupData void* dupData(string key, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_data() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
dupQdata void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
freezeNotify void freezeNotify(): Increases the freeze count on @object. If the freeze count is non-zero, the emission of "notify" signals on @object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see g_object_set_data()).
getProperty void getProperty(string propertyName, Value value): Gets a property of an object.
getQdata void* getQdata(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata().
getValist void getValist(string firstPropertyName, void* varArgs): Gets properties of an object.
getv void getv(string[] names, Value[] values): Gets @n_properties properties for an @object. Obtained properties will be set to @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether @object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property @property_name on @object.
notifyByPspec void notifyByPspec(ParamSpec pspec): Emits a "notify" signal for the property specified by @pspec on @object.
doref alias doref = ref_: Undocumented in source.
ref_ ObjectG ref_(): Increases the reference count of @object.
refSink ObjectG refSink(): Increase the reference count of @object, and possibly remove the floating[floating-ref] reference, if @object has a floating reference.
removeToggleRef void removeToggleRef(GToggleNotify notify, void* data): Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.
removeWeakPointer void removeWeakPointer(void* weakPointerLocation): Removes a weak reference from @object that was previously added using g_object_add_weak_pointer(). The @weak_pointer_location has to match the one used with g_object_add_weak_pointer().
replaceData bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key @key on @object with @oldval, and if they are the same, replaces @oldval with @newval.
replaceQdata bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key @quark on @object with @oldval, and if they are the same, replaces @oldval with @newval.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setDataFull void setDataFull(string key, void* data, GDestroyNotify destroy): Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.
setProperty void setProperty(string propertyName, Value value): Sets a property on an object.
setQdata void setQdata(GQuark quark, void* data): This sets an opaque, named pointer on an object. The name is specified through a #GQuark (retrieved e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the @object with g_object_get_qdata() until the @object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using #NULL as pointer essentially removes the data stored.
setQdataFull void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy): This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with @data as argument when the @object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same @quark.
setValist void setValist(string firstPropertyName, void* varArgs): Sets properties on an object.
setv void setv(string[] names, Value[] values): Sets @n_properties properties for an @object. Properties to be set will be taken from @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata() and removes the @data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example: |[ void object_add_to_user_list (GObject *object, const gchar *new_string) { // the quark, naming the object data GQuark quark_string_list = g_quark_from_static_string ("my-string-list"); // retrieve the old string list GList *list = g_object_steal_qdata (object, quark_string_list);
thawNotify void thawNotify(): Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on @object and when it reaches zero, queued "notify" signals are emitted.
unref void unref(): Decreases the reference count of @object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).
watchClosure void watchClosure(Closure closure): This function essentially limits the life time of the @closure to the life time of the object. That is, when the object is finalized, the @closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the @closure, to ensure that an extra reference count is held on @object during invocation of the @closure. Usually, this function will be called on closures that use this @object as closure data.
weakRef void weakRef(GWeakNotify notify, void* data): Adds a weak reference callback to an object. Weak references are used for notification when an object is disposed. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).
weakUnref void weakUnref(GWeakNotify notify, void* data): Removes a weak reference callback to an object.
clearObject void clearObject(ObjectG objectPtr): Clears a reference to a #GObject.

From IconIF

getIconStruct GIcon* getIconStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
deserialize IconIF deserialize(Variant value): Deserializes a #GIcon previously serialized using g_icon_serialize().
hash uint hash(void* icon): Gets a hash for an icon.
equal bool equal(IconIF icon2): Checks if two icons are equal.
serialize Variant serialize(): Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved back by calling g_icon_deserialize() on the returned value. As serialization will avoid using raw icon data when possible, it only makes sense to transfer the #GVariant between processes on the same machine, (as opposed to over the network), and within the same file system namespace.
toString string toString(): Generates a textual representation of @icon that can be used for serialization such as when passing @icon to a different process or saving it to persistent storage. Use g_icon_new_for_string() to get @icon back from the returned string.

From LoadableIconIF

getLoadableIconStruct GLoadableIcon* getLoadableIconStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
load InputStream load(int size, string type, Cancellable cancellable): Loads a loadable icon. For the asynchronous version of this function, see g_loadable_icon_load_async().
loadAsync void loadAsync(int size, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Loads an icon asynchronously. To finish this function, see g_loadable_icon_load_finish(). For the synchronous, blocking version of this function, see g_loadable_icon_load().
loadFinish InputStream loadFinish(AsyncResultIF res, string type): Finishes an asynchronous icon load started in g_loadable_icon_load_async().

Pixbuf

Creating new `GdkPixbuf`

Reference counting

Image Data

Loading images

Saving images

Constructors

Members

Functions

Mixins

Static functions

Variables

Inherited Members

From ObjectG

From IconIF

From LoadableIconIF

Meta

Source

Pixbuf

Creating new GdkPixbuf

Creating new `GdkPixbuf`