QImage¶

Synopsis¶

Functions¶

def __eq__ (arg__1)
def __ne__ (arg__1)
def allGray ()
def alphaChannel ()
def bitPlaneCount ()
def byteCount ()
def bytesPerLine ()
def cacheKey ()
def color (i)
def colorTable ()
def constBits ()
def constScanLine (arg__1)
def convertToFormat (f, colorTable[, flags=Qt.AutoColor])
def convertToFormat (f[, flags=Qt.AutoColor])
def copy ([rect=QRect()])
def copy (x, y, w, h)
def createAlphaMask ([flags=Qt.AutoColor])
def createHeuristicMask ([clipTight=true])
def createMaskFromColor (color[, mode=Qt.MaskInColor])
def dotsPerMeterX ()
def dotsPerMeterY ()
def fill (color)
def fill (color)
def fill (pixel)
def format ()
def hasAlphaChannel ()
def invertPixels ([mode=InvertRgb])
def isGrayscale ()
def isNull ()
def load (device, format)
def load (fileName[, format=0])
def loadFromData (data[, aformat=0])
def mirrored ([horizontally=false[, vertically=true]])
def numBytes ()
def offset ()
def pixel (pt)
def pixel (x, y)
def pixelIndex (pt)
def pixelIndex (x, y)
def rect ()
def rgbSwapped ()
def save (device[, format=0[, quality=-1]])
def save (fileName[, format=0[, quality=-1]])
def scaled (s[, aspectMode=Qt.IgnoreAspectRatio[, mode=Qt.FastTransformation]])
def scaled (w, h[, aspectMode=Qt.IgnoreAspectRatio[, mode=Qt.FastTransformation]])
def scaledToHeight (h[, mode=Qt.FastTransformation])
def scaledToWidth (w[, mode=Qt.FastTransformation])
def setAlphaChannel (alphaChannel)
def setColor (i, c)
def setColorCount (arg__1)
def setColorTable (colors)
def setDotsPerMeterX (arg__1)
def setDotsPerMeterY (arg__1)
def setNumColors (arg__1)
def setOffset (arg__1)
def setPixel (pt, index_or_rgb)
def setPixel (x, y, index_or_rgb)
def setText (key, value)
def size ()
def swap (other)
def text ([key=”“])
def textKeys ()
def transformed (matrix[, mode=Qt.FastTransformation])
def transformed (matrix[, mode=Qt.FastTransformation])
def valid (pt)
def valid (x, y)

Static functions¶

def fromData (data[, format=0])
def trueMatrix (arg__1, w, h)
def trueMatrix (arg__1, w, h)

Detailed Description¶

The PySide.QtGui.QImage class provides a hardware-independent image representation that allows direct access to the pixel data, and can be used as a paint device.

Qt provides four classes for handling image data: PySide.QtGui.QImage , PySide.QtGui.QPixmap , PySide.QtGui.QBitmap and PySide.QtGui.QPicture . PySide.QtGui.QImage is designed and optimized for I/O, and for direct pixel access and manipulation, while PySide.QtGui.QPixmap is designed and optimized for showing images on screen. PySide.QtGui.QBitmap is only a convenience class that inherits PySide.QtGui.QPixmap , ensuring a depth of 1. Finally, the PySide.QtGui.QPicture class is a paint device that records and replays PySide.QtGui.QPainter commands.

Because PySide.QtGui.QImage is a PySide.QtGui.QPaintDevice subclass, PySide.QtGui.QPainter can be used to draw directly onto images. When using PySide.QtGui.QPainter on a PySide.QtGui.QImage , the painting can be performed in another thread than the current GUI thread.

The PySide.QtGui.QImage class supports several image formats described by the QImage.Format enum. These include monochrome, 8-bit, 32-bit and alpha-blended images which are available in all versions of Qt 4.x.

PySide.QtGui.QImage provides a collection of functions that can be used to obtain a variety of information about the image. There are also several functions that enables transformation of the image.

PySide.QtGui.QImage objects can be passed around by value since the PySide.QtGui.QImage class uses implicit data sharing . PySide.QtGui.QImage objects can also be streamed and compared.

Note

If you would like to load PySide.QtGui.QImage objects in a static build of Qt, refer to the Plugin HowTo .

Warning

Painting on a PySide.QtGui.QImage with the format QImage.Format_Indexed8 is not supported.

Reading and Writing Image Files¶

PySide.QtGui.QImage provides several ways of loading an image file: The file can be loaded when constructing the PySide.QtGui.QImage object, or by using the PySide.QtGui.QImage.load() or PySide.QtGui.QImage.loadFromData() functions later on. PySide.QtGui.QImage also provides the static PySide.QtGui.QImage.fromData() function, constructing a PySide.QtGui.QImage from the given data. 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 PySide.QtGui.QImage.save() function to save a PySide.QtGui.QImage 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:

Format Description Qt’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

TIFF Tagged Image File Format Read/write

XBM X11 Bitmap Read/write

XPM X11 Pixmap Read/write

Image Information¶

PySide.QtGui.QImage provides a collection of functions that can be used to obtain a variety of information about the image:

Available Functions

Geometry
The PySide.QtGui.QImage.size() , PySide.QtGui.QImage.width() , PySide.QtGui.QImage.height() , PySide.QtGui.QImage.dotsPerMeterX() , and PySide.QtGui.QImage.dotsPerMeterY() functions provide information about the image size and aspect ratio.

The PySide.QtGui.QImage.rect() function returns the image’s enclosing rectangle. The PySide.QtGui.QImage.valid() function tells if a given pair of coordinates is within this rectangle. The PySide.QtGui.QImage.offset() function returns the number of pixels by which the image is intended to be offset by when positioned relative to other images, which also can be manipulated using the PySide.QtGui.QImage.setOffset() function.

Colors
The color of a pixel can be retrieved by passing its coordinates to the PySide.QtGui.QImage.pixel() function. The PySide.QtGui.QImage.pixel() function returns the color as a QRgb value indepedent of the image’s format.

