Pixbuf

This is the main structure in the gdk-pixbuf library. It is used to represent images. It contains information about the 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).

class Pixbuf : ObjectG , IconIF , LoadableIconIF {}

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. The buffer has an optimal rowstride. Note that the buffer is not cleared; you will have to fill it completely yourself.

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. Currently only RGB images with 8 bits per sample are supported. This is the #GBytes variant of gdk_pixbuf_new_from_data().

this
this(string 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. Currently only RGB images with 8 bits per sample are supported.

this
this(string filename)

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 in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.

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

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 in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains. The image will be scaled to fit in the requested size, optionally preserving the image's aspect ratio.

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

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 in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.

this
this(ubyte[] data, bool copyPixels)

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

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. This data is commonly the result of including an XPM file into a program's C source.

Members

Functions

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

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

applyEmbeddedOrientation
Pixbuf applyEmbeddedOrientation()

Takes an existing pixbuf and checks for the presence of an associated "orientation" option, which 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.

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. This gives an image in the coordinates of the destination pixbuf. The rectangle (@dest_x, @dest_y, @dest_width, @dest_height) is then composited onto the corresponding rectangle of the original destination image.

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 composites 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 #GdkPixbuf by scaling @src to @dest_width x @dest_height and compositing 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. Conversion of pixbuf formats is done automatically.

fill
void fill(uint pixel)

Clears a pixbuf to the given RGBA value, converting the RGBA value into the pixbuf's pixel format. The alpha will be ignored if the pixbuf doesn't have an alpha channel.

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

getPixbufStruct
GdkPixbuf* getPixbufStruct()

Get the main Gtk struct

getPixels
string getPixels()

Queries a pointer to the pixel data of a pixbuf.

getPixelsWithLength
string 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. 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.

readPixelBytes
Bytes readPixelBytes()

Return: 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 #GBytes.

readPixels
ubyte* readPixels()

Returns a read-only pointer to the raw pixel 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.

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. @src and @dest 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. @src and @dest must have the same image format, size, and rowstride.

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)

Saves pixbuf to a callback in format @type, which is currently "jpeg", "png", "tiff", "ico" or "bmp". If @error is set, %FALSE will be returned. See gdk_pixbuf_save_to_callback () for more details.

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

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 gdk_pixbuf_save () for more details.

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 #GdkPixbuf containing a copy of @src scaled to @dest_width x @dest_height. Leaves @src unaffected. @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.

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.

Mixins

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

Static functions

fromPixdata
Pixbuf fromPixdata(Pixdata pixdata, bool copyPixels)

Converts a #GdkPixdata to a #GdkPixbuf. If @copy_pixels is %TRUE or if the pixel data is run-length-encoded, the pixel data is copied into newly-allocated memory; otherwise it is reused.

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()
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

getObjectGStruct
GObject* getObjectGStruct()

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

isGcRoot
bool isGcRoot;
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.
getDObject
RT getDObject(U obj, bool ownedRef)

Gets a D Object from the objects table of associations.

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
setProperty
void setProperty(string propertyName, int value)
setProperty
void setProperty(string propertyName, string value)
setProperty
void setProperty(string propertyName, long value)
setProperty
void setProperty(string propertyName, ulong 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.
connectedSignals
int[string] connectedSignals;
Undocumented in source.
onNotifyListeners
void delegate(ParamSpec, ObjectG)[] onNotifyListeners;
Undocumented in source.
addOnNotify
void 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.

callBackNotify
void callBackNotify(GObject* gobjectStruct, GParamSpec* pspec, ObjectG _objectG)
Undocumented in source. Be warned that the author may not have intended to support it.
getType
GType getType()
compatControl
size_t compatControl(size_t what, void* data)
Undocumented in source. Be warned that the author may not have intended to support it.
interfaceFindProperty
ParamSpec interfaceFindProperty(void* 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(void* 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(void* 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. @value must have been initialized to the expected type of the property (or a type to which the expected type can be transformed) using g_value_init().

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.

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
ObjectG doref()

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 (retrived 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.

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: |[<!-- language="C" --> 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"); // retrive 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 finalized. 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()

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

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()

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

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

Meta