gtkmm: Gdk::Pixbuf Class Reference

Inheritance diagram for Gdk::Pixbuf:

Collaboration diagram for Gdk::Pixbuf:

Public Types
typedef sigc::slot< void, const guint8* >	SlotDestroyData

typedef Glib::SListHandle< Glib::RefPtr< PixbufFormat >, PixbufFormatTraits >	SListHandle_PixbufFormat

Public Types inherited from Glib::Object
typedef void(*)(gpointer data	DestroyNotify)

Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify	func_destroy_notify

Public Member Functions
	Pixbuf (Pixbuf&& src) noexcept

Pixbuf&	operator= (Pixbuf&& src) noexcept

	~Pixbuf () noexceptoverride

GdkPixbuf*	gobj ()
	Provides access to the underlying C GObject. More...

const GdkPixbuf*	gobj () const
	Provides access to the underlying C GObject. More...

GdkPixbuf*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

Glib::RefPtr< Pixbuf >	copy () const

Colorspace	get_colorspace () const

int	get_n_channels () const

bool	get_has_alpha () const

int	get_bits_per_sample () const

guint8*	get_pixels () const

int	get_width () const

int	get_height () const

int	get_rowstride () const

void	fill (guint32 pixel)

void	save (const std::string& filename, const Glib::ustring& type)
	Saves pixbuf to a file in format type. More...

void	save (const std::string& filename, const Glib::ustring& type, const Glib::StringArrayHandle& option_keys, const Glib::StringArrayHandle& option_values)
	Saves pixbuf to a file in format type. More...

void	save_to_buffer (gchar*& buffer, gsize& buffer_size, const Glib::ustring& type="png")

void	save_to_buffer (gchar*& buffer, gsize& buffer_size, const Glib::ustring& type, const Glib::StringArrayHandle& option_keys, const Glib::StringArrayHandle& option_values)

Glib::RefPtr< Gdk::Pixbuf >	add_alpha (bool substitute_color, guint8 r, guint8 g, guint8 b) const

void	copy_area (int src_x, int src_y, int width, int height, const Glib::RefPtr< Gdk::Pixbuf >& dest_pixbuf, int dest_x, int dest_y) const

void	saturate_and_pixelate (const Glib::RefPtr< Gdk::Pixbuf >& dest, float saturation, bool pixelate) const

void	scale (const Glib::RefPtr< Gdk::Pixbuf >& dest, int dest_x, int dest_y, int dest_width, int dest_height, double offset_x, double offset_y, double scale_x, double scale_y, InterpType interp_type) const

void	composite (const Glib::RefPtr< Gdk::Pixbuf >& dest, int dest_x, int dest_y, int dest_width, int dest_height, double offset_x, double offset_y, double scale_x, double scale_y, InterpType interp_type, int overall_alpha) const

void	composite_color (const Glib::RefPtr< Gdk::Pixbuf >& dest, int dest_x, int dest_y, int dest_width, int dest_height, double offset_x, double offset_y, double scale_x, double scale_y, InterpType interp_type, int overall_alpha, int check_x, int check_y, int check_size, guint32 color1, guint32 color2) const

Glib::RefPtr< Gdk::Pixbuf >	scale_simple (int dest_width, int dest_height, InterpType interp_type) const

Glib::RefPtr< Gdk::Pixbuf >	composite_color_simple (int dest_width, int dest_height, InterpType interp_type, int overall_alpha, int check_size, guint32 color1, guint32 color2) const

Glib::RefPtr< Gdk::Pixbuf >	rotate_simple (PixbufRotation angle) const

Glib::RefPtr< Gdk::Pixbuf >	flip (bool horizontal=true) const

void	render_threshold_alpha (const Glib::RefPtr< Gdk::Bitmap >& bitmap, int src_x, int src_y, int dest_x, int dest_y, int width, int height, int alpha_threshold)
	Takes the opacity values in a rectangular portion of a pixbuf and thresholds them to produce a bi-level alpha mask that can be used as a clipping mask for a drawable. More...

void	render_to_drawable (const Glib::RefPtr< Drawable >& drawable, const Glib::RefPtr< Gdk::GC >& gc, int src_x, int src_y, int dest_x, int dest_y, int width, int height, RgbDither dither, int x_dither, int y_dither)
	Renders a rectangular portion of a pixbuf to a drawable while using the specified GC. More...

