QtGui.QPixmap Class Reference

The QPixmap class is an off-screen image representation that can be used as a paint device. More...

Inheritance diagram for QtGui.QPixmap:

Collaboration diagram for QtGui.QPixmap:

Public Types
enum	HBitmapFormat { Alpha = 2, NoAlpha = 0, PremultipliedAlpha = 1 }
	More...
enum	Type
Public Types inherited from QtGui.QPaintDevice
enum	PaintDeviceMetric {   PdmDepth = 6, PdmDpiX = 7, PdmDpiY = 8, PdmHeight = 2,   PdmHeightMM = 4, PdmNumColors = 5, PdmPhysicalDpiX = 9, PdmPhysicalDpiY = 10,   PdmWidth = 1, PdmWidthMM = 3 }
	More...

Public Member Functions
	QPixmap ()
	QPixmap (QSize arg1)
	QPixmap (QPixmap arg1)
	QPixmap (int w, int h)
	QPixmap (string fileName, string format=null, Qt.ImageConversionFlag flags=Qt.ImageConversionFlag.AutoColor)
override void	CreateProxy ()
new long	CacheKey ()
new bool	ConvertFromImage (QImage img, Qt.ImageConversionFlag flags=Qt.ImageConversionFlag.AutoColor)
new QPixmap	Copy ()
new QPixmap	Copy (QRect rect)
new QPixmap	Copy (int x, int y, int width, int height)
new QBitmap	CreateHeuristicMask (bool clipTight=true)
new QBitmap	CreateMaskFromColor (QColor maskColor)
new QBitmap	CreateMaskFromColor (QColor maskColor, Qt.MaskMode mode)
new int	Depth ()
new void	Detach ()
override int	DevType ()
new void	Fill ()
new void	Fill (QColor fillColor)
new void	Fill (QWidget widget, QPoint ofs)
new void	Fill (QWidget widget, int xofs, int yofs)
new bool	HasAlpha ()
new bool	HasAlphaChannel ()
new int	Height ()
new bool	IsDetached ()
new bool	IsNull ()
new bool	IsQBitmap ()
new bool	Load (string fileName, string format=null, Qt.ImageConversionFlag flags=Qt.ImageConversionFlag.AutoColor)
new bool	LoadFromData (QByteArray data, string format=null, Qt.ImageConversionFlag flags=Qt.ImageConversionFlag.AutoColor)
new bool	LoadFromData (Pointer< byte > buf, uint len, string format=null, Qt.ImageConversionFlag flags=Qt.ImageConversionFlag.AutoColor)
override QPaintEngine	PaintEngine ()
new QRect	Rect ()
new bool	Save (QIODevice device, string format=null, int quality=-1)
new bool	Save (string fileName, string format=null, int quality=-1)
new QPixmap	Scaled (QSize s, Qt.AspectRatioMode aspectMode=Qt.AspectRatioMode.IgnoreAspectRatio, Qt.TransformationMode mode=Qt.TransformationMode.FastTransformation)
new QPixmap	Scaled (int w, int h, Qt.AspectRatioMode aspectMode=Qt.AspectRatioMode.IgnoreAspectRatio, Qt.TransformationMode mode=Qt.TransformationMode.FastTransformation)
new QPixmap	ScaledToHeight (int h, Qt.TransformationMode mode=Qt.TransformationMode.FastTransformation)
new QPixmap	ScaledToWidth (int w, Qt.TransformationMode mode=Qt.TransformationMode.FastTransformation)
new void	Scroll (int dx, int dy, QRect rect, QRegion exposed=null)
new void	Scroll (int dx, int dy, int x, int y, int width, int height, QRegion exposed=null)
new int	SerialNumber ()
new QSize	Size ()
new void	Swap (QPixmap other)
new QImage	ToImage ()
new System.IntPtr	ToWinHBITMAP (QPixmap.HBitmapFormat format=QPixmap.HBitmapFormat.NoAlpha)
new System.IntPtr	ToWinHICON ()
new QPixmap	Transformed (QMatrix arg1, Qt.TransformationMode mode=Qt.TransformationMode.FastTransformation)
new QPixmap	Transformed (QTransform arg1, Qt.TransformationMode mode=Qt.TransformationMode.FastTransformation)
new int	Width ()
new void	Dispose ()
Public Member Functions inherited from QtGui.QPaintDevice
new int	ColorCount ()
new int	Depth ()
virtual System.IntPtr	GetDC ()
new int	Height ()
new int	HeightMM ()
new int	LogicalDpiX ()
new int	LogicalDpiY ()
new int	NumColors ()
new bool	PaintingActive ()
new int	PhysicalDpiX ()
new int	PhysicalDpiY ()
virtual void	ReleaseDC (System.IntPtr hdc)
new int	Width ()
new int	WidthMM ()
new void	Dispose ()
Public Member Functions inherited from QtGui.IQPaintDevice
new int	ColorCount ()
new int	Depth ()
int	DevType ()
System.IntPtr	GetDC ()
new int	Height ()
new int	HeightMM ()
new int	LogicalDpiX ()
new int	LogicalDpiY ()
new int	NumColors ()
QPaintEngine	PaintEngine ()
new bool	PaintingActive ()
new int	PhysicalDpiX ()
new int	PhysicalDpiY ()
void	ReleaseDC (System.IntPtr hdc)
new int	Width ()
new int	WidthMM ()

