Gdk::Pixbuf Class Reference

Inheritance diagram for Gdk::Pixbuf:

List of all members.

Public Types

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

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

Public Member Functions

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

Takes an existing pixbuf and adds an alpha channel to it.

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

Creates a transformation of the source image src by scaling by scale_x and scale_y then translating by offset_x and offset_y.

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

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.

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

Creates a new Gdk::Pixbuf by scaling src to dest_width x dest_height and compositing the result with a checkboard of colors color1 and color2.

Glib::RefPtr<Pixbuf> copy () const

Creates a new Gdk::Pixbuf with a copy of the information in the specified pixbuf.

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

Copies a rectangular area from src_pixbuf to dest_pixbuf.

void fill (guint32 pixel)

Clears a pixbuf to the given RGBA value, converting the RGBA value into the pixbuf's pixel format.

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

Flips a pixbuf horizontally or vertically and returns the result in a new pixbuf.

int get_bits_per_sample () const

Queries the number of bits per color sample in a pixbuf.

Colorspace get_colorspace () const

Queries the color space of a pixbuf.

bool get_has_alpha () const

Queries whether a pixbuf has an alpha channel (opacity information).

int get_height () const

Queries the height of a pixbuf.

int get_n_channels () const

Queries the number of channels of a pixbuf.

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

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

guint8* get_pixels () const

Queries a pointer to the pixel data of a pixbuf.

int get_rowstride () const

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.

int get_width () const

Queries the width of a pixbuf.

const GdkPixbuf* gobj () const

Provides access to the underlying C GObject.

GdkPixbuf* gobj ()

Provides access to the underlying C GObject.

GdkPixbuf* gobj_copy ()

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

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

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

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.

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.

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

Rotates a pixbuf by a multiple of 90 degrees, and returns the result in a new pixbuf.

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

Modifies saturation and optionally pixelates src, placing the result in dest.

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.

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

Saves pixbuf to a file in format type.

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

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

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

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.

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

Create a new Gdk::Pixbuf containing a copy of src scaled to dest_width x dest_height.

virtual ~Pixbuf ()

Static Public Member Functions

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

Creates a new Gdk::Pixbuf structure and allocates a buffer for it.

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.

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.

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.

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.

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

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.

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.

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

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

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.

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

Creates a new pixbuf by parsing XPM data in memory.

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

Creates a new pixbuf which represents a sub-region of src_pixbuf.

static SListHandle_PixbufFormat get_formats ()

Protected Member Functions

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)

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.

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.

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

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.

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.

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

virtual Gdk::Pixbuf::~Pixbuf ( ) [virtual]

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

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

If substitute_color is true, then the color specified by ( r, g, b) will be assigned zero opacity. That is, if you pass (255, 255, 255) for the substitute color, all white pixels will become fully transparent.

Parameters:

	substitute_color	Whether to set a color to zero opacity. If this is `false`, then the ( r, g, b) arguments will be ignored.
	r	Red value to substitute.
	g	Green value to substitute.
	b	Blue value to substitute.

Returns:: A newly-created pixbuf with a reference count of 1.

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

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.

When the destination rectangle contains parts not in the source image, the data at the edges of the source image is replicated to infinity.

<figure id="pixbuf-composite-diagram"> <title>Compositing of pixbufs</title> <graphic fileref="composite.png" format="PNG"/> </figure>

Parameters:

	dest	The Gdk::Pixbuf into which to render the results.
	dest_x	The left coordinate for region to render.
	dest_y	The top coordinate for region to render.
	dest_width	The width of the region to render.
	dest_height	The height of the region to render.
	offset_x	The offset in the X direction (currently rounded to an integer).
	offset_y	The offset in the Y direction (currently rounded to an integer).
	scale_x	The scale factor in the X direction.
	scale_y	The scale factor in the Y direction.
	interp_type	The interpolation type for the transformation.
	overall_alpha	Overall alpha for source image (0..255).

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

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.

See composite_color_simple() for a simpler variant of this function suitable for many tasks.

Parameters:

	dest	The Gdk::Pixbuf into which to render the results.
	dest_x	The left coordinate for region to render.
	dest_y	The top coordinate for region to render.
	dest_width	The width of the region to render.
	dest_height	The height of the region to render.
	offset_x	The offset in the X direction (currently rounded to an integer).
	offset_y	The offset in the Y direction (currently rounded to an integer).
	scale_x	The scale factor in the X direction.
	scale_y	The scale factor in the Y direction.
	interp_type	The interpolation type for the transformation.
	overall_alpha	Overall alpha for source image (0..255).
	check_x	The X offset for the checkboard (origin of checkboard is at - check_x, - check_y).
	check_y	The Y offset for the checkboard.
	check_size	The size of checks in the checkboard (must be a power of two).
	color1	The color of check at upper left.
	color2	The color of the other check.

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

Creates a new Gdk::Pixbuf by scaling src to dest_width x dest_height and compositing the result with a checkboard of colors color1 and color2.

Parameters:

	dest_width	The width of destination image.
	dest_height	The height of destination image.
	interp_type	The interpolation type for the transformation.
	overall_alpha	Overall alpha for source image (0..255).
	check_size	The size of checks in the checkboard (must be a power of two).
	color1	The color of check at upper left.
	color2	The color of the other check.

Returns:: The new Gdk::Pixbuf, or 0 if not enough memory could be allocated for it.

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

Creates a new Gdk::Pixbuf with a copy of the information in the specified pixbuf.

Returns:: A newly-created pixbuf with a reference count of 1, or 0 if not enough memory could be allocated.

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

Copies a rectangular area from src_pixbuf to dest_pixbuf.

Conversion of pixbuf formats is done automatically.

Parameters:

	src_x	Source X coordinate within src_pixbuf.
	src_y	Source Y coordinate within src_pixbuf.
	width	Width of the area to copy.
	height	Height of the area to copy.
	dest_pixbuf	Destination pixbuf.
	dest_x	X coordinate within dest_pixbuf.
	dest_y	Y coordinate within dest_pixbuf.

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

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

Parameters:

	colorspace	Color space for image.
	has_alpha	Whether the image should have transparency information.
	bits_per_sample	Number of bits per color sample.
	width	Width of image in pixels, must be > 0.
	height	Height of image in pixels, must be > 0.

Returns:: A newly-created Gdk::Pixbuf with a reference count of 1, or 0 if not enough memory could be allocated for the image buffer.

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

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:

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<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<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_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_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	Creates a new pixbuf by loading an image from a file. The file format is detected automatically. If `0` is returned, then error will be set. Possible errors are in the Gdk::PIXBUF_ERROR and FILE_ERROR domains. The image will be scaled to fit in the requested size, optionally preserving the image's aspect ratio.

When preserving the aspect ratio, a width of -1 will cause the image to be scaled to the exact given height, and a height of -1 will cause the image to be scaled to the exact given width. When not preserving aspect ratio, a width or height of -1 means to not scale the image at all in that dimension. Negative values for width and height are allowed since 2.8.

Parameters:

	filename	Name of file to load, in the GLib file name encoding.
	width	The width the image should have or -1 to not constra


Public Types
typedef Glib::SListHandle < Glib::RefPtr<PixbufFormat> , PixbufFormatTraits >	SListHandle_PixbufFormat
typedef sigc::slot< void, const guint8* >	SlotDestroyData
Public Member Functions
Glib::RefPtr<Gdk::Pixbuf>	add_alpha (bool substitute_color, guint8 r, guint8 g, guint8 b) const
	Takes an existing pixbuf and adds an alpha channel to it.
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
	Creates a transformation of the source image src by scaling by scale_x and scale_y then translating by offset_x and offset_y.
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
	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.
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
	Creates a new Gdk::Pixbuf by scaling src to dest_width x dest_height and compositing the result with a checkboard of colors color1 and color2.
Glib::RefPtr<Pixbuf>	copy () const
	Creates a new Gdk::Pixbuf with a copy of the information in the specified pixbuf.
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
	Copies a rectangular area from src_pixbuf to dest_pixbuf.
void	fill (guint32 pixel)
	Clears a pixbuf to the given RGBA value, converting the RGBA value into the pixbuf's pixel format.
Glib::RefPtr<Gdk::Pixbuf>	flip (bool horizontal=true) const
	Flips a pixbuf horizontally or vertically and returns the result in a new pixbuf.
int	get_bits_per_sample () const
	Queries the number of bits per color sample in a pixbuf.
Colorspace	get_colorspace () const
	Queries the color space of a pixbuf.
bool	get_has_alpha () const
	Queries whether a pixbuf has an alpha channel (opacity information).
int	get_height () const
	Queries the height of a pixbuf.
int	get_n_channels () const
	Queries the number of channels of a pixbuf.
Glib::ustring	get_option (const Glib::ustring& key) const
	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 set_option().
guint8*	get_pixels () const
	Queries a pointer to the pixel data of a pixbuf.
int	get_rowstride () const
	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.
int	get_width () const
	Queries the width of a pixbuf.
const GdkPixbuf*	gobj () const
	Provides access to the underlying C GObject.
GdkPixbuf*	gobj ()
	Provides access to the underlying C GObject.
GdkPixbuf*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void	render_pixmap_and_mask (Glib::RefPtr<Pixmap>& pixmap_return, Glib::RefPtr<Bitmap>& mask_return, int alpha_threshold)
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_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.
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.
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.
Glib::RefPtr<Gdk::Pixbuf>	rotate_simple (PixbufRotation angle) const
	Rotates a pixbuf by a multiple of 90 degrees, and returns the result in a new pixbuf.
void	saturate_and_pixelate (const Glib::RefPtr<Gdk::Pixbuf>& dest, float saturation, bool pixelate) const
	Modifies saturation and optionally pixelates src, placing the result in dest.
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.
void	save (const std::string& filename, const Glib::ustring& type)
	Saves pixbuf to a file in format type.
void	save_to_buffer (gchar*& buffer, gsize& buffer_size, const Glib::ustring& type, const Glib::StringArrayHandle& option_keys, const Glib::StringArrayHandle& option_values)
void	save_to_buffer (gchar*& buffer, gsize& buffer_size, const Glib::ustring& type="png")
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
	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.
Glib::RefPtr<Gdk::Pixbuf>	scale_simple (int dest_width, int dest_height, InterpType interp_type) const
	Create a new Gdk::Pixbuf containing a copy of src scaled to dest_width x dest_height.
virtual	~Pixbuf ()
Static Public Member Functions
static Glib::RefPtr<Pixbuf>	create (Colorspace colorspace, bool has_alpha, int bits_per_sample, int width, int height)
	Creates a new Gdk::Pixbuf structure and allocates a buffer for it.
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.
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.
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.
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.
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<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<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.
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.
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.
static Glib::RefPtr<Pixbuf>	create_from_file (const std::string& filename)
	Creates a new pixbuf by loading an image from a file.
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.
static Glib::RefPtr<Pixbuf>	create_from_xpm_data (const char* const* data)
	Creates a new pixbuf by parsing XPM data in memory.
static Glib::RefPtr<Pixbuf>	create_subpixbuf (const Glib::RefPtr<Pixbuf>& src_pixbuf, int src_x, int src_y, int width, int height)
	Creates a new pixbuf which represents a sub-region of src_pixbuf.
static SListHandle_PixbufFormat	get_formats ()
Protected Member Functions
	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)
	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.
	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.
	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<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.
	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.
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.