In case of monochrome and 8-bit images, the PySide.QtGui.QImage.colorCount() and PySide.QtGui.QImage.colorTable() functions provide information about the color components used to store the image data: The PySide.QtGui.QImage.colorTable() function returns the image’s entire color table. To obtain a single entry, use the PySide.QtGui.QImage.pixelIndex() function to retrieve the pixel index for a given pair of coordinates, then use the PySide.QtGui.QImage.color() function to retrieve the color. Note that if you create an 8-bit image manually, you have to set a valid color table on the image as well.

The PySide.QtGui.QImage.hasAlphaChannel() function tells if the image’s format respects the alpha channel, or not. The PySide.QtGui.QImage.allGray() and PySide.QtGui.QImage.isGrayscale() functions tell whether an image’s colors are all shades of gray.

See also the Pixel Manipulation and Image Transformations sections.

Text The PySide.QtGui.QImage.text() function returns the image text associated with the given text key. An image’s text keys can be retrieved using the PySide.QtGui.QImage.textKeys() function. Use the PySide.QtGui.QImage.setText() function to alter an image’s text.

Low-level information
The PySide.QtGui.QImage.depth() function returns the depth of the image. The supported depths are 1 (monochrome), 8, 16, 24 and 32 bits. The PySide.QtGui.QImage.bitPlaneCount() function tells how many of those bits that are used. For more information see the Image Formats section.

The PySide.QtGui.QImage.format() , PySide.QtGui.QImage.bytesPerLine() , and PySide.QtGui.QImage.byteCount() functions provide low-level information about the data stored in the image.

The PySide.QtGui.QImage.cacheKey() function returns a number that uniquely identifies the contents of this PySide.QtGui.QImage object.

Pixel Manipulation¶

The functions used to manipulate an image’s pixels depend on the image format. The reason is that monochrome and 8-bit images are index-based and use a color lookup table, while 32-bit images store ARGB values directly. For more information on image formats, see the Image Formats section.

In case of a 32-bit image, the PySide.QtGui.QImage.setPixel() function can be used to alter the color of the pixel at the given coordinates to any other color specified as an ARGB quadruplet. To make a suitable QRgb value, use the qRgb() (adding a default alpha component to the given RGB values, i.e. creating an opaque color) or qRgba() function. For example:
32-bit
image = QImage(3, 3, QImage.Format_RGB32)

value = qRgb(189, 149, 39)  # 0xffbd9527
image.setPixel(1, 1, value)

value = qRgb(122, 163, 39)  # 0xff7aa327
image.setPixel(0, 1, value)
image.setPixel(1, 0, value)

value = qRgb(237, 187, 51)  # 0xffedba31
image.setPixel(2, 1, value)
In case of a 8-bit and monchrome images, the pixel value is only an index from the image’s color table. So the PySide.QtGui.QImage.setPixel() function can only be used to alter the color of the pixel at the given coordinates to a predefined color from the image’s color table, i.e. it can only change the pixel’s index value. To alter or add a color to an image’s color table, use the PySide.QtGui.QImage.setColor() function.

An entry in the color table is an ARGB quadruplet encoded as an QRgb value. Use the qRgb() and qRgba() functions to make a suitable QRgb value for use with the PySide.QtGui.QImage.setColor() function. For example:
8-bit
image = QImage(3, 3, QImage.Format_Indexed8)
value = qRgb(122, 163, 39) # 0xff7aa327
image.setColor(0, value)

value = qRgb(237, 187, 51) # 0xffedba31
image.setColor(1, value)

value = qRgb(189, 149, 39) # 0xffbd9527
image.setColor(2, value)

image.setPixel(0, 1, 0)
image.setPixel(1, 0, 0)
image.setPixel(1, 1, 2)
image.setPixel(2, 1, 1)
PySide.QtGui.QImage also provide the PySide.QtGui.QImage.scanLine() function which returns a pointer to the pixel data at the scanline with the given index, and the PySide.QtGui.QImage.bits() function which returns a pointer to the first pixel data (this is equivalent to scanLine(0) ).

Image Formats¶

Each pixel stored in a PySide.QtGui.QImage is represented by an integer. The size of the integer varies depending on the format. PySide.QtGui.QImage supports several image formats described by the QImage.Format enum.

Monochrome images are stored using 1-bit indexes into a color table with at most two colors. There are two different types of monochrome images: big endian (MSB first) or little endian (LSB first) bit order.

8-bit images are stored using 8-bit indexes into a color table, i.e. they have a single byte per pixel. The color table is a QVector < QRgb >, and the QRgb typedef is equivalent to an unsigned int containing an ARGB quadruplet on the format 0xAARRGGBB.

32-bit images have no color table; instead, each pixel contains an QRgb value. There are three different types of 32-bit images storing RGB (i.e. 0xffRRGGBB), ARGB and premultiplied ARGB values respectively. In the premultiplied format the red, green, and blue channels are multiplied by the alpha component divided by 255.

An image’s format can be retrieved using the PySide.QtGui.QImage.format() function. Use the PySide.QtGui.QImage.convertToFormat() functions to convert an image into another format. The PySide.QtGui.QImage.allGray() and PySide.QtGui.QImage.isGrayscale() functions tell whether a color image can safely be converted to a grayscale image.

Image Transformations¶

PySide.QtGui.QImage supports a number of functions for creating a new image that is a transformed version of the original: The PySide.QtGui.QImage.createAlphaMask() function builds and returns a 1-bpp mask from the alpha buffer in this image, and the PySide.QtGui.QImage.createHeuristicMask() function creates and returns a 1-bpp heuristic mask for this image. The latter function works by selecting a color from one of the corners, then chipping away pixels of that color starting at all the edges.

The PySide.QtGui.QImage.mirrored() function returns a mirror of the image in the desired direction, the PySide.QtGui.QImage.scaled() returns a copy of the image scaled to a rectangle of the desired measures, and the PySide.QtGui.QImage.rgbSwapped() function constructs a BGR image from a RGB image.

The PySide.QtGui.QImage.scaledToWidth() and PySide.QtGui.QImage.scaledToHeight() functions return scaled copies of the image.

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

There are also functions for changing attributes of an image in-place:

Function Description

PySide.QtGui.QImage.setDotsPerMeterX() Defines the aspect ratio by setting the number of pixels that fit horizontally in a physical meter.

PySide.QtGui.QImage.setDotsPerMeterY() Defines the aspect ratio by setting the number of pixels that fit vertically in a physical meter.

PySide.QtGui.QImage.fill() Fills the entire image with the given pixel value.

PySide.QtGui.QImage.invertPixels() Inverts all pixel values in the image using the given QImage.InvertMode value.

PySide.QtGui.QImage.setColorTable() Sets the color table used to translate color indexes. Only monochrome and 8-bit formats.

PySide.QtGui.QImage.setColorCount() Resizes the color table. Only monochrome and 8-bit formats.

Legal Information¶

For smooth scaling, the PySide.QtGui.QImage.transformed() functions use code based on smooth scaling algorithm by Daniel M. Duley.

Copyright (C) 2004, 2005 Daniel M. Duley



Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:



1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.



THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

See also

PySide.QtGui.QImageReader PySide.QtGui.QImageWriter PySide.QtGui.QPixmap PySide.QtSvg.QSvgRenderer Image Composition Example Image Viewer Example Scribble Example Pixelator Example

class PySide.QtGui.QImage¶

class PySide.QtGui.QImage(arg__1, arg__2, arg__3, arg__4)

class PySide.QtGui.QImage(arg__1, arg__2, arg__3, arg__4, arg__5)

class PySide.QtGui.QImage(arg__1)

class PySide.QtGui.QImage(size, format)

class PySide.QtGui.QImage(fileName[, format=0])

class PySide.QtGui.QImage(xpm)

class PySide.QtGui.QImage(width, height, format)

class PySide.QtGui.QImage(data, width, height, format)

class PySide.QtGui.QImage(data, width, height, bytesPerLine, format)

Parameters:

arg__4 – PySide.QtGui.QImage.Format
width – PySide.QtCore.int
arg__5 – PySide.QtGui.QImage.Format
size – PySide.QtCore.QSize
format – PySide.QtGui.QImage.Format
height – PySide.QtCore.int
data – PySide.QtCore.uchar
bytesPerLine – PySide.QtCore.int
fileName – unicode
arg__1 – unicode
arg__2 – PySide.QtCore.int
xpm – PySide.QtCore.char
arg__3 – PySide.QtCore.int

Constructs a null image.

See also

PySide.QtGui.QImage.isNull()

Constructs a shallow copy of the given image .

For more information about shallow copies, see the Implicit Data Sharing documentation.

See also

PySide.QtGui.QImage.copy()

Constructs an image with the given size and format .

A null image is returned if memory cannot be allocated.

Warning

This will create a PySide.QtGui.QImage with uninitialized data. Call PySide.QtGui.QImage.fill() to fill the image with an appropriate pixel value before drawing onto it with PySide.QtGui.QPainter .

Constructs an image and tries to load the image from the file with the given fileName .

The loader attempts to read the image 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 loading of the image failed, this object is a null image.

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 images and other resource files in the application’s executable.

See also

PySide.QtGui.QImage.isNull() Reading and Writing Image Files

Constructs an image with the given width , height and format .

A null image will be returned if memory cannot be allocated.

Warning

This will create a PySide.QtGui.QImage with uninitialized data. Call PySide.QtGui.QImage.fill() to fill the image with an appropriate pixel value before drawing onto it with PySide.QtGui.QPainter .

Constructs an image with the given width , height and format , that uses an existing memory buffer, data . The width and height must be specified in pixels, data must be 32-bit aligned, and each scanline of data in the image must also be 32-bit aligned.

The buffer must remain valid throughout the life of the PySide.QtGui.QImage . The image does not delete the buffer at destruction.

If format is an indexed color format, the image color table is initially empty and must be sufficiently expanded with PySide.QtGui.QImage.setColorCount() or PySide.QtGui.QImage.setColorTable() before the image is used.

Constructs an image with the given width , height and format , that uses an existing memory buffer, data . The width and height must be specified in pixels. bytesPerLine specifies the number of bytes per line (stride).

The buffer must remain valid throughout the life of the PySide.QtGui.QImage . The image does not delete the buffer at destruction.

If format is an indexed color format, the image color table is initially empty and must be sufficiently expanded with PySide.QtGui.QImage.setColorCount() or PySide.QtGui.QImage.setColorTable() before the image is used.

PySide.QtGui.QImage.InvertMode¶

This enum type is used to describe how pixel values should be inverted in the PySide.QtGui.QImage.invertPixels() function.

Constant	Description
QImage.InvertRgb	Invert only the RGB values and leave the alpha channel unchanged.
QImage.InvertRgba	Invert all channels, including the alpha channel.

See also

PySide.QtGui.QImage.invertPixels()

PySide.QtGui.QImage.Format¶

The following image formats are available in Qt. Values greater than QImage.Format_RGB16 were added in Qt 4.4. See the notes after the table.

Constant	Description
QImage.Format_Invalid	The image is invalid.
QImage.Format_Mono	The image is stored using 1-bit per pixel. Bytes are packed with the most significant bit (MSB) first.
QImage.Format_MonoLSB	The image is stored using 1-bit per pixel. Bytes are packed with the less significant bit (LSB) first.
QImage.Format_Indexed8	The image is stored using 8-bit indexes into a colormap.
QImage.Format_RGB32	The image is stored using a 32-bit RGB format (0xffRRGGBB).
QImage.Format_ARGB32	The image is stored using a 32-bit ARGB format (0xAARRGGBB).
QImage.Format_ARGB32_Premultiplied	The image is stored using a premultiplied 32-bit ARGB format (0xAARRGGBB), i.e. the red, green, and blue channels are multiplied by the alpha component divided by 255. (If RR, GG, or BB has a higher value than the alpha channel, the results are undefined.) Certain operations (such as image composition using alpha blending) are faster using premultiplied ARGB32 than with plain ARGB32.
QImage.Format_RGB16	The image is stored using a 16-bit RGB format (5-6-5).
QImage.Format_ARGB8565_Premultiplied	The image is stored using a premultiplied 24-bit ARGB format (8-5-6-5).
QImage.Format_RGB666	The image is stored using a 24-bit RGB format (6-6-6). The unused most significant bits is always zero.
QImage.Format_ARGB6666_Premultiplied	The image is stored using a premultiplied 24-bit ARGB format (6-6-6-6).
QImage.Format_RGB555	The image is stored using a 16-bit RGB format (5-5-5). The unused most significant bit is always zero.
QImage.Format_ARGB8555_Premultiplied	The image is stored using a premultiplied 24-bit ARGB format (8-5-5-5).
QImage.Format_RGB888	The image is stored using a 24-bit RGB format (8-8-8).
QImage.Format_RGB444	The image is stored using a 16-bit RGB format (4-4-4). The unused bits are always zero.
QImage.Format_ARGB4444_Premultiplied	The image is stored using a premultiplied 16-bit ARGB format (4-4-4-4).

Note

Drawing into a PySide.QtGui.QImage with QImage.Format_Indexed8 is not supported.

Note

Do not render into ARGB32 images using PySide.QtGui.QPainter . Using QImage.Format_ARGB32_Premultiplied is significantly faster.

PySide.QtGui.QImage.allGray()¶

Return type:	`PySide.QtCore.bool`

Returns true if all the colors in the image are shades of gray (i.e. their red, green and blue components are equal); otherwise false.

Note that this function is slow for images without color table.

See also

PySide.QtGui.QImage.isGrayscale()

PySide.QtGui.QImage.alphaChannel()¶

Return type:	`PySide.QtGui.QImage`

Returns the alpha channel of the image as a new grayscale PySide.QtGui.QImage in which each pixel’s red, green, and blue values are given the alpha value of the original image. The color depth of the returned image is 8-bit.

You can see an example of use of this function in PySide.QtGui.QPixmap ‘s PySide.QtGui.QPixmap.alphaChannel() , which works in the same way as this function on QPixmaps.

Most usecases for this function can be replaced with PySide.QtGui.QPainter and using composition modes.

Warning

This is an expensive function.

See also

PySide.QtGui.QImage.setAlphaChannel() PySide.QtGui.QImage.hasAlphaChannel() Pixmap Image Transformations

PySide.QtGui.QImage.bitPlaneCount()¶

Return type:	`PySide.QtCore.int`

Returns the number of bit planes in the image.

The number of bit planes is the number of bits of color and transparency information for each pixel. This is different from (i.e. smaller than) the depth when the image format contains unused bits.

See also

PySide.QtGui.QImage.depth() PySide.QtGui.QImage.format() Image Formats

PySide.QtGui.QImage.byteCount()¶

Return type:	`PySide.QtCore.int`

Returns the number of bytes occupied by the image data.

See also

PySide.QtGui.QImage.bytesPerLine() PySide.QtGui.QImage.bits() Image Information

PySide.QtGui.QImage.bytesPerLine()¶

Return type:	`PySide.QtCore.int`

Returns the number of bytes per image scanline.

This is equivalent to PySide.QtGui.QImage.byteCount() / PySide.QtGui.QImage.height() .

See also

PySide.QtGui.QImage.scanLine()

PySide.QtGui.QImage.cacheKey()¶

Return type:	`PySide.QtCore.qint64`

Returns a number that identifies the contents of this PySide.QtGui.QImage object. Distinct PySide.QtGui.QImage objects can only have the same key if they refer to the same contents.

The key will change when the image is altered.

PySide.QtGui.QImage.color(i)¶

Parameters:	i – `PySide.QtCore.int`
Return type:	long

Returns the color in the color table at index i . The first color is at index 0.

The colors in an image’s color table are specified as ARGB quadruplets ( QRgb ). Use the qAlpha() , qRed() , qGreen() , and qBlue() functions to get the color value components.

PySide.QtGui.QImage.colorTable()¶

Return type:

Returns a list of the colors contained in the image’s color table, or an empty list if the image does not have a color table

See also

PySide.QtGui.QImage.setColorTable() PySide.QtGui.QImage.colorCount() PySide.QtGui.QImage.color()

PySide.QtGui.QImage.constBits()¶

Return type:	`PySide.QtCore.uchar`

Returns a pointer to the first pixel data.

Note that PySide.QtGui.QImage uses implicit data sharing , but this function does not perform a deep copy of the shared pixel data, because the returned data is const.

See also

PySide.QtGui.QImage.bits() PySide.QtGui.QImage.constScanLine()

PySide.QtGui.QImage.constScanLine(arg__1)¶

Parameters:	arg__1 – `PySide.QtCore.int`
Return type:	PyObject

Returns a pointer to the pixel data at the scanline with index i . The first scanline is at index 0.

The scanline data is aligned on a 32-bit boundary.

Note that PySide.QtGui.QImage uses implicit data sharing , but this function does not perform a deep copy of the shared pixel data, because the returned data is const.

See also

PySide.QtGui.QImage.scanLine() PySide.QtGui.QImage.constBits()

PySide.QtGui.QImage.convertToFormat(f, colorTable[, flags=Qt.AutoColor])¶

Parameters:	f – `PySide.QtGui.QImage.Format` colorTable – flags – `PySide.QtCore.Qt.ImageConversionFlags`
Return type:	`PySide.QtGui.QImage`

PySide.QtGui.QImage.convertToFormat(f[, flags=Qt.AutoColor])

Parameters:	f – `PySide.QtGui.QImage.Format` flags – `PySide.QtCore.Qt.ImageConversionFlags`
Return type:	`PySide.QtGui.QImage`

PySide.QtGui.QImage.copy([rect=QRect()])¶

Parameters:	rect – `PySide.QtCore.QRect`
Return type:	`PySide.QtGui.QImage`

Returns a sub-area of the image as a new image.

The returned image is copied from the position (rectangle . x() , rectangle . y() ) in this image, and will always have the size of the given rectangle .

In areas beyond this image, pixels are set to 0. For 32-bit RGB images, this means black; for 32-bit ARGB images, this means transparent black; for 8-bit images, this means the color with index 0 in the color table which can be anything; for 1-bit images, this means Qt.color0 .