void	render_to_drawable_alpha (const Glib::RefPtr< Drawable >& drawable, int src_x, int src_y, int dest_x, int dest_y, int width, int height, PixbufAlphaMode alpha_mode, int alpha_threshold, RgbDither dither, int x_dither, int y_dither)
	Renders a rectangular portion of a pixbuf to a drawable. More...

void	render_pixmap_and_mask_for_colormap (const Glib::RefPtr< Colormap >& colormap, Glib::RefPtr< Pixmap >& pixmap_return, Glib::RefPtr< Bitmap >& mask_return, int alpha_threshold)

void	render_pixmap_and_mask (Glib::RefPtr< Pixmap >& pixmap_return, Glib::RefPtr< Bitmap >& mask_return, int alpha_threshold)

Glib::ustring	get_option (const Glib::ustring& key) const

Public Member Functions inherited from Glib::Object
	Object (const Object &)=delete

Object &	operator= (const Object &)=delete

	Object (Object &&src) noexcept

Object &	operator= (Object &&src) noexcept

void *	get_data (const QueryQuark &key)

void	set_data (const Quark &key, void *data)

void	set_data (const Quark &key, void *data, DestroyNotify notify)

void	remove_data (const QueryQuark &quark)

void *	steal_data (const QueryQuark &quark)

Glib::RefPtr< Glib::Object >	wrap (GObject *object, bool take_copy=false)

Public Member Functions inherited from Glib::ObjectBase
	ObjectBase (const ObjectBase &)=delete

ObjectBase &	operator= (const ObjectBase &)=delete

void	set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)

void	get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const

void	set_property (const Glib::ustring &property_name, const PropertyType &value)

void	get_property (const Glib::ustring &property_name, PropertyType &value) const

void	connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)

void	connect_property_changed (const Glib::ustring &property_name, sigc::slot< void > &&slot)

sigc::connection	connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)

sigc::connection	connect_property_changed_with_return (const Glib::ustring &property_name, sigc::slot< void > &&slot)

void	freeze_notify ()

void	thaw_notify ()

virtual void	reference () const

virtual void	unreference () const

GObject *	gobj ()

const GObject *	gobj () const

GObject *	gobj_copy () const

Public Member Functions inherited from sigc::trackable
	trackable () noexcept

	trackable (const trackable &src) noexcept

	trackable (trackable &&src)

	~trackable ()

void	add_destroy_notify_callback (void *data, func_destroy_notify func) const

void	notify_callbacks ()

trackable &	operator= (const trackable &src)

trackable &	operator= (trackable &&src)

void	remove_destroy_notify_callback (void *data) const

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

static Glib::RefPtr< Gdk::Pixbuf >	create (const Glib::RefPtr< Drawable >& src, const Glib::RefPtr< Colormap >& cmap, int src_x, int src_y, int dest_x, int dest_y, int width, int height)

static Glib::RefPtr< Gdk::Pixbuf >	create (const Glib::RefPtr< Image >& src, const Glib::RefPtr< Colormap >& cmap, int src_x, int src_y, int dest_x, int dest_y, int width, int height)

static Glib::RefPtr< Pixbuf >	create (const Glib::RefPtr< Drawable >& src, const Glib::RefPtr< Colormap >& cmap, int src_x, int src_y, int width, int height)
	Creates a pixbuf object from a drawable. More...

static Glib::RefPtr< Pixbuf >	create (const Glib::RefPtr< Drawable >& src, int src_x, int src_y, int width, int height)
	Creates a pixbuf object from a drawable, using the colormap from the drawable. More...

static Glib::RefPtr< Pixbuf >	create (const Glib::RefPtr< Image >& src, const Glib::RefPtr< Colormap >& cmap, int src_x, int src_y, int width, int height)
	Creates a pixbuf object from an image. More...

static Glib::RefPtr< Pixbuf >	create (const Glib::RefPtr< Image >& src, int src_x, int src_y, int width, int height)
	Creates a pixbuf object from an image, using the colormap from the image. More...

static Glib::RefPtr< Pixbuf >	create (Colorspace colorspace, bool has_alpha, int bits_per_sample, int width, int height)

static Glib::RefPtr< Pixbuf >	create_subpixbuf (const Glib::RefPtr< Pixbuf >& src_pixbuf, int src_x, int src_y, int width, int height)

static Glib::RefPtr< Pixbuf >	create_from_file (const std::string& filename)
	Creates a new pixbuf by loading an image from a file. More...