Static Public Member Functions
static int	DefaultDepth ()
static QPixmap	FromImage (QImage image, Qt.ImageConversionFlag flags=Qt.ImageConversionFlag.AutoColor)
static QPixmap	FromImageReader (QImageReader imageReader, Qt.ImageConversionFlag flags=Qt.ImageConversionFlag.AutoColor)
static QPixmap	FromWinHBITMAP (System.IntPtr hbitmap, QPixmap.HBitmapFormat format=QPixmap.HBitmapFormat.NoAlpha)
static QPixmap	FromWinHICON (System.IntPtr hicon)
static QPixmap	GrabWidget (QWidget widget, QRect rect)
static QPixmap	GrabWidget (QWidget widget, int x=0, int y=0, int w=-1, int h=-1)
static QPixmap	GrabWindow (NativeULong arg1, int x=0, int y=0, int w=-1, int h=-1)
static bool	operator! (QPixmap arg1)
static QMatrix	TrueMatrix (QMatrix m, int w, int h)
static QTransform	TrueMatrix (QTransform m, int w, int h)

Protected Member Functions
	QPixmap (System.Type dummy)
override int	Metric (QPaintDevice.PaintDeviceMetric arg1)
Protected Member Functions inherited from QtGui.QPaintDevice
	QPaintDevice (System.Type dummy)
	QPaintDevice ()

Properties
new QPixmap	AlphaChannel [get, set]
new QBitmap	Mask [get, set]
Properties inherited from QtGui.QPaintDevice
virtual System.IntPtr	SmokeObject [get, set]
new ushort	Painters [get, set]

Additional Inherited Members
Protected Attributes inherited from QtGui.QPaintDevice
SmokeInvocation	interceptor

Detailed Description

The QPixmap class is an off-screen image representation that can be used as a paint device.

Qt provides four classes for handling image data: QImage, QPixmap, QBitmap and QPicture. QImage is designed and optimized for I/O, and for direct pixel access and manipulation, while QPixmap is designed and optimized for showing images on screen. QBitmap is only a convenience class that inherits QPixmap, ensuring a depth of 1. The isQBitmap() function returns true if a QPixmap object is really a bitmap, otherwise returns false. Finally, the QPicture class is a paint device that records and replays QPainter commands.

A QPixmap can easily be displayed on the screen using QLabel or one of QAbstractButton's subclasses (such as QPushButton and QToolButton). QLabel has a pixmap property, whereas QAbstractButton has an icon property.

In addition to the ordinary constructors, a QPixmap can be constructed using the static grabWidget() and grabWindow() functions which creates a QPixmap and paints the given widget, or window, into it.

QPixmap objects can be passed around by value since the QPixmap class uses implicit data sharing. For more information, see the Implicit Data Sharing documentation. QPixmap objects can also be streamed.

Note that the pixel data in a pixmap is internal and is managed by the underlying window system. Because QPixmap is a QPaintDevice subclass, QPainter can be used to draw directly onto pixmaps. Pixels can only be accessed through QPainter functions or by converting the QPixmap to a QImage. However, the fill() function is available for initializing the entire pixmap with a given color.

There are functions to convert between QImage and QPixmap. Typically, the QImage class is used to load an image file, optionally manipulating the image data, before the QImage object is converted into a QPixmap to be shown on screen. Alternatively, if no manipulation is desired, the image file can be loaded directly into a QPixmap. On Windows, the QPixmap class also supports conversion between HBITMAP and QPixmap. On Symbian, the QPixmap class also supports conversion between CFbsBitmap and QPixmap.

QPixmap provides a collection of functions that can be used to obtain a variety of information about the pixmap. In addition, there are several functions that enables transformation of the pixmap.

Reading and Writing Image Files

QPixmap provides several ways of reading an image file: The file can be loaded when constructing the QPixmap object, or by using the load() or loadFromData() functions later on. When loading an image, the file name can either refer to an actual file on disk or to one of the application's embedded resources. See The Qt Resource System overview for details on how to embed images and other resource files in the application's executable.

Simply call the save() function to save a QPixmap object.

The complete list of supported file formats are available through the QImageReader::supportedImageFormats() and QImageWriter::supportedImageFormats() functions. New file formats can be added as plugins. By default, Qt supports the following formats:

FormatDescriptionQt's support

BMP Windows Bitmap Read/write

GIF Graphic Interchange Format (optional) Read

JPG Joint Photographic Experts Group Read/write

JPEG Joint Photographic Experts Group Read/write