If the given rectangle is a null rectangle the entire image is copied.

See also

PySide.QtGui.QImage.QImage()

PySide.QtGui.QImage.copy(x, y, w, h)

Parameters:	x – `PySide.QtCore.int` y – `PySide.QtCore.int` w – `PySide.QtCore.int` h – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QImage`

This is an overloaded function.

The returned image is copied from the position (x , y ) in this image, and will always have the given width and height . In areas beyond this image, pixels are set to 0.

PySide.QtGui.QImage.createAlphaMask([flags=Qt.AutoColor])¶

Parameters:	flags – `PySide.QtCore.Qt.ImageConversionFlags`
Return type:	`PySide.QtGui.QImage`

PySide.QtGui.QImage.createHeuristicMask([clipTight=true])¶

Parameters:	clipTight – `PySide.QtCore.bool`
Return type:	`PySide.QtGui.QImage`

Creates and returns a 1-bpp heuristic mask for this image.

The function works by selecting a color from one of the corners, then chipping away pixels of that color starting at all the edges. The four corners vote for which color is to be masked away. In case of a draw (this generally means that this function is not applicable to the image), the result is arbitrary.

The returned image has little-endian bit order (i.e. the image’s format is QImage.Format_MonoLSB ), which you can convert to big-endian ( QImage.Format_Mono ) using the PySide.QtGui.QImage.convertToFormat() function.

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.

Note that this function disregards the alpha buffer.

See also

PySide.QtGui.QImage.createAlphaMask() Image Transformations

PySide.QtGui.QImage.createMaskFromColor(color[, mode=Qt.MaskInColor])¶

Parameters:	color – long mode – `PySide.QtCore.Qt.MaskMode`
Return type:	`PySide.QtGui.QImage`

PySide.QtGui.QImage.dotsPerMeterX()¶

Return type:	`PySide.QtCore.int`

Returns the number of pixels that fit horizontally in a physical meter. Together with PySide.QtGui.QImage.dotsPerMeterY() , this number defines the intended scale and aspect ratio of the image.

See also

PySide.QtGui.QImage.setDotsPerMeterX() Image Information

PySide.QtGui.QImage.dotsPerMeterY()¶

Return type:	`PySide.QtCore.int`

Returns the number of pixels that fit vertically in a physical meter. Together with PySide.QtGui.QImage.dotsPerMeterX() , this number defines the intended scale and aspect ratio of the image.

See also

PySide.QtGui.QImage.setDotsPerMeterY() Image Information

PySide.QtGui.QImage.fill(color)¶

Parameters:	color – `PySide.QtGui.QColor`

This is an overloaded function.

Fills the entire image with the given color .

If the depth of the image is 1, the image will be filled with 1 if color equals Qt.color1 ; it will otherwise be filled with 0.

If the depth of the image is 8, the image will be filled with the index corresponding the color in the color table if present; it will otherwise be filled with 0.

PySide.QtGui.QImage.fill(color)

Parameters:	color – `PySide.QtCore.Qt.GlobalColor`

PySide.QtGui.QImage.fill(pixel)

Parameters:	pixel – `PySide.QtCore.uint`

Fills the entire image with the given pixelValue .

If the depth of this image is 1, only the lowest bit is used. If you say fill(0), fill(2), etc., the image is filled with 0s. If you say fill(1), fill(3), etc., the image is filled with 1s. If the depth is 8, the lowest 8 bits are used and if the depth is 16 the lowest 16 bits are used.

Note: QImage.pixel() returns the color of the pixel at the given coordinates while QColor.pixel() returns the pixel value of the underlying window system (essentially an index value), so normally you will want to use QImage.pixel() to use a color from an existing image or QColor.rgb() to use a specific color.

See also

PySide.QtGui.QImage.depth() Image Transformations

PySide.QtGui.QImage.format()¶

Return type:	`PySide.QtGui.QImage.Format`

Returns the format of the image.

See also

Image Formats

static PySide.QtGui.QImage.fromData(data[, format=0])¶

Parameters:	data – `PySide.QtCore.QByteArray` format – str
Return type:	`PySide.QtGui.QImage`

This is an overloaded function.

Loads an image from the given PySide.QtCore.QByteArray data .

PySide.QtGui.QImage.hasAlphaChannel()¶

Return type:	`PySide.QtCore.bool`

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

See also

Image Information

PySide.QtGui.QImage.invertPixels([mode=InvertRgb])¶

Parameters:	mode – `PySide.QtGui.QImage.InvertMode`

Inverts all pixel values in the image.

The given invert mode only have a meaning when the image’s depth is 32. The default mode is InvertRgb , which leaves the alpha channel unchanged. If the mode is InvertRgba , the alpha bits are also inverted.

Inverting an 8-bit image means to replace all pixels using color index i with a pixel using color index 255 minus i . The same is the case for a 1-bit image. Note that the color table is not changed.

See also

Image Transformations

PySide.QtGui.QImage.isGrayscale()¶

Return type:	`PySide.QtCore.bool`

For 32-bit images, this function is equivalent to PySide.QtGui.QImage.allGray() .

For 8-bpp images, this function returns true if color(i) is QRgb (i, i, i) for all indexes of the color table; otherwise returns false.

See also

PySide.QtGui.QImage.allGray() Image Formats

PySide.QtGui.QImage.isNull()¶

Return type:	`PySide.QtCore.bool`

Returns true if it is a null image, otherwise returns false.

A null image has all parameters set to zero and no allocated data.

PySide.QtGui.QImage.load(fileName[, format=0])¶

Parameters:	fileName – unicode format – str
Return type:	`PySide.QtCore.bool`

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

The loader attempts to read the image using the specified format , e.g., PNG or JPG. If 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 images and other resource files in the application’s executable.

See also

Reading and Writing Image Files

PySide.QtGui.QImage.load(device, format)

Parameters:	device – `PySide.QtCore.QIODevice` format – str
Return type:	`PySide.QtCore.bool`

This is an overloaded function.

This function reads a PySide.QtGui.QImage from the given device . This can, for example, be used to load an image directly into a PySide.QtCore.QByteArray .

PySide.QtGui.QImage.loadFromData(data[, aformat=0])¶

Parameters:	data – `PySide.QtCore.QByteArray` aformat – str
Return type:	`PySide.QtCore.bool`

This is an overloaded function.

Loads an image from the given PySide.QtCore.QByteArray data .

PySide.QtGui.QImage.mirrored([horizontally=false[, vertically=true]])¶

Parameters:	horizontally – `PySide.QtCore.bool` vertically – `PySide.QtCore.bool`
Return type:	`PySide.QtGui.QImage`

Returns a mirror of the image, mirrored in the horizontal and/or the vertical direction depending on whether horizontal and vertical are set to true or false.

Note that the original image is not changed.

See also

Image Transformations

PySide.QtGui.QImage.numBytes()¶

Return type:	`PySide.QtCore.int`

Returns the number of bytes occupied by the image data.

See also

PySide.QtGui.QImage.byteCount()

PySide.QtGui.QImage.offset()¶

Return type:	`PySide.QtCore.QPoint`

Returns the number of pixels by which the image is intended to be offset by when positioning relative to other images.

See also

PySide.QtGui.QImage.setOffset() Image Information

PySide.QtGui.QImage.__ne__(arg__1)¶

Parameters:	arg__1 – `PySide.QtGui.QImage`
Return type:	`PySide.QtCore.bool`

Returns true if this image and the given image have different contents; otherwise returns false.

The comparison can be slow, unless there is some obvious difference, such as different widths, in which case the function will return quickly.

See also

PySide.QtGui.QImage.operator=()

PySide.QtGui.QImage.__eq__(arg__1)¶

Parameters:	arg__1 – `PySide.QtGui.QImage`
Return type:	`PySide.QtCore.bool`

Returns true if this image and the given image have the same contents; otherwise returns false.

The comparison can be slow, unless there is some obvious difference (e.g. different size or format), in which case the function will return quickly.

See also

PySide.QtGui.QImage.operator=()

PySide.QtGui.QImage.pixel(x, y)¶

Parameters:	x – `PySide.QtCore.int` y – `PySide.QtCore.int`
Return type:	long

This is an overloaded function.

Returns the color of the pixel at coordinates (x , y ).

PySide.QtGui.QImage.pixel(pt)

Parameters:	pt – `PySide.QtCore.QPoint`
Return type:	long

Returns the color of the pixel at the given position .

If the position is not valid, the results are undefined.

Warning

This function is expensive when used for massive pixel manipulations.

PySide.QtGui.QImage.pixelIndex(pt)¶

Parameters:	pt – `PySide.QtCore.QPoint`
Return type:	`PySide.QtCore.int`

Returns the pixel index at the given position .

If position is not valid, or if the image is not a paletted image ( PySide.QtGui.QImage.depth() > 8), the results are undefined.

See also

PySide.QtGui.QImage.valid() PySide.QtGui.QImage.depth() Pixel Manipulation

PySide.QtGui.QImage.pixelIndex(x, y)

Parameters:	x – `PySide.QtCore.int` y – `PySide.QtCore.int`
Return type:	`PySide.QtCore.int`

This is an overloaded function.

Returns the pixel index at (x , y ).

PySide.QtGui.QImage.rect()¶

Return type:	`PySide.QtCore.QRect`

Returns the enclosing rectangle (0, 0, PySide.QtGui.QImage.width() , PySide.QtGui.QImage.height() ) of the image.

See also

Image Information

PySide.QtGui.QImage.rgbSwapped()¶

Return type:	`PySide.QtGui.QImage`

Returns a PySide.QtGui.QImage in which the values of the red and blue components of all pixels have been swapped, effectively converting an RGB image to an BGR image.

The original PySide.QtGui.QImage is not changed.

See also

Image Transformations

PySide.QtGui.QImage.save(device[, format=0[, quality=-1]])¶

Parameters:	device – `PySide.QtCore.QIODevice` format – str quality – `PySide.QtCore.int`
Return type:	`PySide.QtCore.bool`

This is an overloaded function.

This function writes a PySide.QtGui.QImage to the given device .

This can, for example, be used to save an image directly into a PySide.QtCore.QByteArray :

image = QImage()
ba = QByteArray()
buffer(ba)
buffer.open(QIODevice.WriteOnly)
image.save(buffer, "PNG") # writes image into ba in PNG format

PySide.QtGui.QImage.save(fileName[, format=0[, quality=-1]])

Parameters:	fileName – unicode format – str quality – `PySide.QtCore.int`
Return type:	`PySide.QtCore.bool`

Saves the image to the file with the given fileName , using the given image file format and quality factor. If format is 0, PySide.QtGui.QImage will attempt to guess the format by looking at fileName ‘s suffix.

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

Returns true if the image was successfully saved; otherwise returns false.

See also

Reading and Writing Image Files

PySide.QtGui.QImage.scaled(w, h[, aspectMode=Qt.IgnoreAspectRatio[, mode=Qt.FastTransformation]])¶

Parameters:	w – `PySide.QtCore.int` h – `PySide.QtCore.int` aspectMode – `PySide.QtCore.Qt.AspectRatioMode` mode – `PySide.QtCore.Qt.TransformationMode`
Return type:	`PySide.QtGui.QImage`

PySide.QtGui.QImage.scaled(s[, aspectMode=Qt.IgnoreAspectRatio[, mode=Qt.FastTransformation]])

Parameters:	s – `PySide.QtCore.QSize` aspectMode – `PySide.QtCore.Qt.AspectRatioMode` mode – `PySide.QtCore.Qt.TransformationMode`
Return type:	`PySide.QtGui.QImage`

PySide.QtGui.QImage.scaledToHeight(h[, mode=Qt.FastTransformation])¶

Parameters:	h – `PySide.QtCore.int` mode – `PySide.QtCore.Qt.TransformationMode`
Return type:	`PySide.QtGui.QImage`

PySide.QtGui.QImage.scaledToWidth(w[, mode=Qt.FastTransformation])¶

Parameters:	w – `PySide.QtCore.int` mode – `PySide.QtCore.Qt.TransformationMode`
Return type:	`PySide.QtGui.QImage`

PySide.QtGui.QImage.setAlphaChannel(alphaChannel)¶

Parameters:	alphaChannel – `PySide.QtGui.QImage`

Sets the alpha channel of this image to the given alphaChannel .

If alphaChannel is an 8 bit grayscale image, the intensity values are written into this buffer directly. Otherwise, alphaChannel is converted to 32 bit and the intensity of the RGB pixel values is used.

Note that the image will be converted to the Format_ARGB32_Premultiplied format if the function succeeds.

Use one of the composition modes in QPainter.CompositionMode instead.

Warning

This function is expensive.

See also

PySide.QtGui.QImage.alphaChannel() Image Transformations Image Formats

PySide.QtGui.QImage.setColor(i, c)¶

Parameters:	i – `PySide.QtCore.int` c – long

PySide.QtGui.QImage.setColorCount(arg__1)¶

Parameters:	arg__1 – `PySide.QtCore.int`

Resizes the color table to contain colorCount entries.

If the color table is expanded, all the extra colors will be set to transparent (i.e qRgba(0, 0, 0, 0)).

When the image is used, the color table must be large enough to have entries for all the pixel/index values present in the image, otherwise the results are undefined.

See also

PySide.QtGui.QImage.colorCount() PySide.QtGui.QImage.colorTable() PySide.QtGui.QImage.setColor() Image Transformations

PySide.QtGui.QImage.setColorTable(colors)¶

Parameters:	colors –

PySide.QtGui.QImage.setDotsPerMeterX(arg__1)¶

Parameters:	arg__1 – `PySide.QtCore.int`

Sets the number of pixels that fit horizontally in a physical meter, to x .

Together with PySide.QtGui.QImage.dotsPerMeterY() , this number defines the intended scale and aspect ratio of the image, and determines the scale at which PySide.QtGui.QPainter will draw graphics on the image. It does not change the scale or aspect ratio of the image when it is rendered on other paint devices.

See also

PySide.QtGui.QImage.dotsPerMeterX() Image Information

PySide.QtGui.QImage.setDotsPerMeterY(arg__1)¶

Parameters:	arg__1 – `PySide.QtCore.int`

Sets the number of pixels that fit vertically in a physical meter, to y .

Together with PySide.QtGui.QImage.dotsPerMeterX() , this number defines the intended scale and aspect ratio of the image, and determines the scale at which PySide.QtGui.QPainter will draw graphics on the image. It does not change the scale or aspect ratio of the image when it is rendered on other paint devices.

See also

PySide.QtGui.QImage.dotsPerMeterY() Image Information

PySide.QtGui.QImage.setNumColors(arg__1)¶

Parameters:	arg__1 – `PySide.QtCore.int`

Resizes the color table to contain numColors entries.

See also

PySide.QtGui.QImage.numColors() PySide.QtGui.QImage.setColorCount()

PySide.QtGui.QImage.setOffset(arg__1)¶

Parameters:	arg__1 – `PySide.QtCore.QPoint`

Sets the number of pixels by which the image is intended to be offset by when positioning relative to other images, to offset .

See also

PySide.QtGui.QImage.offset() Image Information

PySide.QtGui.QImage.setPixel(x, y, index_or_rgb)¶

Parameters:	x – `PySide.QtCore.int` y – `PySide.QtCore.int` index_or_rgb – `PySide.QtCore.uint`

This is an overloaded function.

Sets the pixel index or color at (x , y ) to index_or_rgb .

PySide.QtGui.QImage.setPixel(pt, index_or_rgb)

Parameters:	pt – `PySide.QtCore.QPoint` index_or_rgb – `PySide.QtCore.uint`

Sets the pixel index or color at the given position to index_or_rgb .

If the image’s format is either monochrome or 8-bit, the given index_or_rgb value must be an index in the image’s color table, otherwise the parameter must be a QRgb value.

If position is not a valid coordinate pair in the image, or if index_or_rgb >= PySide.QtGui.QImage.colorCount() in the case of monochrome and 8-bit images, the result is undefined.

Warning

This function is expensive due to the call of the internal detach() function called within; if performance is a concern, we recommend the use of PySide.QtGui.QImage.scanLine() to access pixel data directly.

See also

PySide.QtGui.QImage.pixel() Pixel Manipulation

PySide.QtGui.QImage.setText(key, value)¶

Parameters:	key – unicode value – unicode

Sets the image text to the given text and associate it with the given key .

If you just want to store a single text block (i.e., a “comment” or just a description), you can either pass an empty key, or use a generic key like “Description”.

The image text is embedded into the image data when you call PySide.QtGui.QImage.save() or QImageWriter.write() .

Not all image formats support embedded text. You can find out if a specific image or format supports embedding text by using QImageWriter.supportsOption() . We give an example:

writer = QImageWriter()
writer.setFormat("png")
if writer.supportsOption(QImageIOHandler.Description):
    print "Png supports embedded text"

You can use QImageWriter.supportedImageFormats() to find out which image formats are available to you.

PySide.QtGui.QImage.size()¶

Return type:	`PySide.QtCore.QSize`

Returns the size of the image, i.e. its PySide.QtGui.QImage.width() and PySide.QtGui.QImage.height() .

See also

Image Information

PySide.QtGui.QImage.swap(other)¶

Parameters:	other – `PySide.QtGui.QImage`

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

PySide.QtGui.QImage.text([key=""])¶

Parameters:	key – unicode
Return type:	unicode

Returns the image text associated with the given key . If the specified key is an empty string, the whole image text is returned, with each key-text pair separated by a newline.

PySide.QtGui.QImage.textKeys()¶

Return type:	list of strings

Returns the text keys for this image.

You can use these keys with PySide.QtGui.QImage.text() to list the image text for a certain key.

See also

PySide.QtGui.QImage.text()

PySide.QtGui.QImage.transformed(matrix[, mode=Qt.FastTransformation])¶

Parameters:	matrix – `PySide.QtGui.QMatrix` mode – `PySide.QtCore.Qt.TransformationMode`
Return type:	`PySide.QtGui.QImage`

PySide.QtGui.QImage.transformed(matrix[, mode=Qt.FastTransformation])

Parameters:	matrix – `PySide.QtGui.QTransform` mode – `PySide.QtCore.Qt.TransformationMode`
Return type:	`PySide.QtGui.QImage`

static PySide.QtGui.QImage.trueMatrix(arg__1, w, h)¶

Parameters:	arg__1 – `PySide.QtGui.QTransform` w – `PySide.QtCore.int` h – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QTransform`

Returns the actual matrix used for transforming an image with the given width , height and matrix .

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

Unlike the other overload, this function creates transformation matrices that can be used to perform perspective transformations on images.

See also

PySide.QtGui.QImage.transformed() Image Transformations

static PySide.QtGui.QImage.trueMatrix(arg__1, w, h)

Parameters:	arg__1 – `PySide.QtGui.QMatrix` w – `PySide.QtCore.int` h – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QMatrix`

Returns the actual matrix used for transforming an image with the given width , height and matrix .

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

See also

PySide.QtGui.QImage.transformed() Image Transformations

PySide.QtGui.QImage.valid(pt)¶

Parameters:	pt – `PySide.QtCore.QPoint`
Return type:	`PySide.QtCore.bool`

Returns true if pos is a valid coordinate pair within the image; otherwise returns false.

See also

PySide.QtGui.QImage.rect() QRect.contains()

PySide.QtGui.QImage.valid(x, y)

Parameters:	x – `PySide.QtCore.int` y – `PySide.QtCore.int`
Return type:	`PySide.QtCore.bool`

This is an overloaded function.

Returns true if PySide.QtCore.QPoint (x , y ) is a valid coordinate pair within the image; otherwise returns false.

Table Of Contents

Previous topic

Next topic

QImage¶

Synopsis¶

Functions¶

Static functions¶

Detailed Description¶

Reading and Writing Image Files¶

Image Information¶

Pixel Manipulation¶

Image Formats¶

Image Transformations¶

Legal Information¶

Format	Description	Qt’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
TIFF	Tagged Image File Format	Read/write
XBM	X11 Bitmap	Read/write
XPM	X11 Pixmap	Read/write

	Available Functions
Geometry	The `PySide.QtGui.QImage.size()` , `PySide.QtGui.QImage.width()` , `PySide.QtGui.QImage.height()` , `PySide.QtGui.QImage.dotsPerMeterX()` , and `PySide.QtGui.QImage.dotsPerMeterY()` functions provide information about the image size and aspect ratio. The `PySide.QtGui.QImage.rect()` function returns the image’s enclosing rectangle. The `PySide.QtGui.QImage.valid()` function tells if a given pair of coordinates is within this rectangle. The `PySide.QtGui.QImage.offset()` function returns the number of pixels by which the image is intended to be offset by when positioned relative to other images, which also can be manipulated using the `PySide.QtGui.QImage.setOffset()` function.
Colors	The color of a pixel can be retrieved by passing its coordinates to the `PySide.QtGui.QImage.pixel()` function. The `PySide.QtGui.QImage.pixel()` function returns the color as a `QRgb` value indepedent of the image’s format. In case of monochrome and 8-bit images, the `PySide.QtGui.QImage.colorCount()` and `PySide.QtGui.QImage.colorTable()` functions provide information about the color components used to store the image data: The `PySide.QtGui.QImage.colorTable()` function returns the image’s entire color table. To obtain a single entry, use the `PySide.QtGui.QImage.pixelIndex()` function to retrieve the pixel index for a given pair of coordinates, then use the `PySide.QtGui.QImage.color()` function to retrieve the color. Note that if you create an 8-bit image manually, you have to set a valid color table on the image as well. The `PySide.QtGui.QImage.hasAlphaChannel()` function tells if the image’s format respects the alpha channel, or not. The `PySide.QtGui.QImage.allGray()` and `PySide.QtGui.QImage.isGrayscale()` functions tell whether an image’s colors are all shades of gray. See also the `Pixel Manipulation` and `Image Transformations` sections.
Text	The `PySide.QtGui.QImage.text()` function returns the image text associated with the given text key. An image’s text keys can be retrieved using the `PySide.QtGui.QImage.textKeys()` function. Use the `PySide.QtGui.QImage.setText()` function to alter an image’s text.
Low-level information	The `PySide.QtGui.QImage.depth()` function returns the depth of the image. The supported depths are 1 (monochrome), 8, 16, 24 and 32 bits. The `PySide.QtGui.QImage.bitPlaneCount()` function tells how many of those bits that are used. For more information see the `Image Formats` section. The `PySide.QtGui.QImage.format()` , `PySide.QtGui.QImage.bytesPerLine()` , and `PySide.QtGui.QImage.byteCount()` functions provide low-level information about the data stored in the image. The `PySide.QtGui.QImage.cacheKey()` function returns a number that uniquely identifies the contents of this `PySide.QtGui.QImage` object.

Function	Description
`PySide.QtGui.QImage.setDotsPerMeterX()`	Defines the aspect ratio by setting the number of pixels that fit horizontally in a physical meter.
`PySide.QtGui.QImage.setDotsPerMeterY()`	Defines the aspect ratio by setting the number of pixels that fit vertically in a physical meter.
`PySide.QtGui.QImage.fill()`	Fills the entire image with the given pixel value.
`PySide.QtGui.QImage.invertPixels()`	Inverts all pixel values in the image using the given `QImage.InvertMode` value.
`PySide.QtGui.QImage.setColorTable()`	Sets the color table used to translate color indexes. Only monochrome and 8-bit formats.
`PySide.QtGui.QImage.setColorCount()`	Resizes the color table. Only monochrome and 8-bit formats.

Table Of Contents

Previous topic

Next topic

Quick search

QImage¶

Synopsis¶

Functions¶

Static functions¶

Detailed Description¶

Reading and Writing Image Files¶

Image Information¶

Pixel Manipulation¶

Image Formats¶

Image Transformations¶

Legal Information¶