static Glib::RefPtr< Pixbuf >	create_from_file (const std::string& filename, int width, int height, bool preserve_aspect_ratio=true)
	Creates a new pixbuf by loading an image from a file. More...

static Glib::RefPtr< Pixbuf >	create_from_data (const guint8* data, Colorspace colorspace, bool has_alpha, int bits_per_sample, int width, int height, int rowstride)
	Creates a new Gdk::Pixbuf out of in-memory image data. More...

static Glib::RefPtr< Pixbuf >	create_from_data (const guint8* data, Colorspace colorspace, bool has_alpha, int bits_per_sample, int width, int height, int rowstride, const SlotDestroyData& destroy_slot)
	Creates a new Gdk::Pixbuf out of in-memory image data. More...

static Glib::RefPtr< Pixbuf >	create_from_xpm_data (const char* const* data)

static Glib::RefPtr< Pixbuf >	create_from_inline (int data_length, const guint8* data, bool copy_pixels=false)
	Create a Gdk::Pixbuf from a flat representation that is suitable for storing as inline data in a program. More...

static Glib::RefPtr< Pixbuf >	create_from_stream (const Glib::RefPtr< Gio::InputStream >& stream, const Glib::RefPtr< Gio::Cancellable >& cancelable)

static Glib::RefPtr< Pixbuf >	create_from_stream (const Glib::RefPtr< Gio::InputStream >& stream)

static Glib::RefPtr< Pixbuf >	create_from_stream_at_scale (const Glib::RefPtr< Gio::InputStream >& stream, int width, int height, bool preserve_aspect_ratio, const Glib::RefPtr< Gio::Cancellable >& cancelable)

static Glib::RefPtr< Pixbuf >	create_from_stream_at_scale (const Glib::RefPtr< Gio::InputStream >& stream, int width, int height, bool preserve_aspect_ratio)

static SListHandle_PixbufFormat	get_formats ()
	Obtains the available information about the image formats supported by GdkPixbuf. More...

Protected Member Functions
	Pixbuf (const Glib::RefPtr< Drawable >& src, const Glib::RefPtr< Colormap >& cmap, int src_x, int src_y, int width, int height)
	Creates a pixbuf object from a drawable. More...

	Pixbuf (const Glib::RefPtr< Drawable >& src, int src_x, int src_y, int width, int height)
	Creates a pixbuf object from a drawable, using the colormap from the drawable. More...

	Pixbuf (const Glib::RefPtr< Drawable >& src, const Glib::RefPtr< Colormap >& cmap, int src_x, int src_y, int dest_x, int dest_y, int width, int height)

	Pixbuf (const Glib::RefPtr< Image >& src, const Glib::RefPtr< Colormap >& cmap, int src_x, int src_y, int width, int height)
	Creates a pixbuf object from an image. More...

	Pixbuf (const Glib::RefPtr< Image >& src, int src_x, int src_y, int width, int height)
	Creates a pixbuf object from an image, using the colormap from the image. More...

	Pixbuf (const Glib::RefPtr< Image >& src, const Glib::RefPtr< Colormap >& cmap, int src_x, int src_y, int dest_x, int dest_y, int width, int height)

Protected Member Functions inherited from Glib::Object
	Object ()

	Object (const Glib::ConstructParams &construct_params)

	Object (GObject *castitem)

	~Object () noexceptoverride

Protected Member Functions inherited from Glib::ObjectBase
	ObjectBase ()

	ObjectBase (const char *custom_type_name)

	ObjectBase (const std::type_info &custom_type_info)

	ObjectBase (ObjectBase &&src) noexcept

ObjectBase &	operator= (ObjectBase &&src) noexcept

virtual	~ObjectBase () noexcept=0

void	initialize (GObject *castitem)