PNG Portable Network Graphics Read/write

PBM Portable Bitmap Read

PGM Portable Graymap Read

PPM Portable Pixmap Read/write

XBM X11 Bitmap Read/write

XPM X11 Pixmap Read/write

Pixmap Information

QPixmap provides a collection of functions that can be used to obtain a variety of information about the pixmap:

Available Functions

Geometry The size(), width() and height() functions provide information about the pixmap's size. The rect() function returns the image's enclosing rectangle.

Alpha component The hasAlphaChannel() returns true if the pixmap has a format that respects the alpha channel, otherwise returns false. The hasAlpha(), setMask() and mask() functions are legacy and should not be used. They are potentially very slow.The createHeuristicMask() function creates and returns a 1-bpp heuristic mask (i.e. a QBitmap) for this pixmap. It works by selecting a color from one of the corners and then chipping away pixels of that color, starting at all the edges. The createMaskFromColor() function creates and returns a mask (i.e. a QBitmap) for the pixmap based on a given color.

Low-level information The depth() function returns the depth of the pixmap. The defaultDepth() function returns the default depth, i.e. the depth used by the application on the given screen.The cacheKey() function returns a number that uniquely identifies the contents of the QPixmap object.

The x11Info() function returns information about the configuration of the X display used by the screen to which the pixmap currently belongs. The x11PictureHandle() function returns the X11 Picture handle of the pixmap for XRender support. Note that the two latter functions are only available on x11.

Pixmap Conversion

A QPixmap object can be converted into a QImage using the toImage() function. Likewise, a QImage can be converted into a QPixmap using the fromImage(). If this is too expensive an operation, you can use QBitmap::fromImage() instead.

In addition, on Windows, the QPixmap class supports conversion to and from HBITMAP: the toWinHBITMAP() function creates a HBITMAP equivalent to the QPixmap, based on the given HBitmapFormat, and returns the HBITMAP handle. The fromWinHBITMAP() function returns a QPixmap that is equivalent to the given bitmap which has the specified format. The QPixmap class also supports conversion to and from HICON: the toWinHICON() function creates a HICON equivalent to the QPixmap, and returns the HICON handle. The fromWinHICON() function returns a QPixmap that is equivalent to the given icon.

In addition, on Symbian, the QPixmap class supports conversion to and from CFbsBitmap: the toSymbianCFbsBitmap() function creates CFbsBitmap equivalent to the QPixmap, based on given mode and returns a CFbsBitmap object. The fromSymbianCFbsBitmap() function returns a QPixmap that is equivalent to the given bitmap and given mode.

Pixmap Transformations

QPixmap supports a number of functions for creating a new pixmap that is a transformed version of the original:

The scaled(), scaledToWidth() and scaledToHeight() functions return scaled copies of the pixmap, while the copy() function creates a QPixmap that is a plain copy of the original one.

The transformed() function returns a copy of the pixmap that is transformed with the given transformation matrix and transformation mode: Internally, the transformation matrix is adjusted to compensate for unwanted translation, i.e. transformed() returns the smallest pixmap containing all transformed points of the original pixmap. The static trueMatrix() function returns the actual matrix used for transforming the pixmap.

Note: When using the native X11 graphics system, the pixmap becomes invalid when the QApplication instance is destroyed.

See also QBitmap, QImage, QImageReader, and QImageWriter.

Member Enumeration Documentation

enum QtGui.QPixmap.HBitmapFormat

Win32 only: This enum defines how the conversion between HBITMAP and QPixmap is performed.

Warning: This enum is only available on Windows.

See also fromWinHBITMAP() and toWinHBITMAP().

Enumerator:

Alpha	The HBITMAP is treated as having a plain alpha channel. This is the preferred format if the HBITMAP is going to be used as an application icon or systray icon.
NoAlpha	The alpha channel is ignored and always treated as being set to fully opaque. This is preferred if the HBITMAP is used with standard GDI calls, such as BitBlt().
PremultipliedAlpha	The HBITMAP is treated as having an alpha channel and premultiplied colors. This is preferred if the HBITMAP is accessed through the AlphaBlend() GDI function.

enum QtGui.QPixmap.Type

Constructor & Destructor Documentation

QtGui.QPixmap.QPixmap ( System.Type  dummy )

protected

QtGui.QPixmap.QPixmap

(

)

Constructs a null pixmap.

See also isNull().

QtGui.QPixmap.QPixmap

(

QSize

arg1

)

This is an overloaded function.

Constructs a pixmap of the given size.

Warning: This will create a QPixmap with uninitialized data. Call fill() to fill the pixmap with an appropriate color before drawing onto it with QPainter.

QtGui.QPixmap.QPixmap

(

QPixmap

arg1

)

Constructs a pixmap that is a copy of the given pixmap.

See also copy().

QtGui.QPixmap.QPixmap	(	int	w,
		int	h
	)

Constructs a pixmap with the given width and height. If either width or height is zero, a null pixmap is constructed.

Warning: This will create a QPixmap with uninitialized data. Call fill() to fill the pixmap with an appropriate color before drawing onto it with QPainter.

See also isNull().

QtGui.QPixmap.QPixmap	(	string	fileName,
		string	format = null,
		Qt.ImageConversionFlag	flags = Qt.ImageConversionFlag.AutoColor
	)

Constructs a null pixmap.

See also isNull().

Member Function Documentation

new long QtGui.QPixmap.CacheKey

(

)

Returns a number that identifies this QPixmap. Distinct QPixmap objects can only have the same cache key if they refer to the same contents.

The cacheKey() will change when the pixmap is altered.

new bool QtGui.QPixmap.ConvertFromImage	(	QImage	img,
		Qt.ImageConversionFlag	flags = Qt.ImageConversionFlag.AutoColor
	)

Replaces this pixmap's data with the given image using the specified flags to control the conversion. The flags argument is a bitwise-OR of the Qt::ImageConversionFlags. Passing 0 for flags sets all the default options. Returns true if the result is that this pixmap is not null.

Note: this function was part of Qt 3 support in Qt 4.6 and earlier. It has been promoted to official API status in 4.7 to support updating the pixmap's image without creating a new QPixmap as fromImage() would.

This function was introduced in Qt 4.7.

See also fromImage().

new QPixmap QtGui.QPixmap.Copy

(

)

Returns a deep copy of the subset of the pixmap that is specified by the given rectangle. For more information on deep copies, see the Implicit Data Sharing documentation.

If the given rectangle is empty, the whole image is copied.

See also operator=(), QPixmap(), and Pixmap Transformations.

new QPixmap QtGui.QPixmap.Copy

(

QRect

rect

)

Returns a deep copy of the subset of the pixmap that is specified by the given rectangle. For more information on deep copies, see the Implicit Data Sharing documentation.

If the given rectangle is empty, the whole image is copied.

See also operator=(), QPixmap(), and Pixmap Transformations.

new QPixmap QtGui.QPixmap.Copy	(	int	x,
		int	y,
		int	width,
		int	height
	)

This is an overloaded function.

Returns a deep copy of the subset of the pixmap that is specified by the rectangle QRect( x, y, width, height).

new QBitmap QtGui.QPixmap.CreateHeuristicMask

(

bool

clipTight = true

)

Creates and returns a heuristic mask for this pixmap.

The function works by selecting a color from one of the corners and then chipping away pixels of that color, starting at all the edges. If clipTight is true (the default) the mask is just large enough to cover the pixels; otherwise, the mask is larger than the data pixels.

The mask may not be perfect but it should be reasonable, so you can do things such as the following:

QPixmap myPixmap;

myPixmap->setMask(myPixmap->createHeuristicMask());

This function is slow because it involves converting to/from a QImage, and non-trivial computations.

See also QImage::createHeuristicMask() and createMaskFromColor().

new QBitmap QtGui.QPixmap.CreateMaskFromColor

(

QColor

maskColor

)

This is an overloaded function.

Creates and returns a mask for this pixmap based on the given maskColor. Same as calling createMaskFromColor(maskColor, Qt::MaskInColor)

See also createHeuristicMask() and QImage::createMaskFromColor().

new QBitmap QtGui.QPixmap.CreateMaskFromColor	(	QColor	maskColor,
		Qt.MaskMode	mode
	)

Creates and returns a mask for this pixmap based on the given maskColor. If the mode is Qt::MaskInColor, all pixels matching the maskColor will be transparent. If mode is Qt::MaskOutColor, all pixels matching the maskColor will be opaque.

This function is slow because it involves converting to/from a QImage.

See also createHeuristicMask() and QImage::createMaskFromColor().

override void QtGui.QPixmap.CreateProxy ( )

virtual

Reimplemented from QtGui.QPaintDevice.

static int QtGui.QPixmap.DefaultDepth ( )

static

Returns the default pixmap depth used by the application.

On Windows and Mac, the default depth is always 32. On X11 and embedded, the depth of the screen will be returned by this function.

See also depth(), QColormap::depth(), and Pixmap Information.

new int QtGui.QPixmap.Depth

(

)

Returns the depth of the pixmap.

The pixmap depth is also called bits per pixel (bpp) or bit planes of a pixmap. A null pixmap has depth 0.

See also defaultDepth() and Pixmap Information.

new void QtGui.QPixmap.Detach

(

)

Detaches the pixmap from shared pixmap data.

A pixmap is automatically detached by Qt whenever its contents are about to change. This is done in almost all QPixmap member functions that modify the pixmap (fill(), fromImage(), load(), etc.), and in QPainter::begin() on a pixmap.

There are two exceptions in which detach() must be called explicitly, that is when calling the handle() or the x11PictureHandle() function (only available on X11). Otherwise, any modifications done using system calls, will be performed on the shared data.

The detach() function returns immediately if there is just a single reference or if the pixmap has not been initialized yet.

override int QtGui.QPixmap.DevType ( )

virtual

Reimplemented from QtGui.QPaintDevice.

new void QtGui.QPixmap.Dispose

(

)

new void QtGui.QPixmap.Fill

(

)

Fills the pixmap with the given color.

The effect of this function is undefined when the pixmap is being painted on.

See also Pixmap Transformations.

new void QtGui.QPixmap.Fill

(

QColor

fillColor

)

Fills the pixmap with the given color.

The effect of this function is undefined when the pixmap is being painted on.

See also Pixmap Transformations.

new void QtGui.QPixmap.Fill	(	QWidget	widget,
		QPoint	ofs
	)

Fills the pixmap with the widget's background color or pixmap according to the given offset.

The QPoint offset defines a point in widget coordinates to which the pixmap's top-left pixel will be mapped to. This is only significant if the widget has a background pixmap; otherwise the pixmap will simply be filled with the background color of the widget.

new void QtGui.QPixmap.Fill	(	QWidget	widget,
		int	xofs,
		int	yofs
	)

This is an overloaded function.

Fills the pixmap with the widget's background color or pixmap. The given point, (x, y), defines an offset in widget coordinates to which the pixmap's top-left pixel will be mapped to.

static QPixmap QtGui.QPixmap.FromImage ( QImage  image, Qt.ImageConversionFlag  flags = Qt.ImageConversionFlag.AutoColor  )

static

Converts the given image to a pixmap using the specified flags to control the conversion. The flags argument is a bitwise-OR of the Qt::ImageConversionFlags. Passing 0 for flags sets all the default options.

In case of monochrome and 8-bit images, the image is first converted to a 32-bit pixmap and then filled with the colors in the color table. If this is too expensive an operation, you can use QBitmap::fromImage() instead.

See also fromImageReader(), toImage(), and Pixmap Conversion.

static QPixmap QtGui.QPixmap.FromImageReader ( QImageReader  imageReader, Qt.ImageConversionFlag  flags = Qt.ImageConversionFlag.AutoColor  )

static

Create a QPixmap from an image read directly from an imageReader. The flags argument is a bitwise-OR of the Qt::ImageConversionFlags. Passing 0 for flags sets all the default options.

On some systems, reading an image directly to QPixmap can use less memory than reading a QImage to convert it to QPixmap.

See also fromImage(), toImage(), and Pixmap Conversion.

static QPixmap QtGui.QPixmap.FromWinHBITMAP ( System.IntPtr  hbitmap, QPixmap.HBitmapFormat  format = QPixmap.HBitmapFormat.NoAlpha  )

static

Win32 only: Returns a QPixmap that is equivalent to the given bitmap. The conversion is based on the specified format.

Warning: This function is only available on Windows.

See also toWinHBITMAP() and Pixmap Conversion.

static QPixmap QtGui.QPixmap.FromWinHICON ( System.IntPtr  hicon )

static

Win32 only: Returns a QPixmap that is equivalent to the given icon.

Warning: This function is only available on Windows.

This function was introduced in Qt 4.6.

See also toWinHICON() and Pixmap Conversion.

static QPixmap QtGui.QPixmap.GrabWidget ( QWidget  widget, QRect  rect  )

static

Creates a pixmap and paints the given widget, restricted by the given rectangle, in it. If the widget has any children, then they are also painted in the appropriate positions.

If no rectangle is specified (the default) the entire widget is painted.

If widget is 0, the specified rectangle doesn't overlap the widget's rectangle, or an error occurs, the function will return a null QPixmap. If the rectangle is a superset of the given widget, the areas outside the widget are covered with the widget's background.

This function actually asks widget to paint itself (and its children to paint themselves) by calling paintEvent() with painter redirection turned on. But QPixmap also provides the grabWindow() function which is a bit faster by grabbing pixels directly off the screen. In addition, if there are overlaying windows, grabWindow(), unlike grabWidget(), will see them.

Warning: Do not grab a widget from its QWidget::paintEvent(). However, it is safe to grab a widget from another widget's paintEvent().

See also grabWindow().

static QPixmap QtGui.QPixmap.GrabWidget ( QWidget  widget, int  x = 0, int  y = 0, int  w = -1, int  h = -1  )

static

Creates a pixmap and paints the given widget, restricted by the given rectangle, in it. If the widget has any children, then they are also painted in the appropriate positions.

If no rectangle is specified (the default) the entire widget is painted.

If widget is 0, the specified rectangle doesn't overlap the widget's rectangle, or an error occurs, the function will return a null QPixmap. If the rectangle is a superset of the given widget, the areas outside the widget are covered with the widget's background.

This function actually asks widget to paint itself (and its children to paint themselves) by calling paintEvent() with painter redirection turned on. But QPixmap also provides the grabWindow() function which is a bit faster by grabbing pixels directly off the screen. In addition, if there are overlaying windows, grabWindow(), unlike grabWidget(), will see them.

Warning: Do not grab a widget from its QWidget::paintEvent(). However, it is safe to grab a widget from another widget's paintEvent().

See also grabWindow().

static QPixmap QtGui.QPixmap.GrabWindow ( NativeULong  arg1, int  x = 0, int  y = 0, int  w = -1, int  h = -1  )

static

Creates and returns a pixmap constructed by grabbing the contents of the given window restricted by QRect(x, y, width, height).

The arguments (x, y) specify the offset in the window, whereas (width, height) specify the area to be copied. If width is negative, the function copies everything to the right border of the window. If height is negative, the function copies everything to the bottom of the window.

The window system identifier (WId) can be retrieved using the QWidget::winId() function. The rationale for using a window identifier and not a QWidget, is to enable grabbing of windows that are not part of the application, window system frames, and so on.

The grabWindow() function grabs pixels from the screen, not from the window, i.e. if there is another window partially or entirely over the one you grab, you get pixels from the overlying window, too. The mouse cursor is generally not grabbed.

Note on X11 that if the given window doesn't have the same depth as the root window, and another window partially or entirely obscures the one you grab, you will not get pixels from the overlying window. The contents of the obscured areas in the pixmap will be undefined and uninitialized.

On Windows Vista and above grabbing a layered window, which is created by setting the Qt::WA_TranslucentBackground attribute, will not work. Instead grabbing the desktop widget should work.

Warning: In general, grabbing an area outside the screen is not safe. This depends on the underlying window system.

See also grabWidget() and Screenshot Example.

new bool QtGui.QPixmap.HasAlpha

(

)

Returns true if this pixmap has an alpha channel, or has a mask, otherwise returns false.

See also hasAlphaChannel() and mask().

new bool QtGui.QPixmap.HasAlphaChannel

(

)

Returns true if the pixmap has a format that respects the alpha channel, otherwise returns false.

See also hasAlpha().

new int QtGui.QPixmap.Height

(

)

Returns the height of the pixmap.

See also size() and Pixmap Information.

new bool QtGui.QPixmap.IsDetached

(

)

new bool QtGui.QPixmap.IsNull

(

)

Returns true if this is a null pixmap; otherwise returns false.

A null pixmap has zero width, zero height and no contents. You cannot draw in a null pixmap.

new bool QtGui.QPixmap.IsQBitmap

(

)

Returns true if this is a QBitmap; otherwise returns false.

new bool QtGui.QPixmap.Load	(	string	fileName,
		string	format = null,
		Qt.ImageConversionFlag	flags = Qt.ImageConversionFlag.AutoColor
	)

Loads a pixmap from the file with the given fileName. Returns true if the pixmap was successfully loaded; otherwise returns false.

The loader attempts to read the pixmap using the specified format. If the format is not specified (which is the default), the loader probes the file for a header to guess the file format.

The file name can either refer to an actual file on disk or to one of the application's embedded resources. See the Resource System overview for details on how to embed pixmaps and other resource files in the application's executable.

If the data needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the flags to control the conversion.

Note that QPixmaps are automatically added to the QPixmapCache when loaded from a file; the key used is internal and can not be acquired.

See also loadFromData() and Reading and Writing Image Files.

new bool QtGui.QPixmap.LoadFromData	(	QByteArray	data,
		string	format = null,
		Qt.ImageConversionFlag	flags = Qt.ImageConversionFlag.AutoColor
	)

Loads a pixmap from the len first bytes of the given binary data. Returns true if the pixmap was loaded successfully; otherwise returns false.

The loader attempts to read the pixmap using the specified format. If the format is not specified (which is the default), the loader probes the file for a header to guess the file format.

If the data needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the flags to control the conversion.

See also load() and Reading and Writing Image Files.

new bool QtGui.QPixmap.LoadFromData	(	Pointer< byte >	buf,
		uint	len,
		string	format = null,
		Qt.ImageConversionFlag	flags = Qt.ImageConversionFlag.AutoColor
	)

Loads a pixmap from the len first bytes of the given binary data. Returns true if the pixmap was loaded successfully; otherwise returns false.

The loader attempts to read the pixmap using the specified format. If the format is not specified (which is the default), the loader probes the file for a header to guess the file format.

If the data needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the flags to control the conversion.

See also load() and Reading and Writing Image Files.

override int QtGui.QPixmap.Metric ( QPaintDevice.PaintDeviceMetric  metric )

protectedvirtual

Returns the metric information for the given paint device metric.

See also PaintDeviceMetric.

Reimplemented from QtGui.QPaintDevice.

static bool QtGui.QPixmap.operator! ( QPixmap  arg1 )

static

Returns true if this is a null pixmap; otherwise returns false.

See also isNull().

override QPaintEngine QtGui.QPixmap.PaintEngine ( )

virtual

Returns a pointer to the paint engine used for drawing on the device.

Implements QtGui.QPaintDevice.

new QRect QtGui.QPixmap.Rect

(

)

Returns the pixmap's enclosing rectangle.

See also Pixmap Information.

new bool QtGui.QPixmap.Save	(	QIODevice	device,
		string	format = null,
		int	quality = -1
	)

Saves the pixmap to the file with the given fileName using the specified image file format and quality factor. Returns true if successful; otherwise returns false.

The quality factor must be in the range [0,100] or -1. Specify 0 to obtain small compressed files, 100 for large uncompressed files, and -1 to use the default settings.

If format is 0, an image format will be chosen from fileName's suffix.

See also Reading and Writing Image Files.

new bool QtGui.QPixmap.Save	(	string	fileName,
		string	format = null,
		int	quality = -1
	)

Saves the pixmap to the file with the given fileName using the specified image file format and quality factor. Returns true if successful; otherwise returns false.

The quality factor must be in the range [0,100] or -1. Specify 0 to obtain small compressed files, 100 for large uncompressed files, and -1 to use the default settings.

If format is 0, an image format will be chosen from fileName's suffix.

See also Reading and Writing Image Files.

new QPixmap QtGui.QPixmap.Scaled	(	QSize	s,
		Qt.AspectRatioMode	aspectMode = Qt.AspectRatioMode.IgnoreAspectRatio,
		Qt.TransformationMode	mode = Qt.TransformationMode.FastTransformation
	)

Scales the pixmap to the given size, using the aspect ratio and transformation modes specified by aspectRatioMode and transformMode.

If aspectRatioMode is Qt::IgnoreAspectRatio, the pixmap is scaled to size.

If aspectRatioMode is Qt::KeepAspectRatio, the pixmap is scaled to a rectangle as large as possible inside size, preserving the aspect ratio.

If aspectRatioMode is Qt::KeepAspectRatioByExpanding, the pixmap is scaled to a rectangle as small as possible outside size, preserving the aspect ratio.

If the given size is empty, this function returns a null pixmap.

In some cases it can be more beneficial to draw the pixmap to a painter with a scale set rather than scaling the pixmap. This is the case when the painter is for instance based on OpenGL or when the scale factor changes rapidly.

See also isNull() and Pixmap Transformations.

new QPixmap QtGui.QPixmap.Scaled	(	int	w,
		int	h,
		Qt.AspectRatioMode	aspectMode = Qt.AspectRatioMode.IgnoreAspectRatio,
		Qt.TransformationMode	mode = Qt.TransformationMode.FastTransformation
	)

Scales the pixmap to the given size, using the aspect ratio and transformation modes specified by aspectRatioMode and transformMode.

If aspectRatioMode is Qt::IgnoreAspectRatio, the pixmap is scaled to size.

If aspectRatioMode is Qt::KeepAspectRatio, the pixmap is scaled to a rectangle as large as possible inside size, preserving the aspect ratio.

If aspectRatioMode is Qt::KeepAspectRatioByExpanding, the pixmap is scaled to a rectangle as small as possible outside size, preserving the aspect ratio.

If the given size is empty, this function returns a null pixmap.

In some cases it can be more beneficial to draw the pixmap to a painter with a scale set rather than scaling the pixmap. This is the case when the painter is for instance based on OpenGL or when the scale factor changes rapidly.

See also isNull() and Pixmap Transformations.

new QPixmap QtGui.QPixmap.ScaledToHeight	(	int	h,
		Qt.TransformationMode	mode = Qt.TransformationMode.FastTransformation
	)

Returns a scaled copy of the image. The returned image is scaled to the given height using the specified transformation mode. The width of the pixmap is automatically calculated so that the aspect ratio of the pixmap is preserved.

If height is 0 or negative, a null pixmap is returned.

See also isNull() and Pixmap Transformations.

new QPixmap QtGui.QPixmap.ScaledToWidth	(	int	w,
		Qt.TransformationMode	mode = Qt.TransformationMode.FastTransformation
	)

Returns a scaled copy of the image. The returned image is scaled to the given width using the specified transformation mode. The height of the pixmap is automatically calculated so that the aspect ratio of the pixmap is preserved.

If width is 0 or negative, a null pixmap is returned.

See also isNull() and Pixmap Transformations.

new void QtGui.QPixmap.Scroll	(	int	dx,
		int	dy,
		QRect	rect,
		QRegion	exposed = null
	)

Scrolls the area rect of this pixmap by (dx, dy). The exposed region is left unchanged. You can optionally pass a pointer to an empty QRegion to get the region that is exposed by the scroll operation.

QPixmap pixmap("background.png");

QRegion exposed;

pixmap.scroll(10, 10, pixmap.rect(), &exposed);

You cannot scroll while there is an active painter on the pixmap.

This function was introduced in Qt 4.6.

See also QWidget::scroll() and QGraphicsItem::scroll().

new void QtGui.QPixmap.Scroll	(	int	dx,
		int	dy,
		int	x,
		int	y,
		int	width,
		int	height,
		QRegion	exposed = null
	)

This convenience function is equivalent to calling QPixmap::scroll(dx, dy, QRect(x, y, width, height), exposed).

This function was introduced in Qt 4.6.

See also QWidget::scroll() and QGraphicsItem::scroll().

new int QtGui.QPixmap.SerialNumber

(

)

new QSize QtGui.QPixmap.Size

(

)

Returns the size of the pixmap.

See also width(), height(), and Pixmap Information.

new void QtGui.QPixmap.Swap

(

QPixmap

other

)

Swaps pixmap other with this pixmap. This operation is very fast and never fails.

This function was introduced in Qt 4.8.

new QImage QtGui.QPixmap.ToImage

(

)

Converts the pixmap to a QImage. Returns a null image if the conversion fails.

If the pixmap has 1-bit depth, the returned image will also be 1 bit deep. Images with more bits will be returned in a format closely represents the underlying system. Usually this will be QImage::Format_ARGB32_Premultiplied for pixmaps with an alpha and QImage::Format_RGB32 or QImage::Format_RGB16 for pixmaps without alpha.

Note that for the moment, alpha masks on monochrome images are ignored.

See also fromImage() and Image Formats.

new System.IntPtr QtGui.QPixmap.ToWinHBITMAP

(

QPixmap.HBitmapFormat

format = QPixmap.HBitmapFormat.NoAlpha

)

Win32 only: Creates a HBITMAP equivalent to the QPixmap, based on the given format. Returns the HBITMAP handle.

It is the caller's responsibility to free the HBITMAP data after use.

Warning: This function is only available on Windows.

See also fromWinHBITMAP() and Pixmap Conversion.

new System.IntPtr QtGui.QPixmap.ToWinHICON

(

)

Win32 only: Creates a HICON equivalent to the QPixmap. Returns the HICON handle.

It is the caller's responsibility to free the HICON data after use.

Warning: This function is only available on Windows.

This function was introduced in Qt 4.6.

See also fromWinHICON() and Pixmap Conversion.

new QPixmap QtGui.QPixmap.Transformed	(	QMatrix	arg1,
		Qt.TransformationMode	mode = Qt.TransformationMode.FastTransformation
	)

Returns a copy of the pixmap that is transformed using the given transformation transform and transformation mode. The original pixmap is not changed.

The transformation transform is internally adjusted to compensate for unwanted translation; i.e. the pixmap produced is the smallest pixmap that contains all the transformed points of the original pixmap. Use the trueMatrix() function to retrieve the actual matrix used for transforming the pixmap.

This function is slow because it involves transformation to a QImage, non-trivial computations and a transformation back to a QPixmap.

See also trueMatrix() and Pixmap Transformations.

new QPixmap QtGui.QPixmap.Transformed	(	QTransform	arg1,
		Qt.TransformationMode	mode = Qt.TransformationMode.FastTransformation
	)

Returns a copy of the pixmap that is transformed using the given transformation transform and transformation mode. The original pixmap is not changed.

The transformation transform is internally adjusted to compensate for unwanted translation; i.e. the pixmap produced is the smallest pixmap that contains all the transformed points of the original pixmap. Use the trueMatrix() function to retrieve the actual matrix used for transforming the pixmap.

This function is slow because it involves transformation to a QImage, non-trivial computations and a transformation back to a QPixmap.

See also trueMatrix() and Pixmap Transformations.

static QMatrix QtGui.QPixmap.TrueMatrix ( QMatrix  m, int  w, int  h  )

static

This is an overloaded function.

This convenience function loads the matrix m into a QTransform and calls the overloaded function with the QTransform and the width w and the height h.

static QTransform QtGui.QPixmap.TrueMatrix ( QTransform  m, int  w, int  h  )

static

Returns the actual matrix used for transforming a pixmap with the given width, height and matrix.

When transforming a pixmap using the transformed() function, the transformation matrix is internally adjusted to compensate for unwanted translation, i.e. transformed() returns the smallest pixmap containing all transformed points of the original pixmap. This function returns the modified matrix, which maps points correctly from the original pixmap into the new pixmap.

See also transformed() and Pixmap Transformations.

new int QtGui.QPixmap.Width

(

)

Returns the width of the pixmap.

See also size() and Pixmap Information.

Property Documentation

new QPixmap QtGui.QPixmap.AlphaChannel

getset

new QBitmap QtGui.QPixmap.Mask

getset

Extracts a bitmap mask from the pixmap's alpha channel.

Warning: This is potentially an expensive operation. The mask of the pixmap is extracted dynamically from the pixeldata.

Sets a mask bitmap.

This function merges the mask with the pixmap's alpha channel. A pixel value of 1 on the mask means the pixmap's pixel is unchanged; a value of 0 means the pixel is transparent. The mask must have the same size as this pixmap.

Setting a null mask resets the mask, leaving the previously transparent pixels black. The effect of this function is undefined when the pixmap is being painted on.

Warning: This is potentially an expensive operation.