void	initialize_move (GObject castitem, Glib::ObjectBase previous_wrapper)

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gdk::Pixbuf >	wrap (GdkPixbuf* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Member Typedef Documentation

typedef Glib::SListHandle< Glib::RefPtr<PixbufFormat>, PixbufFormatTraits > Gdk::Pixbuf::SListHandle_PixbufFormat

typedef sigc::slot<void, const guint8*> Gdk::Pixbuf::SlotDestroyData

Constructor & Destructor Documentation

Gdk::Pixbuf::Pixbuf ( Pixbuf&& src )

noexcept

Gdk::Pixbuf::~Pixbuf ( )

overridenoexcept

Gdk::Pixbuf::Pixbuf	(	const Glib::RefPtr< Drawable >&	src,
		const Glib::RefPtr< Colormap >&	cmap,
		int	src_x,
		int	src_y,
		int	width,
		int	height
	)

protected

Creates a pixbuf object from a drawable.

Transfers image data from a Drawable and converts it to an RGB(A) representation inside a Pixbuf. In other words, copies image data from a server-side drawable to a client-side RGB(A) buffer. This allows you to efficiently read individual pixels on the client side.

If the drawable has no colormap (See Gdk::Drawable::get_colormap()), then a suitable colormap must be specified. Otherwise, you may use the constructor that takes no colormap argument. Typically a Gdk::Window or a pixmap created by passing a Gdk:Window to the Gdk::Pixbuf constructor will already have a colormap associated with it. If the drawable is a bitmap (1 bit per pixel pixmap), then a colormap is not required; pixels with a value of 1 are assumed to be white, and pixels with a value of 0 are assumed to be black. For taking screenshots, Gdk::Colormap::get_system() returns the correct colormap to use.

This will create an RGB pixbuf with 8 bits per channel and no alpha, with the same size specified by the width and height arguments.

If the specified drawable is a pixmap, then the requested source rectangle must be completely contained within the pixmap, otherwise the constructor will fail. For pixmaps only (not for windows) passing -1 for width or height is allowed to mean the full width or height of the pixmap.

If the specified drawable is a window, and the window is off the screen, then there is no image data in the obscured/offscreen regions to be placed in the pixbuf. The contents of portions of the pixbuf corresponding to the offscreen region are undefined.

If the window you're obtaining data from is partially obscured by other windows, then the contents of the pixbuf areas corresponding to the obscured regions are undefined.

See alo Gdk::Drawable::get_image().

Parameters

src	Source drawable.
cmap	A colormap.
src_x	Source X coordinate within drawable.
src_y	Source Y coordinate within drawable.
width	Width in pixels of region to get.
height	Height in pixels of region to get.

Since gtkmm 2.12:

Gdk::Pixbuf::Pixbuf	(	const Glib::RefPtr< Drawable >&	src,
		int	src_x,
		int	src_y,
		int	width,
		int	height
	)

protected

Creates a pixbuf object from a drawable, using the colormap from the drawable.

Parameters

src	Source drawable.
src_x	Source X coordinate within drawable.
src_y	Source Y coordinate within drawable.
width	Width in pixels of region to get.
height	Height in pixels of region to get.

Since gtkmm 2.12:

Gdk::Pixbuf::Pixbuf	(	const Glib::RefPtr< Drawable >&	src,
		const Glib::RefPtr< Colormap >&	cmap,
		int	src_x,
		int	src_y,
		int	dest_x,
		int	dest_y,
		int	width,
		int	height
	)

protected

Deprecated:: Use the constructor without dest_x and dest_y parameters.

Gdk::Pixbuf::Pixbuf	(	const Glib::RefPtr< Image >&	src,
		const Glib::RefPtr< Colormap >&	cmap,
		int	src_x,
		int	src_y,
		int	width,
		int	height
	)

protected

Creates a pixbuf object from an image.

Parameters

src	Source Image.
cmap	A colormap.
src_x	Source X coordinate within the image.
src_y	Source Y coordinate within the image.
width	Width in pixels of region to get.
height	Height in pixels of region to get.

Since gtkmm 2.12:

Gdk::Pixbuf::Pixbuf	(	const Glib::RefPtr< Image >&	src,
		int	src_x,
		int	src_y,
		int	width,
		int	height
	)

protected

Creates a pixbuf object from an image, using the colormap from the image.

Parameters

src	Source Image.
src_x	Source X coordinate within the image.
src_y	Source Y coordinate within the image.
width	Width in pixels of region to get.
height	Height in pixels of region to get.

Gdk::Pixbuf::Pixbuf	(	const Glib::RefPtr< Image >&	src,
		const Glib::RefPtr< Colormap >&	cmap,
		int	src_x,
		int	src_y,
		int	dest_x,
		int	dest_y,
		int	width,
		int	height
	)

protected

Deprecated:: Use the constructors without dest_x and dest_y parameters.

Member Function Documentation

Glib::RefPtr<Gdk::Pixbuf> Gdk::Pixbuf::add_alpha	(	bool	substitute_color,
		guint8	r,
		guint8	g,
		guint8	b
	)		const

void Gdk::Pixbuf::composite	(	const Glib::RefPtr< Gdk::Pixbuf >&	dest,
		int	dest_x,
		int	dest_y,
		int	dest_width,
		int	dest_height,
		double	offset_x,
		double	offset_y,
		double	scale_x,
		double	scale_y,
		InterpType	interp_type,
		int	overall_alpha
	)		const

void Gdk::Pixbuf::composite_color	(	const Glib::RefPtr< Gdk::Pixbuf >&	dest,
		int	dest_x,
		int	dest_y,
		int	dest_width,
		int	dest_height,
		double	offset_x,
		double	offset_y,
		double	scale_x,
		double	scale_y,
		InterpType	interp_type,
		int	overall_alpha,
		int	check_x,
		int	check_y,
		int	check_size,
		guint32	color1,
		guint32	color2
	)		const

Glib::RefPtr<Gdk::Pixbuf> Gdk::Pixbuf::composite_color_simple	(	int	dest_width,
		int	dest_height,
		InterpType	interp_type,
		int	overall_alpha,
		int	check_size,
		guint32	color1,
		guint32	color2
	)		const

Glib::RefPtr<Pixbuf> Gdk::Pixbuf::copy ( ) const

void Gdk::Pixbuf::copy_area	(	int	src_x,
		int	src_y,
		int	width,
		int	height,
		const Glib::RefPtr< Gdk::Pixbuf >&	dest_pixbuf,
		int	dest_x,
		int	dest_y
	)		const

static Glib::RefPtr<Gdk::Pixbuf> Gdk::Pixbuf::create	(	const Glib::RefPtr< Drawable >&	src,
		const Glib::RefPtr< Colormap >&	cmap,
		int	src_x,
		int	src_y,
		int	dest_x,
		int	dest_y,
		int	width,
		int	height
	)

static

Deprecated:: Use the create() methods that don't have the unused dest_x and dest_y parameters.

static Glib::RefPtr<Gdk::Pixbuf> Gdk::Pixbuf::create	(	const Glib::RefPtr< Image >&	src,
		const Glib::RefPtr< Colormap >&	cmap,
		int	src_x,
		int	src_y,
		int	dest_x,
		int	dest_y,
		int	width,
		int	height
	)

static

Deprecated:: Use the create() methods that that don't have the unused dest_x and dest_y parameters.

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create	(	const Glib::RefPtr< Drawable >&	src,
		const Glib::RefPtr< Colormap >&	cmap,
		int	src_x,
		int	src_y,
		int	width,
		int	height
	)

static

Creates a pixbuf object from a drawable.

This will create an RGB pixbuf with 8 bits per channel and no alpha, with the same size specified by the width and height arguments.

If the window you're obtaining data from is partially obscured by other windows, then the contents of the pixbuf areas corresponding to the obscured regions are undefined.

See alo Gdk::Drawable::get_image().

Parameters

src	Source drawable.
cmap	A colormap.
src_x	Source X coordinate within drawable.
src_y	Source Y coordinate within drawable.
width	Width in pixels of region to get.
height	Height in pixels of region to get.

Since gtkmm 2.12:

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create	(	const Glib::RefPtr< Drawable >&	src,
		int	src_x,
		int	src_y,
		int	width,
		int	height
	)

static

Creates a pixbuf object from a drawable, using the colormap from the drawable.

Parameters

src	Source drawable.
src_x	Source X coordinate within drawable.
src_y	Source Y coordinate within drawable.
width	Width in pixels of region to get.
height	Height in pixels of region to get.

Since gtkmm 2.12:

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create	(	const Glib::RefPtr< Image >&	src,
		const Glib::RefPtr< Colormap >&	cmap,
		int	src_x,
		int	src_y,
		int	width,
		int	height
	)

static

Creates a pixbuf object from an image.

Parameters

src	Source Image.
cmap	A colormap.
src_x	Source X coordinate within the image.
src_y	Source Y coordinate within the image.
width	Width in pixels of region to get.
height	Height in pixels of region to get.

Since gtkmm 2.12:

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create	(	const Glib::RefPtr< Image >&	src,
		int	src_x,
		int	src_y,
		int	width,
		int	height
	)

static

Creates a pixbuf object from an image, using the colormap from the image.

Parameters

src	Source Image.
src_x	Source X coordinate within the image.
src_y	Source Y coordinate within the image.
width	Width in pixels of region to get.
height	Height in pixels of region to get.

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create	(	Colorspace	colorspace,
		bool	has_alpha,
		int	bits_per_sample,
		int	width,
		int	height
	)

static

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create_from_data	(	const guint8 *	data,
		Colorspace	colorspace,
		bool	has_alpha,
		int	bits_per_sample,
		int	width,
		int	height,
		int	rowstride
	)

static

Creates a new Gdk::Pixbuf out of in-memory image data.

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

Parameters

data	Image data in 8-bit/sample packed format.
colorspace	Colorspace for the image data.
has_alpha	Whether the data has an opacity channel.
bits_per_sample	Number of bits per sample.
width	Width of the image in pixels.
height	Height of the image in pixels.
rowstride	Distance in bytes between rows.

Returns: A newly-created Gdk::Pixbuf object.

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create_from_data	(	const guint8 *	data,
		Colorspace	colorspace,
		bool	has_alpha,
		int	bits_per_sample,
		int	width,
		int	height,
		int	rowstride,
		const SlotDestroyData&	destroy_slot
	)

static

Creates a new Gdk::Pixbuf out of in-memory image data.

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

Parameters

data	Image data in 8-bit/sample packed format.
colorspace	Colorspace for the image data.
has_alpha	Whether the data has an opacity channel.
bits_per_sample	Number of bits per sample.
width	Width of the image in pixels.
height	Height of the image in pixels.
rowstride	Distance in bytes between rows.
destroy_slot	Slot used to free the data when the pixbuf's reference count drops to zero.

Returns: A newly-created Gdk::Pixbuf object.

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create_from_file ( const std::string & filename )

static

Creates a new pixbuf by loading an image from a file.

The file format is detected automatically.

Parameters

filename The path to the pixbuf file.

Exceptions

Glib::FileError
Gdk::PixbufError

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create_from_file	(	const std::string &	filename,
		int	width,
		int	height,
		bool	preserve_aspect_ratio = `true`
	)

static

Creates a new pixbuf by loading an image from a file.

The file format is detected automatically. The image will be scaled to fit in the requested size.

Parameters

filename	The path to the pixbuf file.
width	The desired width
height	The desired height
preserve_aspect_ratio	Whether the image's aspect ratio will be preserved when scaling.

Exceptions

Glib::FileError
Gdk::PixbufError

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create_from_inline	(	int	data_length,
		const guint8 *	data,
		bool	copy_pixels = `false`
	)

static

Create a Gdk::Pixbuf 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.

GTK+ 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 flag 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, since things will always succeed. For non-const inline data, you could get out of memory. For untrusted inline data located at runtime, you could have corrupt inline data in addition.

Parameters

data_length	Length in bytes of the data argument.
data	Byte data containing a serialized GdkPixdata structure.
copy_pixels	Whether to copy the pixel data, or use direct pointers to data for the resulting pixbuf.

Exceptions

Gdk::PixbufError

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create_from_stream	(	const Glib::RefPtr< Gio::InputStream > &	stream,
		const Glib::RefPtr< Gio::Cancellable > &	cancelable
	)

static

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create_from_stream ( const Glib::RefPtr< Gio::InputStream > & stream )

static

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create_from_stream_at_scale	(	const Glib::RefPtr< Gio::InputStream > &	stream,
		int	width,
		int	height,
		bool	preserve_aspect_ratio,
		const Glib::RefPtr< Gio::Cancellable > &	cancelable
	)

static

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create_from_stream_at_scale	(	const Glib::RefPtr< Gio::InputStream > &	stream,
		int	width,
		int	height,
		bool	preserve_aspect_ratio
	)

static

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create_from_xpm_data ( const char *const * data )

static

static Glib::RefPtr<Pixbuf> Gdk::Pixbuf::create_subpixbuf	(	const Glib::RefPtr< Pixbuf >&	src_pixbuf,
		int	src_x,
		int	src_y,
		int	width,
		int	height
	)

static

Parameters

dummy	Dummy parameter, this is a static function but the name idicates a class, so this one will be stripped not the actual first parameter.
src_pixbuf	A Gdk::Pixbuf.
src_x	X coord in src_pixbuf.
src_y	Y coord in src_pixbuf.
width	Width of region in src_pixbuf.
height	Height of region in src_pixbuf.

void Gdk::Pixbuf::fill ( guint32 pixel )

Glib::RefPtr<Gdk::Pixbuf> Gdk::Pixbuf::flip ( bool horizontal = true ) const

int Gdk::Pixbuf::get_bits_per_sample ( ) const

Colorspace Gdk::Pixbuf::get_colorspace ( ) const

static SListHandle_PixbufFormat Gdk::Pixbuf::get_formats ( )

static

Obtains the available information about the image formats supported by GdkPixbuf.

Returns: A list of PixbufFormats describing the supported image formats.

bool Gdk::Pixbuf::get_has_alpha ( ) const

int Gdk::Pixbuf::get_height ( ) const

int Gdk::Pixbuf::get_n_channels ( ) const

Glib::ustring Gdk::Pixbuf::get_option ( const Glib::ustring & key ) const

guint8* Gdk::Pixbuf::get_pixels ( ) const

int Gdk::Pixbuf::get_rowstride ( ) const

static GType Gdk::Pixbuf::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

int Gdk::Pixbuf::get_width ( ) const

GdkPixbuf* Gdk::Pixbuf::gobj ( )

inline

Provides access to the underlying C GObject.

const GdkPixbuf* Gdk::Pixbuf::gobj ( ) const

inline

Provides access to the underlying C GObject.

GdkPixbuf* Gdk::Pixbuf::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Pixbuf& Gdk::Pixbuf::operator= ( Pixbuf&& src )

noexcept

void Gdk::Pixbuf::render_pixmap_and_mask	(	Glib::RefPtr< Pixmap >&	pixmap_return,
		Glib::RefPtr< Bitmap >&	mask_return,
		int	alpha_threshold
	)

void Gdk::Pixbuf::render_pixmap_and_mask_for_colormap	(	const Glib::RefPtr< Colormap >&	colormap,
		Glib::RefPtr< Pixmap >&	pixmap_return,
		Glib::RefPtr< Bitmap >&	mask_return,
		int	alpha_threshold
	)

void Gdk::Pixbuf::render_threshold_alpha	(	const Glib::RefPtr< Gdk::Bitmap >&	bitmap,
		int	src_x,
		int	src_y,
		int	dest_x,
		int	dest_y,
		int	width,
		int	height,
		int	alpha_threshold
	)

Takes the opacity values in a rectangular portion of a pixbuf and thresholds them to produce a bi-level alpha mask that can be used as a clipping mask for a drawable.

Parameters

bitmap	Bitmap where the bilevel mask will be painted to.
src_x	Source X coordinate.
src_y	Source Y coordinate.
dest_x	Destination X coordinate.
dest_y	Destination Y coordinate.
width	Width of region to threshold, or -1 to use pixbuf width.
height	Height of region to threshold, or -1 to use pixbuf height.
alpha_threshold	Opacity values below this will be painted as zero; all other values will be painted as one.

void Gdk::Pixbuf::render_to_drawable	(	const Glib::RefPtr< Drawable >&	drawable,
		const Glib::RefPtr< Gdk::GC >&	gc,
		int	src_x,
		int	src_y,
		int	dest_x,
		int	dest_y,
		int	width,
		int	height,
		RgbDither	dither,
		int	x_dither,
		int	y_dither
	)

Renders a rectangular portion of a pixbuf to a drawable while using the specified GC.

This is done using GdkRGB, so the specified drawable must have the GdkRGB visual and colormap. Note that this function will ignore the opacity information for images with an alpha channel; the GC must already have the clipping mask set if you want transparent regions to show through.

For an explanation of dither offsets, see the GdkRGB documentation. In brief, the dither offset is important when re-rendering partial regions of an image to a rendered version of the full image, or for when the offsets to a base position change, as in scrolling. The dither matrix has to be shifted for consistent visual results. If you do not have any of these cases, the dither offsets can be both zero.

Deprecated: 2.4: This function is obsolete. Use gdk_draw_pixbuf() instead.

Deprecated:: Use Gdk::Drawable::draw_pixbuf() instead.

Parameters

drawable	Destination drawable.
gc	GC used for rendering.
src_x	Source X coordinate within pixbuf.
src_y	Source Y coordinate within pixbuf.
dest_x	Destination X coordinate within drawable.
dest_y	Destination Y coordinate within drawable.
width	Width of region to render, in pixels, or -1 to use pixbuf width.
height	Height of region to render, in pixels, or -1 to use pixbuf height.
dither	Dithering mode for GdkRGB.
x_dither	X offset for dither.
y_dither	Y offset for dither.

void Gdk::Pixbuf::render_to_drawable_alpha	(	const Glib::RefPtr< Drawable >&	drawable,
		int	src_x,
		int	src_y,
		int	dest_x,
		int	dest_y,
		int	width,
		int	height,
		PixbufAlphaMode	alpha_mode,
		int	alpha_threshold,
		RgbDither	dither,
		int	x_dither,
		int	y_dither
	)

Renders a rectangular portion of a pixbuf to a drawable.

The destination drawable must have a colormap. All windows have a colormap, however, pixmaps only have colormap by default if they were created with a non-nullptr window argument. Otherwise a colormap must be set on them with gdk_drawable_set_colormap.

On older X servers, rendering pixbufs with an alpha channel involves round trips to the X server, and may be somewhat slow.

Deprecated: 2.4: This function is obsolete. Use gdk_draw_pixbuf() instead.

Deprecated:: Use Gdk::Drawable::draw_pixbuf() instead.

Parameters

drawable	Destination drawable.
src_x	Source X coordinate within pixbuf.
src_y	Source Y coordinates within pixbuf.
dest_x	Destination X coordinate within drawable.
dest_y	Destination Y coordinate within drawable.
width	Width of region to render, in pixels, or -1 to use pixbuf width.
height	Height of region to render, in pixels, or -1 to use pixbuf height.
alpha_mode	Ignored. Present for backwards compatibility.
alpha_threshold	Ignored. Present for backwards compatibility.
dither	Dithering mode for GdkRGB.
x_dither	X offset for dither.
y_dither	Y offset for dither.

Glib::RefPtr<Gdk::Pixbuf> Gdk::Pixbuf::rotate_simple ( PixbufRotation angle ) const

void Gdk::Pixbuf::saturate_and_pixelate	(	const Glib::RefPtr< Gdk::Pixbuf >&	dest,
		float	saturation,
		bool	pixelate
	)		const

void Gdk::Pixbuf::save	(	const std::string &	filename,
		const Glib::ustring &	type
	)

Saves pixbuf to a file in format type.

By default, "jpeg", "png", "ico" and "bmp" are possible file formats to save in, but more formats may be installed. The list of all writable formats can be determined by using get_formats() with is_writable().

Parameters

filename	The path of the file to be created.
type	The file type.

Exceptions

Glib::FileError
Gdk::PixbufError

void Gdk::Pixbuf::save	(	const std::string &	filename,
		const Glib::ustring &	type,
		const Glib::StringArrayHandle &	option_keys,
		const Glib::StringArrayHandle &	option_values
	)

Saves pixbuf to a file in format type.

By default, "jpeg", "png", "ico" and "bmp" are possible file formats to save in, but more formats may be installed. TThe list of all writable formats can be determined by using get_formats() with Gdk::PixbufFormat::is_writable().

The option_keys and , if not empty, should contain pairs of strings that modify the save parameters. For example, "quality", "100".

Currently only a few parameters exist. JPEG images can be saved with a "quality" parameter; its value should be in the range [0,100]. Text chunks can be attached to PNG images by specifying parameters of the form "tEXt::key", where key is an ASCII string of length 1-79. The values are UTF-8 encoded strings. ICO images can be saved in depth 16, 24, or 32, by using the "depth" parameter. When the ICO saver is given "x_hot" and "y_hot" parameters, it produces a CUR instead of an ICO.

Parameters

filename	The path of the file to be created.
type	The file type.
option_keys
option_values

Exceptions

Glib::FileError
Gdk::PixbufError

void Gdk::Pixbuf::save_to_buffer	(	gchar *&	buffer,
		gsize &	buffer_size,
		const Glib::ustring &	type = `"png"`
	)

void Gdk::Pixbuf::save_to_buffer	(	gchar *&	buffer,
		gsize &	buffer_size,
		const Glib::ustring &	type,
		const Glib::StringArrayHandle &	option_keys,
		const Glib::StringArrayHandle &	option_values
	)

void Gdk::Pixbuf::scale	(	const Glib::RefPtr< Gdk::Pixbuf >&	dest,
		int	dest_x,
		int	dest_y,
		int	dest_width,
		int	dest_height,
		double	offset_x,
		double	offset_y,
		double	scale_x,
		double	scale_y,
		InterpType	interp_type
	)		const

Glib::RefPtr<Gdk::Pixbuf> Gdk::Pixbuf::scale_simple	(	int	dest_width,
		int	dest_height,
		InterpType	interp_type
	)		const

Friends And Related Function Documentation

Glib::RefPtr< Gdk::Pixbuf > wrap	(	GdkPixbuf *	object,
		bool	take_copy = `false`
	)

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns: A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file:

gdkmm/pixbuf.h

gtkmm: Gdk::Pixbuf Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation