|  | Home · All Classes · Main Classes · Grouped Classes · Modules · Functions |

# QPainter Class Reference
[QtGui module]

The QPainter class performs low-level painting on widgets and other paint devices. More...

    #include <QPainter>

Inherited by Q3Painter and QStylePainter.

- List of all members, including inherited members
- Qt 3 support members

### Public Types

- enum CompositionMode { CompositionMode_SourceOver, CompositionMode_DestinationOver, CompositionMode_Clear, CompositionMode_Source, ..., CompositionMode_Xor }
- enum RenderHint { Antialiasing, TextAntialiasing, SmoothPixmapTransform }
- flags RenderHints

### Public Functions

- QPainter ()
- QPainter ( QPaintDevice * device )
- ~QPainter ()
- const QBrush & background () const
- Qt::BGMode backgroundMode () const
- bool begin ( QPaintDevice * device )
- QRectF boundingRect ( const QRectF & rectangle, int flags, const QString & text )
- QRect boundingRect ( const QRect & rectangle, int flags, const QString & text )
- QRect boundingRect ( int x, int y, int w, int h, int flags, const QString & text )
- QRectF boundingRect ( const QRectF & rectangle, const QString & text, const QTextOption & option = QTextOption() )
- const QBrush & brush () const
- QPoint brushOrigin () const
- QPainterPath clipPath () const
- QRegion clipRegion () const
- CompositionMode compositionMode () const
- QPaintDevice * device () const
- const QMatrix & deviceMatrix () const
- void drawArc ( const QRectF & rectangle, int startAngle, int spanAngle )
- void drawArc ( const QRect & rectangle, int startAngle, int spanAngle )
- void drawArc ( int x, int y, int width, int height, int startAngle, int spanAngle )
- void drawChord ( const QRectF & rectangle, int startAngle, int spanAngle )
- void drawChord ( const QRect & rectangle, int startAngle, int spanAngle )
- void drawChord ( int x, int y, int width, int height, int startAngle, int spanAngle )
- void drawConvexPolygon ( const QPointF * points, int pointCount )
- void drawConvexPolygon ( const QPoint * points, int pointCount )
- void drawConvexPolygon ( const QPolygonF & polygon )
- void drawConvexPolygon ( const QPolygon & polygon )
- void drawEllipse ( const QRectF & rectangle )
- void drawEllipse ( const QRect & rectangle )
- void drawEllipse ( int x, int y, int width, int height )
- void drawImage ( const QRectF & target, const QImage & image, const QRectF & source, Qt::ImageConversionFlags flags = Qt::AutoColor )
- void drawImage ( const QRect & target, const QImage & image, const QRect & source, Qt::ImageConversionFlags flags = Qt::AutoColor )
- void drawImage ( const QPointF & point, const QImage & image )
- void drawImage ( const QPoint & point, const QImage & image )
- void drawImage ( const QPointF & point, const QImage & image, const QRectF & source, Qt::ImageConversionFlags flags = Qt::AutoColor )
- void drawImage ( const QPoint & point, const QImage & image, const QRect & source, Qt::ImageConversionFlags flags = Qt::AutoColor )
- void drawImage ( const QRectF & rectangle, const QImage & image )
- void drawImage ( const QRect & rectangle, const QImage & image )
- void drawImage ( int x, int y, const QImage & image, int sx = 0, int sy = 0, int sw = -1, int sh = -1, Qt::ImageConversionFlags flags = Qt::AutoColor )
- void drawLine ( const QLineF & line )
- void drawLine ( const QLine & line )
- void drawLine ( const QPoint & p1, const QPoint & p2 )
- void drawLine ( const QPointF & p1, const QPointF & p2 )
- void drawLine ( int x1, int y1, int x2, int y2 )
- void drawLines ( const QLineF * lines, int lineCount )
- void drawLines ( const QLine * lines, int lineCount )
- void drawLines ( const QPointF * pointPairs, int lineCount )
- void drawLines ( const QPoint * pointPairs, int lineCount )
- void drawLines ( const QVector<QPointF> & pointPairs )
- void drawLines ( const QVector<QPoint> & pointPairs )
- void drawLines ( const QVector<QLineF> & lines )
- void drawLines ( const QVector<QLine> & lines )
- void drawPath ( const QPainterPath & path )
- void drawPicture ( const QPointF & point, const QPicture & picture )
- void drawPicture ( const QPoint & point, const QPicture & picture )
- void drawPicture ( int x, int y, const QPicture & picture )
- void drawPie ( const QRectF & rectangle, int startAngle, int spanAngle )
- void drawPie ( const QRect & rectangle, int startAngle, int spanAngle )
- void drawPie ( int x, int y, int width, int height, int startAngle, int spanAngle )
- void drawPixmap ( const QRectF & target, const QPixmap & pixmap, const QRectF & source )
- void drawPixmap ( const QRect & target, const QPixmap & pixmap, const QRect & source )
- void drawPixmap ( const QPointF & point, const QPixmap & pixmap, const QRectF & source )
- void drawPixmap ( const QPoint & point, const QPixmap & pixmap, const QRect & source )
- void drawPixmap ( const QPointF & point, const QPixmap & pixmap )
- void drawPixmap ( const QPoint & point, const QPixmap & pixmap )
- void drawPixmap ( int x, int y, const QPixmap & pixmap )
- void drawPixmap ( const QRect & rectangle, const QPixmap & pixmap )
- void drawPixmap ( int x, int y, int width, int height, const QPixmap & pixmap )
- void drawPixmap ( int x, int y, int w, int h, const QPixmap & pixmap, int sx, int sy, int sw, int sh )
- void drawPixmap ( int x, int y, const QPixmap & pixmap, int sx, int sy, int sw, int sh )
- void drawPoint ( const QPointF & position )
- void drawPoint ( const QPoint & position )
- void drawPoint ( int x, int y )
- void drawPoints ( const QPointF * points, int pointCount )
- void drawPoints ( const QPoint * points, int pointCount )
- void drawPoints ( const QPolygonF & points )
- void drawPoints ( const QPolygon & points )
- void drawPolygon ( const QPointF * points, int pointCount, Qt::FillRule fillRule = Qt::OddEvenFill )
- void drawPolygon ( const QPoint * points, int pointCount, Qt::FillRule fillRule = Qt::OddEvenFill )
- void drawPolygon ( const QPolygonF & points, Qt::FillRule fillRule = Qt::OddEvenFill )
- void drawPolygon ( const QPolygon & points, Qt::FillRule fillRule = Qt::OddEvenFill )
- void drawPolyline ( const QPointF * points, int pointCount )
- void drawPolyline ( const QPoint * points, int pointCount )
- void drawPolyline ( const QPolygonF & points )
- void drawPolyline ( const QPolygon & points )
- void drawRect ( const QRectF & rectangle )
- void drawRect ( const QRect & rectangle )
- void drawRect ( int x, int y, int width, int height )
- void drawRects ( const QRectF * rectangles, int rectCount )
- void drawRects ( const QRect * rectangles, int rectCount )
- void drawRects ( const QVector<QRectF> & rectangles )
- void drawRects ( const QVector<QRect> & rectangles )
- void drawRoundRect ( const QRectF & r, int xRnd = 25, int yRnd = 25 )
- void drawRoundRect ( const QRect & r, int xRnd = 25, int yRnd = 25 )
- void drawRoundRect ( int x, int y, int w, int h, int xRnd = 25, int yRnd = 25 )
- void drawText ( const QPointF & position, const QString & text )
- void drawText ( const QPoint & position, const QString & text )
- void drawText ( const QRectF & rectangle, int flags, const QString & text, QRectF * boundingRect = 0 )
- void drawText ( const QRect & rectangle, int flags, const QString & text, QRect * boundingRect = 0 )
- void drawText ( int x, int y, const QString & text )
- void drawText ( int x, int y, int width, int height, int flags, const QString & text, QRect * boundingRect = 0 )
- void drawText ( const QRectF & rectangle, const QString & text, const QTextOption & option = QTextOption() )
- void drawTiledPixmap ( const QRectF & rectangle, const QPixmap & pixmap, const QPointF & position = QPointF() )
- void drawTiledPixmap ( const QRect & rectangle, const QPixmap & pixmap, const QPoint & position = QPoint() )
- void drawTiledPixmap ( int x, int y, int width, int height, const QPixmap & pixmap, int sx = 0, int sy = 0 )
- bool end ()
- void eraseRect ( const QRectF & rectangle )
- void eraseRect ( const QRect & rectangle )
- void eraseRect ( int x, int y, int width, int height )
- void fillPath ( const QPainterPath & path, const QBrush & brush )
- void fillRect ( const QRectF & rectangle, const QBrush & brush )
- void fillRect ( const QRect & rectangle, const QBrush & brush )
- void fillRect ( int x, int y, int width, int height, const QBrush & brush )
- const QFont & font () const
- QFontInfo fontInfo () const
- QFontMetrics fontMetrics () const
- bool hasClipping () const
- void initFrom ( const QWidget * widget )
- bool isActive () const
- Qt::LayoutDirection layoutDirection () const
- const QMatrix & matrix () const
- bool matrixEnabled () const
- QPaintEngine * paintEngine () const
- const QPen & pen () const
- RenderHints renderHints () const
- void resetMatrix ()
- void restore ()
- void rotate ( qreal angle )
- void save ()
- void scale ( qreal sx, qreal sy )
- void setBackground ( const QBrush & brush )
- void setBackgroundMode ( Qt::BGMode mode )
- void setBrush ( const QBrush & brush )
- void setBrush ( Qt::BrushStyle style )
- void setBrushOrigin ( const QPointF & position )
- void setBrushOrigin ( const QPoint & position )
- void setBrushOrigin ( int x, int y )
- void setClipPath ( const QPainterPath & path, Qt::ClipOperation operation = Qt::ReplaceClip )
- void setClipRect ( const QRectF & rectangle, Qt::ClipOperation operation = Qt::ReplaceClip )
- void setClipRect ( int x, int y, int width, int height, Qt::ClipOperation operation = Qt::ReplaceClip )
- void setClipRect ( const QRect & rectangle, Qt::ClipOperation operation = Qt::ReplaceClip )
- void setClipRegion ( const QRegion & region, Qt::ClipOperation operation = Qt::ReplaceClip )
- void setClipping ( bool enable )
- void setCompositionMode ( CompositionMode mode )
- void setFont ( const QFont & font )
- void setLayoutDirection ( Qt::LayoutDirection direction )
- void setMatrix ( const QMatrix & matrix, bool combine = false )
- void setMatrixEnabled ( bool enable )
- void setPen ( const QPen & pen )
- void setPen ( const QColor & color )
- void setPen ( Qt::PenStyle style )
- void setRenderHint ( RenderHint hint, bool on = true )
- void setViewTransformEnabled ( bool enable )
- void setViewport ( const QRect & rectangle )
- void setViewport ( int x, int y, int width, int height )
- void setWindow ( const QRect & rectangle )
- void setWindow ( int x, int y, int width, int height )
- void shear ( qreal sh, qreal sv )
- void strokePath ( const QPainterPath & path, const QPen & pen )
- void translate ( const QPointF & offset )
- void translate ( const QPoint & offset )
- void translate ( qreal dx, qreal dy )
- bool viewTransformEnabled () const
- QRect viewport () const
- QRect window () const

### Static Public Members

- QPaintDevice * redirected ( const QPaintDevice * device, QPoint * offset = 0 )
- void restoreRedirected ( const QPaintDevice * device )
- void setRedirected ( const QPaintDevice * device, QPaintDevice * replacement, const QPoint & offset = QPoint() )

### Related Non-Members

- void qDrawPlainRect ( QPainter * painter, int x, int y, int width, int height, const QColor & lineColor, int lineWidth = 1, const QBrush * fill = 0 )
- void qDrawShadeLine ( QPainter * painter, int x1, int y1, int x2, int y2, const QPalette & palette, bool sunken = true, int lineWidth = 1, int midLineWidth = 0 )
- void qDrawShadePanel ( QPainter * painter, int x, int y, int width, int height, const QPalette & palette, bool sunken = false, int lineWidth = 1, const QBrush * fill = 0 )
- void qDrawShadeRect ( QPainter * painter, int x, int y, int width, int height, const QPalette & palette, bool sunken = false, int lineWidth = 1, int midLineWidth = 0, const QBrush * fill = 0 )
- void qDrawWinButton ( QPainter * painter, int x, int y, int width, int height, const QPalette & palette, bool sunken = false, const QBrush * fill = 0 )
- void qDrawWinPanel ( QPainter * painter, int x, int y, int width, int height, const QPalette & palette, bool sunken = false, const QBrush * fill = 0 )

## Detailed Description

The QPainter class performs low-level painting on widgets and other paint devices.

QPainter provides highly optimized functions to do most of the drawing GUI programs require. It can draw everything from simple lines to complex shapes like pies and chords. It can also draw aligned text and pixmaps. Normally, it draws in a "natural" coordinate system, but it can also do view and world transformation. QPainter can operate on any object that inherits the QPaintDevice class.

The common use of QPainter is inside a widget's paint event: Construct and customize (e.g. set the pen or the brush) the painter. Then draw. Remember to destroy the QPainter object after drawing. For example:

        void SimpleExampleWidget::paintEvent(QPaintEvent *)
        {
            QPainter painter(this);
            painter.setPen(Qt::blue);
            painter.setFont(QFont("Arial", 30));
            painter.drawText(rect(), Qt::AlignCenter, "Qt");
        }

The core functionality of QPainter is drawing, but the class also provide several functions that allows you to customize QPainter's settings and its rendering quality, and others that enable clipping. In addition you can control how different shapes are merged together by specifying the painter's composition mode.

The isActive() function indicates whether the painter is active. A painter is activated by the begin() function and the constructor that takes a QPaintDevice argument. The end() function, and the destructor, deactivates it.

Together with the QPaintDevice and QPaintEngine classes, QPainter form the basis for Qt's paint system. QPainter is the class used to perform drawing operations. QPaintDevice represents a device that can be painted on using a QPainter. QPaintEngine provides the interface that the painter uses to draw onto different types of devices. If the painter is active, device() returns the paint device on which the painter paints, and paintEngine() returns the paint engine that the painter is currently operating on. For more information, see The Paint System documentation.

Sometimes it is desirable to make someone else paint on an unusual QPaintDevice. QPainter supports a static function to do this, setRedirected().

Warning: Unless a widget has the Qt::WA_PaintOutsidePaintEvent attribute set. A QPainter can only be used on a widget inside a paintEvent() or a function called by a paintEvent(). On Mac OS X, you can only paint on a widget in a paintEvent() regardless of this attribute's setting.

- Settings
- Drawing
- Rendering Quality
- Coordinate Transformations
- Clipping
- Composition Modes

### Settings

There are several settings that you can customize to make QPainter draw according to your preferences:

- font() is the font used for drawing text. If the painter isActive(), you can retrieve information about the currently set font, and its metrics, using the fontInfo() and fontMetrics() functions respectively.
- brush() defines the color or pattern that is used for filling shapes.
- pen() defines the color or stipple that is used for drawing lines or boundaries.
- backgroundMode() defines whether there is a background() or not, i.e it is either Qt::Opaque or Qt::TransparentMode.
- background() only applies when backgroundMode() is Qt::Opaque and pen() is a stipple. In that case, it describes the color of the background pixels in the stipple.
- brushOrigin() defines the origin of the tiled brushes, normally the origin of widget's background.
- viewport(), window(), matrix() make up the painter's coordinate transformation system. For more information, see the Coordinate Transformations section and the The Coordinate System documentation.
- hasClipping() tells whether the painter clips at all. (The paint device clips, too.) If the painter clips, it clips to clipRegion().
- layoutDirection() defines the layout direction used by the painter when drawing text.
- matrixEnabled() tells whether world transformation is enabled.
- viewTransformEnabled() tells whether view transformation is enabled.

Note that some of these settings mirror settings in some paint devices, e.g. QWidget::font(). The QPainter::begin() function (or equivalently the QPainter constructor) copies these attributes from the paint device.

You can at any time save the QPainter's state by calling the save() function which saves all the available settings on an internal stack. The restore() function pops them back.

### Drawing

QPainter provides functions to draw most primitives: drawPoint(), drawPoints(), drawLine(), drawRect(), drawRoundRect(), drawEllipse(), drawArc(), drawPie(), drawChord(), drawPolyline(), drawPolygon(), drawConvexPolygon() and drawCubicBezier(). The two convenience functions, drawRects() and drawLines(), draw the given number of rectangles or lines in the given array of QRects or QLines using the current pen and brush.

The QPainter class also provides the fillRect() function which fills the given QRect, with the given QBrush, and the eraseRect() function that erases the area inside the given rectangle.

All of these functions have both integer and floating point versions.

| Basic Drawing Example The Basic Drawing example shows how to display basic graphics primitives in a variety of styles using the QPainter class.

If you need to draw a complex shape, especially if you need to do so repeatedly, consider creating a QPainterPath and drawing it using drawPath().

Painter Paths example The QPainterPath class provides a container for painting operations, enabling graphical shapes to be constructed and reused. The Painter Paths example shows how painter paths can be used to build complex shapes for rendering. |

QPainter also provides the fillPath() function which fills the given QPainterPath with the given QBrush, and the strokePath() function that draws the outline of the given path (i.e. strokes the path).

See also the Vector Deformation demo which shows how to use advanced vector techniques to draw text using a QPainterPath, the Gradients demo which shows the different types of gradients that are available in Qt, and the Path Stroking demo which shows Qt's built-in dash patterns and shows how custom patterns can be used to extend the range of available patterns.

Vector Deformation | Gradients | Path Stroking
--- | --- | ---

There are functions to draw pixmaps/images, namely drawPixmap(), drawImage() and drawTiledPixmap(). Both drawPixmap() and drawImage() produce the same result, except that drawPixmap() is faster on-screen while drawImage() may be faster on a QPrinter or other devices.

Text drawing is done using drawText(). When you need fine-grained positioning, boundingRect() tells you where a given drawText() command will draw.

There is a drawPicture() function that draws the contents of an entire QPicture. The drawPicture() function is the only function that disregards all the painter's settings as QPicture has its own settings.

### Rendering Quality

To get the optimal rendering result using QPainter, you should use the platform independent QImage as paint device; i.e. using QImage will ensure that the result has an identical pixel representation on any platform.

The QPainter class also provides a means of controlling the rendering quality through its RenderHint enum and the support for floating point precision: All the functions for drawing primitives has a floating point version. These are often used in combination with the QPainter::AntiAliasing render hint.

| Concentric Circles Example The Concentric Circles example shows the improved rendering quality that can be obtained using floating point precision and anti-aliasing when drawing custom widgets. The application's main window displays several widgets which are drawn using the various combinations of precision and anti-aliasing.

The RenderHint enum specifies flags to QPainter that may or may not be respected by any given engine. QPainter::AntiAliasing indicates that the engine should antialias edges of primitives if possible, QPainter::TextAntialiasing indicates that the engine should antialias text if possible, and finally the QPainter::SmoothPixmapTransform indicates that the engine should use a smooth pixmap transformation algorithm.

The renderHints() function returns a flag that specifies the rendering hints that are set for this painter. Use the setRenderHint() function to set or clear the currently set RenderHints.

### Coordinate Transformations

Normally, the QPainter operates on the device's own coordinate system (usually pixels), but QPainter has good support for coordinate transformations.

nop | rotate() | scale() | translate()
--- | --- | --- | ---

The most commonly used transformations are scaling, rotation, translation and shearing. Use the scale() function to scale the coordinate system by a given offset, the rotate() function to rotate it clockwise and translate() to translate it (i.e. adding a given offset to the points). You can also twist the coordinate system around the origin using the shear() function. See the Affine Transformations demo for a visualization of a sheared coordinate system.

See also the Transformations example which shows how transformations influence the way that QPainter renders graphics primitives. In particular it shows how the order of transformations affects the result.

Affine Transformations Demo The Affine Transformations demo show Qt's ability to perform affine transformations on painting operations. The demo also allows the user to experiment with the transformation operations and see the results immediately. |

All the tranformation operations operate on the transformation matrix(). A matrix transforms a point in the plane to another point. For more information about the transformation matrix, see the The Coordinate System and QMatrix documentation.

The setMatrix() function can replace or add to the currently set matrix(). The resetMatrix() function resets any transformations that were made using translate(), scale(), shear(), rotate(), setMatrix(), setViewport() and setWindow() functions. The deviceMatrix() returns the matrix that transforms from logical coordinates to device coordinates of the platform dependent paint device. The latter function is only needed when using platform painting commands on the platform dependent handle, and the platform does not do transformations nativly.

When drawing with QPainter, we specify points using logical coordinates which then are converted into the physical coordinates of the paint device. The mapping of the logical coordinates to the physical coordinates are handled by QPainter's viewport() and window() and world matrix(). The viewport() represents the physical coordinates specifying an arbitrary rectangle, the window() describes the same rectangle in logical coordinates, and the world matrix() is identical with the transformation matrix.

See also The Coordinate System documentation.

### Clipping

QPainter can clip any drawing operation to a rectangle, a region, or a vector path. The current clip is available using the functions clipRegion() and clipPath(). Whether paths or regions are preferred (faster) depends on the underlying paintEngine(). For example, the QImage paint engine prefers paths while the X11 paint engine prefers regions. Setting a clip is done in the painters logical coordinates.

After QPainter's clipping, the paint device may also clip. For example, most widgets clip away the pixels used by child widgets, and most printers clip away an area near the edges of the paper. This additional clipping is not reflected by the return value of clipRegion() or hasClipping().

### Composition Modes

QPainter provides the CompositionMode enum which defines the Porter-Duff rules for digital image compositing; it describes a model for combining the pixels in one image, the source, with the pixel in another image, the destination.

The two most common forms of composition are Source and SourceOver. Source is used to draw opaque objects onto a paint device. In this mode, each pixel in the source replaces the corresponding pixel in the destination. In SourceOver composition mode, the source object is transparent and is drawn on top of the destination.

Note that composition transformation operates pixelwise. For that reason, there is a difference between using the grahic primitive itself and its bounding rectangle: The bounding rect contains pixels with alpha == 0 (i.e the pixels surrounding the primitive). These pixels will overwrite the other image's pixels, affectively clearing those, while the primitive only overwrites its own area.

| Composition Modes Demo The Composition Modes demo, available in Qt's demo directory, allows you to experiment with the various composition modes and see the results immediately.

See also QPaintDevice, QPaintEngine, and QtSvg Module.

## Member Type Documentation

### enum QPainter::CompositionMode

Defines the Porter-Duff rules for digital image compositing. Composition modes are used to specify how the pixels in one image, the source, are merged with the pixel in another image, the destination.

The most common type is SourceOver (often referred to as just alpha blending) where the source pixel is blended on top of the destination pixel in such a way that the alpha component of the source defines the translucency of the pixel.

Composition modes will only work when the paint device is a QImage in Format_ARGB32_Premultiplied or Format_ARGB32, where the premultiplied version is the preferred format.

When a composition mode is set it applies to all painting operator, pens, brushes, gradients and pixmap/image drawing.

Constant | Value | Description
--- | --- | ---
`QPainter::CompositionMode_SourceOver` | `0` | This is the default mode. The alpha of the source is used to blend the pixel on top of the destination.
`QPainter::CompositionMode_DestinationOver` | `1` | The alpha of the destination is used to blend it on top of the source pixels. This mode is the inverse of CompositionMode_SourceOver.
`QPainter::CompositionMode_Clear` | `2` | The pixels in the destination are cleared (set to fully transparent) independent of the source.
`QPainter::CompositionMode_Source` | `3` | The output is the source pixel. (This means a basic copy operation and is identical to SourceOver when the source pixel is opaque).
`QPainter::CompositionMode_Destination` | `4` | The output is the destination pixel. This means that the blending has no effect. This mode is the inverse of CompositionMode_Source.
`QPainter::CompositionMode_SourceIn` | `5` | The output is the source, where the alpha is reduced by that of the destination.
`QPainter::CompositionMode_DestinationIn` | `6` | The output is the destination, where the alpha is reduced by that of the source. This mode is the inverse of CompositionMode_SourceIn.
`QPainter::CompositionMode_SourceOut` | `7` | The output is the source, where the alpha is reduced by the inverse of destination.
`QPainter::CompositionMode_DestinationOut` | `8` | The output is the destination, where the alpha is reduced by the inverse of the source. This mode is the inverse of CompositionMode_SourceOut.
`QPainter::CompositionMode_SourceAtop` | `9` | The source pixel is blended on top of the destination, with the alpha of the source pixel reduced by the alpha of the destination pixel.
`QPainter::CompositionMode_DestinationAtop` | `10` | The destination pixel is blended on top of the source, with the alpha of the destination pixel is reduced by the alpha of the destination pixel. This mode is the inverse of CompositionMode_SourceAtop.
`QPainter::CompositionMode_Xor` | `11` | The source, which alpha is reduced with the inverse of the destination alpha, is merged with the destination, which alpha is reduced by the inverse of the source alpha. CompositionMode_Xor is not the same as the bitwise Xor.

See also compositionMode(), setCompositionMode(), and Composition Modes.

### enum QPainter::RenderHint
flags QPainter::RenderHints

Renderhints are used to specify flags to QPainter that may or may not be respected by any given engine.

Constant | Value | Description
--- | --- | ---
`QPainter::Antialiasing` | `0x01` | Indicates that the engine should antialias edges of primitives if possible.
`QPainter::TextAntialiasing` | `0x02` | Indicates that the engine should antialias text if possible.
`QPainter::SmoothPixmapTransform` | `0x04` | Indicates that the engine should use a smooth pixmap transformation algorithm (such as bilinear) rather than nearest neighbor.

The RenderHints type is a typedef for QFlags<RenderHint>. It stores an OR combination of RenderHint values.

See also renderHints(), setRenderHint(), and Rendering Quality.

## Member Function Documentation

### QPainter::QPainter ()

Constructs a painter.

See also begin() and end().

### QPainter::QPainter ( QPaintDevice * device )

Constructs a painter that begins painting the paint device immediately.

This constructor is convenient for short-lived painters, e.g. in a QWidget::paintEvent() and should be used only once. The constructor calls begin() for you and the QPainter destructor automatically calls end().

Here's an example using begin() and end():

        void MyWidget::paintEvent(QPaintEvent *)
        {
            QPainter p;
            p.begin(this);
            p.drawLine(...);        // drawing code
            p.end();
        }

The same example using this constructor:

        void MyWidget::paintEvent(QPaintEvent *)
        {
            QPainter p(this);
            p.drawLine(...);        // drawing code
        }

Since the constructor cannot provide feedback when the initialization of the painter failed you should rather use begin() and end() to paint on external devices, e.g. printers.

See also begin() and end().

### QPainter::~QPainter ()

Destroys the painter.

### const QBrush & QPainter::background () const

Returns the current background brush.

See also setBackground() and Settings.

### Qt::BGMode QPainter::backgroundMode () const

Returns the current background mode.

See also setBackgroundMode() and Settings.

### bool QPainter::begin ( QPaintDevice * device )

Begins painting the paint device and returns true if successful; otherwise returns false.

Notice that all painter settings (setPen(), setBrush() etc.) are reset to default values when begin() is called.

The errors that can occur are serious problems, such as these:

        painter->begin(0); // impossible - paint device cannot be 0

        QPixmap image(0, 0);
        painter->begin(&image); // impossible - image.isNull() == true;

        painter->begin(myWidget);
        painter2->begin(myWidget); // impossible - only one painter at a time

Note that most of the time, you can use one of the constructors instead of begin(), and that end() is automatically done at destruction.

Warning: A paint device can only be painted by one painter at a time.

See also end() and QPainter().

### QRectF QPainter::boundingRect ( const QRectF & rectangle, int flags, const QString & text )

Returns the bounding rectangle of the text as it will appear when drawn inside the given rectangle with the specified flags using the currently set font(); i.e the function tells you where the drawText() function will draw when given the same arguments.

If the text does not fit within the given rectangle using the specified flags, the function returns the required rectangle.

The flags argument is a bitwise OR of the following flags:

- Qt::AlignLeft
- Qt::AlignRight
- Qt::AlignHCenter
- Qt::AlignTop
- Qt::AlignBottom
- Qt::AlignVCenter
- Qt::AlignCenter
- Qt::TextSingleLine
- Qt::TextExpandTabs
- Qt::TextShowMnemonic
- Qt::TextWordWrap

If several of the horizontal or several of the vertical alignment flags are set, the resulting alignment is undefined.

See also drawText(), Qt::Alignment, and Qt::TextFlag.

### QRect QPainter::boundingRect ( const QRect & rectangle, int flags, const QString & text )

This is an overloaded member function, provided for convenience.

Returns the bounding rectangle of the text as it will appear when drawn inside the given rectangle with the specified flags using the currently set font().

### QRect QPainter::boundingRect ( int x, int y, int w, int h, int flags, const QString & text )

This is an overloaded member function, provided for convenience.

Returns the bounding rectangle of the given text as it will appear when drawn inside the rectangle beginning at the point (x, y) with width w and height h.

### QRectF QPainter::boundingRect ( const QRectF & rectangle, const QString & text, const QTextOption & option = QTextOption() )

This is an overloaded member function, provided for convenience.

Instead of specifying flags as a bitwise OR of the Qt::AlignmentFlag and Qt::TextFlag, this overloaded function takes an option argument. The QTextOption class provides a description of general rich text properties.

See also QTextOption.

### const QBrush & QPainter::brush () const

Returns the painter's current brush.

See also QPainter::setBrush() and Settings.

### QPoint QPainter::brushOrigin () const

Returns the currently set brush origin.

See also setBrushOrigin() and Settings.

### QPainterPath QPainter::clipPath () const

Returns the currently clip as a path. Note that the clip path is given in logical coordinates.

See also setClipPath(), clipRegion(), and setClipping().

### QRegion QPainter::clipRegion () const

Returns the currently set clip region. Note that the clip region is given in logical coordinates.

See also setClipRegion(), clipPath(), and setClipping().

### CompositionMode QPainter::compositionMode () const

Returns the current composition mode.

See also CompositionMode and setCompositionMode().

### QPaintDevice * QPainter::device () const

Returns the paint device on which this painter is currently painting, or 0 if the painter is not active.

See also isActive().

### const QMatrix & QPainter::deviceMatrix () const

Returns the matrix that transforms from logical coordinates to device coordinates of the platform dependent paint device.

This function is only needed when using platform painting commands on the platform dependent handle ( Qt::HANDLE), and the platform does not do transformations nativly.

The QPaintEngine::PaintEngineFeature enum can be queried to determine whether the platform performs the transformations or not.

See also matrix() and QPaintEngine::hasFeature().

### void QPainter::drawArc ( const QRectF & rectangle, int startAngle, int spanAngle )

Draws the arc defined by the given rectangle, startAngle and spanAngle.

The startAngle and spanAngle must be specified in 1/16th of a degree, i.e. a full circle equals 5760 (16 * 360). Positive values for the angles mean counter-clockwise while negative values mean the clockwise direction. Zero degrees is at the 3 o'clock position.

        QRectF rectangle(10.0, 20.0, 80.0, 60.0);
        int startAngle = 30 * 16;
        int spanAngle = 120 * 16;

        QPainter painter(this);
        painter.drawArc(rectangle, startAngle, spanAngle);

See also drawPie(), drawChord(), and The Coordinate System.

### void QPainter::drawArc ( const QRect & rectangle, int startAngle, int spanAngle )

This is an overloaded member function, provided for convenience.

Draws the arc defined by the given rectangle, startAngle and spanAngle.

### void QPainter::drawArc ( int x, int y, int width, int height, int startAngle, int spanAngle )

This is an overloaded member function, provided for convenience.

Draws the arc defined by the rectangle beginning at (x, y) with the specified width and height, and the given startAngle and spanAngle.

### void QPainter::drawChord ( const QRectF & rectangle, int startAngle, int spanAngle )

Draws the chord defined by the given rectangle, startAngle and spanAngle. The chord is filled with the current brush().

The startAngle and spanAngle must be specified in 1/16th of a degree, i.e. a full circle equals 5760 (16 * 360). Positive values for the angles mean counter-clockwise while negative values mean the clockwise direction. Zero degrees is at the 3 o'clock position.

        QRectF rectangle(10.0, 20.0, 80.0, 60.0);
        int startAngle = 30 * 16;
        int spanAngle = 120 * 16;

        QPainter painter(this);
        painter.drawChord(rect, startAngle, spanAngle);

See also drawArc(), drawPie(), and The Coordinate System.

### void QPainter::drawChord ( const QRect & rectangle, int startAngle, int spanAngle )

This is an overloaded member function, provided for convenience.

Draws the chord defined by the given rectangle, startAngle and spanAngle.

### void QPainter::drawChord ( int x, int y, int width, int height, int startAngle, int spanAngle )

This is an overloaded member function, provided for convenience.

Draws the chord defined by the rectangle beginning at (x, y) with the specified width and height, and the given startAngle and spanAngle.

### void QPainter::drawConvexPolygon ( const QPointF * points, int pointCount )

Draws the convex polygon defined by the first pointCount points in the array points using the current pen.

        static const QPointF points[4] = {
            QPointF(10.0, 80.0),
            QPointF(20.0, 10.0),
            QPointF(80.0, 30.0),
            QPointF(90.0, 70.0)
        };

        QPainter painter(this);
        painter.drawConvexPolygon(points, 4);

The first point is implicitly connected to the last point, and the polygon is filled with the current brush(). If the supplied polygon is not convex, i.e. it contains at least one angle larger than 180 degrees, the results are undefined.

On some platforms (e.g. X11), the drawConvexPolygon() function can be faster than the drawPolygon() function.

See also drawPolygon(), drawPolyline(), and The Coordinate System.

### void QPainter::drawConvexPolygon ( const QPoint * points, int pointCount )

This is an overloaded member function, provided for convenience.

Draws the convex polygon defined by the first pointCount points in the array points using the current pen.

### void QPainter::drawConvexPolygon ( const QPolygonF & polygon )

This is an overloaded member function, provided for convenience.

Draws the convex polygon defined by polygon using the current pen and brush.

### void QPainter::drawConvexPolygon ( const QPolygon & polygon )

This is an overloaded member function, provided for convenience.

Draws the convex polygon defined by polygon using the current pen and brush.

### void QPainter::drawEllipse ( const QRectF & rectangle )

Draws the ellipse defined by the given rectangle.

A filled ellipse has a size of rectangle.size(). A stroked ellipse has a size of rectangle.size() plus the pen width.

        QRectF rectangle(10.0, 20.0, 80.0, 60.0);

        QPainter painter(this);
        painter.drawEllipse(rectangle);

See also drawPie() and The Coordinate System.

### void QPainter::drawEllipse ( const QRect & rectangle )

This is an overloaded member function, provided for convenience.

Draws the ellipse defined by the given rectangle.

### void QPainter::drawEllipse ( int x, int y, int width, int height )

This is an overloaded member function, provided for convenience.

Draws the ellipse defined by the rectangle beginning at (x, y) with the given width and height.

### void QPainter::drawImage ( const QRectF & target, const QImage & image, const QRectF & source, Qt::ImageConversionFlags flags = Qt::AutoColor )

Draws the rectangular portion source of the given image into the target rectangle in the paint device.

If the image needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the flags to specify how you would prefer this to happen.

        QRectF target(10.0, 20.0, 80.0, 60.0);
        QRectF source(0.0, 0.0, 70.0, 40.0);
        QImage image(":/images/myImage.png");

        QPainter(this);
        painter.drawImage(target, image, source);

See also drawPixmap().

### void QPainter::drawImage ( const QRect & target, const QImage & image, const QRect & source, Qt::ImageConversionFlags flags = Qt::AutoColor )

This is an overloaded member function, provided for convenience.

Draws the rectangular portion source of the given image into the target rectangle in the paint device.

### void QPainter::drawImage ( const QPointF & point, const QImage & image )

This is an overloaded member function, provided for convenience.

Draws the given image at the given point.

### void QPainter::drawImage ( const QPoint & point, const QImage & image )

This is an overloaded member function, provided for convenience.

Draws the given image at the given point.

### void QPainter::drawImage ( const QPointF & point, const QImage & image, const QRectF & source, Qt::ImageConversionFlags flags = Qt::AutoColor )

This is an overloaded member function, provided for convenience.

Draws the rectangular portion source of the given image with its origin at the given point.

### void QPainter::drawImage ( const QPoint & point, const QImage & image, const QRect & source, Qt::ImageConversionFlags flags = Qt::AutoColor )

This is an overloaded member function, provided for convenience.

Draws the rectangular portion source of the given image with its origin at the given point.

### void QPainter::drawImage ( const QRectF & rectangle, const QImage & image )

This is an overloaded member function, provided for convenience.

Draws the given image into the given rectangle.

### void QPainter::drawImage ( const QRect & rectangle, const QImage & image )

This is an overloaded member function, provided for convenience.

Draws the given image into the given rectangle.

### void QPainter::drawImage ( int x, int y, const QImage & image, int sx = 0, int sy = 0, int sw = -1, int sh = -1, Qt::ImageConversionFlags flags = Qt::AutoColor )

This is an overloaded member function, provided for convenience.

Draws an image at (x, y) by copying a part of image into the paint device.

(x, y) specifies the top-left point in the paint device that is to be drawn onto. (sx, sy) specifies the top-left point in image that is to be drawn. The default is (0, 0).

(sw, sh) specifies the size of the image that is to be drawn. The default, (-1, -1), means all the way to the bottom-right of the image.

### void QPainter::drawLine ( const QLineF & line )

Draws a line defined by line.

        QLineF line(10.0, 80.0, 90.0, 20.0);

        QPainter(this);
        painter.drawLine(line);

See also drawLines(), drawPolyline(), and The Coordinate System.

### void QPainter::drawLine ( const QLine & line )

This is an overloaded member function, provided for convenience.

Draws a line defined by line.

### void QPainter::drawLine ( const QPoint & p1, const QPoint & p2 )

This is an overloaded member function, provided for convenience.

Draws a line from p1 to p2.

### void QPainter::drawLine ( const QPointF & p1, const QPointF & p2 )

This is an overloaded member function, provided for convenience.

Draws a line from p1 to p2.

### void QPainter::drawLine ( int x1, int y1, int x2, int y2 )

This is an overloaded member function, provided for convenience.

Draws a line from (x1, y1) to (x2, y2) and sets the current pen position to (x2, y2).

### void QPainter::drawLines ( const QLineF * lines, int lineCount )

Draws the first lineCount lines in the array lines using the current pen.

See also drawLine() and drawPolyline().

### void QPainter::drawLines ( const QLine * lines, int lineCount )

This is an overloaded member function, provided for convenience.

Draws the first lineCount lines in the array lines using the current pen.

### void QPainter::drawLines ( const QPointF * pointPairs, int lineCount )

This is an overloaded member function, provided for convenience.

Draws the first lineCount lines in the array pointPairs using the current pen. The lines are specified as pairs of points so the number of entries in pointPairs must be at least lineCount * 2.

### void QPainter::drawLines ( const QPoint * pointPairs, int lineCount )

This is an overloaded member function, provided for convenience.

Draws the first lineCount lines in the array pointPairs using the current pen.

### void QPainter::drawLines ( const QVector<QPointF> & pointPairs )

This is an overloaded member function, provided for convenience.

Draws a line for each pair of points in the vector pointPairs using the current pen. If there is an odd number of points in the array, the last point will be ignored.

### void QPainter::drawLines ( const QVector<QPoint> & pointPairs )

This is an overloaded member function, provided for convenience.

Draws a line for each pair of points in the vector pointPairs using the current pen.

### void QPainter::drawLines ( const QVector<QLineF> & lines )

This is an overloaded member function, provided for convenience.

Draws the set of lines defined by the list lines using the current pen and brush.

### void QPainter::drawLines ( const QVector<QLine> & lines )

This is an overloaded member function, provided for convenience.

Draws the set of lines defined by the list lines using the current pen and brush.

### void QPainter::drawPath ( const QPainterPath & path )

Draws the given painter path using the current pen for outline and the current brush for filling.

        QPainterPath path;
        path.moveTo(20, 80);
        path.lineTo(20, 30);
        path.cubicTo(80, 0, 50, 50, 80, 80);

        QPainter painter(this);
        painter.drawPath(path);

See also the Painter Paths example and the Vector Deformation demo.

### void QPainter::drawPicture ( const QPointF & point, const QPicture & picture )

Replays the given picture at the given point.

The QPicture class is a paint device that records and replays QPainter commands. A picture serializes the painter commands to an IO device in a platform-independent format. Everything that can be painted on a widget or pixmap can also be stored in a picture.

This function does exactly the same as QPicture::play() when called with point = QPoint(0, 0).

        QPicture picture;
        QPointF point(10.0, 20.0)
        picture.load("drawing.pic");

        QPainter painter(this);
        painter.drawPicture(0, 0, picture);

See also QPicture::play().

### void QPainter::drawPicture ( const QPoint & point, const QPicture & picture )

This is an overloaded member function, provided for convenience.

Replays the given picture at the given point.

### void QPainter::drawPicture ( int x, int y, const QPicture & picture )

This is an overloaded member function, provided for convenience.

Draws the given picture at point (x, y).

### void QPainter::drawPie ( const QRectF & rectangle, int startAngle, int spanAngle )

Draws a pie defined by the given rectangle, startAngle and and spanAngle.

The pie is filled with the current brush().

The startAngle and spanAngle must be specified in 1/16th of a degree, i.e. a full circle equals 5760 (16 * 360). Positive values for the angles mean counter-clockwise while negative values mean the clockwise direction. Zero degrees is at the 3 o'clock position.

        QRectF rectangle(10.0, 20.0, 80.0, 60.0);
        int startAngle = 30 * 16;
        int spanAngle = 120 * 16;

        QPainter painter(this);
        painter.drawPie(rectangle, startAngle, spanAngle);

See also drawEllipse(), drawChord(), and The Coordinate System.

### void QPainter::drawPie ( const QRect & rectangle, int startAngle, int spanAngle )

This is an overloaded member function, provided for convenience.

Draws a pie defined by the given rectangle, startAngle and and spanAngle.

### void QPainter::drawPie ( int x, int y, int width, int height, int startAngle, int spanAngle )

This is an overloaded member function, provided for convenience.

Draws the pie defined by the rectangle beginning at (x, y) with the specified width and height, and the given startAngle and spanAngle.

### void QPainter::drawPixmap ( const QRectF & target, const QPixmap & pixmap, const QRectF & source )

Draws the rectangular portion source of the given pixmap into the given target in the paint device.

        QRectF target(10.0, 20.0, 80.0, 60.0);
        QRectF source(0.0, 0.0, 70.0, 40.0);
        QPixmap pixmap(":myPixmap.png");

        QPainter(this);
        painter.drawPixmap(target, image, source);

See also drawImage().

### void QPainter::drawPixmap ( const QRect & target, const QPixmap & pixmap, const QRect & source )

This is an overloaded member function, provided for convenience.

Draws the rectangular portion source of the given pixmap into the given target in the paint device.

### void QPainter::drawPixmap ( const QPointF & point, const QPixmap & pixmap, const QRectF & source )

This is an overloaded member function, provided for convenience.

Draws the rectangular portion source of the given pixmap with its origin at the given point.

### void QPainter::drawPixmap ( const QPoint & point, const QPixmap & pixmap, const QRect & source )

This is an overloaded member function, provided for convenience.

Draws the rectangular portion source of the given pixmap with its origin at the given point.

### void QPainter::drawPixmap ( const QPointF & point, const QPixmap & pixmap )

This is an overloaded member function, provided for convenience.

Draws the given pixmap with its origin at the given point.

### void QPainter::drawPixmap ( const QPoint & point, const QPixmap & pixmap )

This is an overloaded member function, provided for convenience.

Draws the given pixmap with its origin at the given point.

### void QPainter::drawPixmap ( int x, int y, const QPixmap & pixmap )

This is an overloaded member function, provided for convenience.

Draws the given pixmap at position (x, y).

### void QPainter::drawPixmap ( const QRect & rectangle, const QPixmap & pixmap )

This is an overloaded member function, provided for convenience.

Draws the given pixmap into the given rectangle.

### void QPainter::drawPixmap ( int x, int y, int width, int height, const QPixmap & pixmap )

This is an overloaded member function, provided for convenience.

Draws the pixmap into the rectangle at position (x, y) with the given width and height.

### void QPainter::drawPixmap ( int x, int y, int w, int h, const QPixmap & pixmap, int sx, int sy, int sw, int sh )

This is an overloaded member function, provided for convenience.

Draws the rectangular portion with the origin (sx, sy), width sw and height sh, of the given pixmap , at the point (x, y), with a width of w and a height of h.

### void QPainter::drawPixmap ( int x, int y, const QPixmap & pixmap, int sx, int sy, int sw, int sh )

This is an overloaded member function, provided for convenience.

Draws a pixmap at (x, y) by copying a part of the given pixmap into the paint device.

(x, y) specifies the top-left point in the paint device that is to be drawn onto. (sx, sy) specifies the top-left point in pixmap that is to be drawn. The default is (0, 0).

(sw, sh) specifies the size of the pixmap that is to be drawn. The default, (-1, -1), means all the way to the bottom-right of the pixmap.

### void QPainter::drawPoint ( const QPointF & position )

Draws a single point at the given position using the current pen's color.

See also The Coordinate System.

### void QPainter::drawPoint ( const QPoint & position )

This is an overloaded member function, provided for convenience.

Draws a single point at the given position using the current pen's color.

### void QPainter::drawPoint ( int x, int y )

This is an overloaded member function, provided for convenience.

Draws a single point at position (x, y).

### void QPainter::drawPoints ( const QPointF * points, int pointCount )

Draws the first pointCount points in the array points using the current pen's color.

See also The Coordinate System.

### void QPainter::drawPoints ( const QPoint * points, int pointCount )

This is an overloaded member function, provided for convenience.

Draws the first pointCount points in the array points using the current pen's color.

### void QPainter::drawPoints ( const QPolygonF & points )

This is an overloaded member function, provided for convenience.

Draws the points in the vector points.

### void QPainter::drawPoints ( const QPolygon & points )

This is an overloaded member function, provided for convenience.

Draws the points in the vector points.

### void QPainter::drawPolygon ( const QPointF * points, int pointCount, Qt::FillRule fillRule = Qt::OddEvenFill )

Draws the polygon defined by the first pointCount points in the array points using the current pen and brush.

        static const QPointF points[4] = {
            QPointF(10.0, 80.0),
            QPointF(20.0, 10.0),
            QPointF(80.0, 30.0),
            QPointF(90.0, 70.0)
        };

        QPainter painter(this);
        painter.drawPolygon(points, 4);

The first point is implicitly connected to the last point, and the polygon is filled with the current brush().

If fillRule is Qt::WindingFill, the polygon is filled using the winding fill algorithm. If fillRule is Qt::OddEvenFill, the polygon is filled using the odd-even fill algorithm. See Qt::FillRule for a more detailed description of these fill rules.

See also drawConvexPolygon(), drawPolyline(), and The Coordinate System.

### void QPainter::drawPolygon ( const QPoint * points, int pointCount, Qt::FillRule fillRule = Qt::OddEvenFill )

This is an overloaded member function, provided for convenience.

Draws the polygon defined by the first pointCount points in the array points.

### void QPainter::drawPolygon ( const QPolygonF & points, Qt::FillRule fillRule = Qt::OddEvenFill )

This is an overloaded member function, provided for convenience.

Draws the polygon defined by the given points using the fill rule fillRule.

### void QPainter::drawPolygon ( const QPolygon & points, Qt::FillRule fillRule = Qt::OddEvenFill )

This is an overloaded member function, provided for convenience.

Draws the polygon defined by the given points using the fill rule fillRule.

### void QPainter::drawPolyline ( const QPointF * points, int pointCount )

Draws the polyline defined by the first pointCount points in points using the current pen.

Note that unlike the drawPolygon() function the last point is not connected to the first, neither is the polyline filled.

        static const QPointF points[3] = {
            QPointF(10.0, 80.0),
            QPointF(20.0, 10.0),
            QPointF(80.0, 30.0),
        };

        QPainter painter(this);
        painter.drawPolyline(points, 3);

See also drawLines(), drawPolygon(), and The Coordinate System.

### void QPainter::drawPolyline ( const QPoint * points, int pointCount )

This is an overloaded member function, provided for convenience.

Draws the polyline defined by the first pointCount points in points using the current pen.

### void QPainter::drawPolyline ( const QPolygonF & points )

This is an overloaded member function, provided for convenience.

Draws the polyline defined by the given points using the current pen.

### void QPainter::drawPolyline ( const QPolygon & points )

This is an overloaded member function, provided for convenience.

Draws the polyline defined by the given points using the current pen.

### void QPainter::drawRect ( const QRectF & rectangle )

Draws the current rectangle with the current pen and brush.

A filled rectangle has a size of rectangle.size(). A stroked rectangle has a size of rectangle.size() plus the pen width.

        QRectF rectangle(10.0, 20.0, 80.0, 60.0);

        QPainter painter(this);
        painter.drawRect(rectangle);

See also drawRects(), drawPolygon(), and The Coordinate System.

### void QPainter::drawRect ( const QRect & rectangle )

This is an overloaded member function, provided for convenience.

Draws the current rectangle with the current pen and brush.

### void QPainter::drawRect ( int x, int y, int width, int height )

This is an overloaded member function, provided for convenience.

Draws a rectangle with upper left corner at (x, y) and with the given width and height.

### void QPainter::drawRects ( const QRectF * rectangles, int rectCount )

Draws the first rectCount of the given rectangles using the current pen and brush.

See also drawRect().

### void QPainter::drawRects ( const QRect * rectangles, int rectCount )

This is an overloaded member function, provided for convenience.

Draws the first rectCount of the given rectangles using the current pen and brush.

### void QPainter::drawRects ( const QVector<QRectF> & rectangles )

This is an overloaded member function, provided for convenience.

Draws the given rectangles using the current pen and brush.

### void QPainter::drawRects ( const QVector<QRect> & rectangles )

This is an overloaded member function, provided for convenience.

Draws the given rectangles using the current pen and brush.

### void QPainter::drawRoundRect ( const QRectF & r, int xRnd = 25, int yRnd = 25 )

Draws a rectangle r with rounded corners.

The xRnd and yRnd arguments specify how rounded the corners should be. 0 is angled corners, 99 is maximum roundedness.

A filled rectangle has a size of r.size(). A stroked rectangle has a size of r.size() plus the pen width.

        QRectF rectangle(10.0, 20.0, 80.0, 60.0);

        QPainter painter(this);
        painter.drawRoundRect(rectangle);

See also drawRect() and QPen.

### void QPainter::drawRoundRect ( const QRect & r, int xRnd = 25, int yRnd = 25 )

This is an overloaded member function, provided for convenience.

Draws the rectangle r with rounded corners.

### void QPainter::drawRoundRect ( int x, int y, int w, int h, int xRnd = 25, int yRnd = 25 )

This is an overloaded member function, provided for convenience.

Draws the rectangle x, y, w, h with rounded corners.

### void QPainter::drawText ( const QPointF & position, const QString & text )

Draws the given text with the currently defined text direction, beginning at the given position.

This function does not break text into multiple lines. Use the QPainter::drawText() overload that takes a rectangle instead if you want line breaking.

### void QPainter::drawText ( const QPoint & position, const QString & text )

This is an overloaded member function, provided for convenience.

Draws the given text with the currently defined text direction, beginning at the given position.

### void QPainter::drawText ( const QRectF & rectangle, int flags, const QString & text, QRectF * boundingRect = 0 )

This is an overloaded member function, provided for convenience.

Draws the given text within the provided rectangle.

        QPainter painter(this);
        painter.drawText(rect, Qt::AlignCenter, tr("Qt by\nTrolltech"));

The boundingRect (if not null) is set to the actual bounding rectangle of the output. The flags argument is a bitwise OR of the following flags:

- Qt::AlignLeft
- Qt::AlignRight
- Qt::AlignHCenter
- Qt::AlignTop
- Qt::AlignBottom
- Qt::AlignVCenter
- Qt::AlignCenter
- Qt::TextSingleLine
- Qt::TextExpandTabs
- Qt::TextShowMnemonic
- Qt::TextWordWrap

See also Qt::AlignmentFlag, Qt::TextFlag, boundingRect(), and layoutDirection().

### void QPainter::drawText ( const QRect & rectangle, int flags, const QString & text, QRect * boundingRect = 0 )

This is an overloaded member function, provided for convenience.

Draws the given text within the provided rectangle according to the specified flags. The boundingRect (if not null) is set to the actual bounding rectangle of the output.

### void QPainter::drawText ( int x, int y, const QString & text )

This is an overloaded member function, provided for convenience.

Draws the given text at position (x, y), using the painter's currently defined text direction.

### void QPainter::drawText ( int x, int y, int width, int height, int flags, const QString & text, QRect * boundingRect = 0 )

This is an overloaded member function, provided for convenience.

Draws the given text within the rectangle with origin (x, y), width and height.

The boundingRect (if not null) is set to the actual bounding rectangle of the output. The flags argument is a bitwise OR of the following flags:

- Qt::AlignLeft
- Qt::AlignRight
- Qt::AlignHCenter
- Qt::AlignTop
- Qt::AlignBottom
- Qt::AlignVCenter
- Qt::AlignCenter
- Qt::TextSingleLine
- Qt::TextExpandTabs
- Qt::TextShowMnemonic
- Qt::TextWordWrap

See also Qt::AlignmentFlag and Qt::TextFlag.

### void QPainter::drawText ( const QRectF & rectangle, const QString & text, const QTextOption & option = QTextOption() )

This is an overloaded member function, provided for convenience.

Draws the given text in the rectangle specified using the option to control its positioning and orientation.

### void QPainter::drawTiledPixmap ( const QRectF & rectangle, const QPixmap & pixmap, const QPointF & position = QPointF() )

Draws a tiled pixmap, inside the given rectangle with its origin at the given position.

Calling drawTiledPixmap() is similar to calling drawPixmap() several times to fill (tile) an area with a pixmap, but is potentially much more efficient depending on the underlying window system.

See also drawPixmap().

### void QPainter::drawTiledPixmap ( const QRect & rectangle, const QPixmap & pixmap, const QPoint & position = QPoint() )

This is an overloaded member function, provided for convenience.

Draws a tiled pixmap, inside the given rectangle with its origin at the given position.

### void QPainter::drawTiledPixmap ( int x, int y, int width, int height, const QPixmap & pixmap, int sx = 0, int sy = 0 )

This is an overloaded member function, provided for convenience.

Draws a tiled pixmap in the specified rectangle.

(x, y) specifies the top-left point in the paint device that is to be drawn onto; with the given width and height. (sx, sy) specifies the top-left point in the pixmap that is to be drawn; this defaults to (0, 0).

### bool QPainter::end ()

Ends painting. Any resources used while painting are released. You don't normally need to call this since it is called by the destructor.

See also begin() and isActive().

### void QPainter::eraseRect ( const QRectF & rectangle )

Erases the area inside the given rectangle. Equivalent to calling

        fillRect(rectangle, background()).

See also fillRect().

### void QPainter::eraseRect ( const QRect & rectangle )

This is an overloaded member function, provided for convenience.

Erases the area inside the given rectangle.

### void QPainter::eraseRect ( int x, int y, int width, int height )

This is an overloaded member function, provided for convenience.

Erases the area inside the rectangle beginning at (x, y) with the given width and height.

### void QPainter::fillPath ( const QPainterPath & path, const QBrush & brush )

Fills the given path using the given brush. The outline is not drawn.

Alternatively, you can specify a QColor instead of a QBrush; the QBrush constructor (taking a QColor argument) will automatically create a solid pattern brush.

See also drawPath().

### void QPainter::fillRect ( const QRectF & rectangle, const QBrush & brush )

Fills the given rectangle with the given brush.

Alternatively, you can specify a QColor instead of a QBrush; the QBrush constructor (taking a QColor argument) will automatically create a solid pattern brush.

See also drawRect().

### void QPainter::fillRect ( const QRect & rectangle, const QBrush & brush )

This is an overloaded member function, provided for convenience.

Fills the given rectangle with the given brush.

### void QPainter::fillRect ( int x, int y, int width, int height, const QBrush & brush )

This is an overloaded member function, provided for convenience.

Fills the rectangle beginning at (x, y) with the given width and height, using the given brush.

### const QFont & QPainter::font () const

Returns the currently set font used for drawing text.

See also setFont(), drawText(), and Settings.

### QFontInfo QPainter::fontInfo () const

Returns the font info for the painter if the painter is active. Otherwise, the return value is undefined.

See also font(), isActive(), and Settings.

### QFontMetrics QPainter::fontMetrics () const

Returns the font metrics for the painter if the painter is active. Otherwise, the return value is undefined.

See also font(), isActive(), and Settings.

### bool QPainter::hasClipping () const

Returns true if clipping has been set; otherwise returns false.

See also setClipping() and Clipping.

### void QPainter::initFrom ( const QWidget * widget )

Initializes the painters pen, background and font to the same as the given widget. Call this function after begin() while the painter is active.

See also begin() and Settings.

### bool QPainter::isActive () const

Returns true if begin() has been called and end() has not yet been called; otherwise returns false.

See also begin() and QPaintDevice::paintingActive().

### Qt::LayoutDirection QPainter::layoutDirection () const

Returns the layout direction used by the painter when drawing text.

See also setLayoutDirection(), drawText(), and Settings.

### const QMatrix & QPainter::matrix () const

Returns the world transformation matrix.

See also setMatrix(), Coordinate Transformations, and The Coordinate System.

### bool QPainter::matrixEnabled () const

Returns true if world transformation is enabled; otherwise returns false.

See also setMatrixEnabled(), matrix(), and The Coordinate System.

### QPaintEngine * QPainter::paintEngine () const

Returns the paint engine that the painter is currently operating on if the painter is active; otherwise 0.

See also isActive().

### const QPen & QPainter::pen () const

Returns the painter's current pen.

See also setPen() and Settings.

### QPaintDevice * QPainter::redirected ( const QPaintDevice * device, QPoint * offset = 0 ) `[static]`

Returns the replacement for given device. The optional out parameter offset returns the offset within the replaced device.

See also setRedirected() and restoreRedirected().

### RenderHints QPainter::renderHints () const

Returns a flag that specifies the rendering hints that are set for this painter.

See also RenderHint and Rendering Quality.

### void QPainter::resetMatrix ()

Resets any transformations that were made using translate(), scale(), shear(), rotate(), setMatrix(), setViewport() and setWindow().

See also Coordinate Transformations.

### void QPainter::restore ()

Restores the current painter state (pops a saved state off the stack).

See also save().

### void QPainter::restoreRedirected ( const QPaintDevice * device ) `[static]`

Restores the previous redirection for the given device after a call to setRedirected().

See also redirected().

### void QPainter::rotate ( qreal angle )

Rotates the coordinate system the given angle clockwise.

See also setMatrix() and Coordinate Transformations.

### void QPainter::save ()

Saves the current painter state (pushes the state onto a stack). A save() must be followed by a corresponding restore(); the end() function unwinds the stack.

See also restore().

### void QPainter::scale ( qreal sx, qreal sy )

Scales the coordinate system by (sx, sy).

See also setMatrix() and Coordinate Transformations.

### void QPainter::setBackground ( const QBrush & brush )

Sets the background brush of the painter to the given brush.

The background brush is the brush that is filled in when drawing opaque text, stippled lines and bitmaps. The background brush has no effect in transparent background mode (which is the default).

See also background(), setBackgroundMode(), and Settings.

### void QPainter::setBackgroundMode ( Qt::BGMode mode )

Sets the background mode of the painter to the given mode

Qt::TransparentMode (the default) draws stippled lines and text without setting the background pixels. Qt::OpaqueMode fills these space with the current background color.

Note that in order to draw a bitmap or pixmap transparently, you must use QPixmap::setMask().

See also backgroundMode(), setBackground(), and Settings.

### void QPainter::setBrush ( const QBrush & brush )

Sets the painter's brush to the given brush.

The painter's brush defines how shapes are filled.

See also brush() and Settings.

### void QPainter::setBrush ( Qt::BrushStyle style )

This is an overloaded member function, provided for convenience.

Sets the painter's brush to black color and the specified style.

### void QPainter::setBrushOrigin ( const QPointF & position )

Sets the brush origin to position.

The brush origin specifies the (0, 0) coordinate of the painter's brush. This setting only applies to pattern brushes and pixmap brushes.

Note that while the brushOrigin() was necessary to adopt the parent's background for a widget in Qt 3, this is no longer the case since the Qt 4 painter doesn't paint the background unless you explicitly tell it to do so by setting the widget's autoFillBackground property to true.

See also brushOrigin() and Settings.

### void QPainter::setBrushOrigin ( const QPoint & position )

This is an overloaded member function, provided for convenience.

Sets the brush's origin to the given position.

### void QPainter::setBrushOrigin ( int x, int y )

This is an overloaded member function, provided for convenience.

Sets the brush's origin to point (x, y).

### void QPainter::setClipPath ( const QPainterPath & path, Qt::ClipOperation operation = Qt::ReplaceClip )

Enables clipping, and sets the clip path for the painter to the given path, with the clip operation.

Note that the clip path is specified in logical (painter) coordinates.

See also clipPath(), clipRegion(), and Clipping.

### void QPainter::setClipRect ( const QRectF & rectangle, Qt::ClipOperation operation = Qt::ReplaceClip )

Enables clipping, and sets the clip region to the given rectangle using the given clip operation. The default operation is to replace the current clip rectangle.

Note that the clip rectangle is specified in logical (painter) coordinates.

See also clipRegion(), setClipping(), and Clipping.

### void QPainter::setClipRect ( int x, int y, int width, int height, Qt::ClipOperation operation = Qt::ReplaceClip )

This is an overloaded member function, provided for convenience.

Enables clipping, and sets the clip region to the rectangle beginning at (x, y) with the given width and height.

### void QPainter::setClipRect ( const QRect & rectangle, Qt::ClipOperation operation = Qt::ReplaceClip )

This is an overloaded member function, provided for convenience.

Enables clipping, and sets the clip region to the given rectangle using the given clip operation.

### void QPainter::setClipRegion ( const QRegion & region, Qt::ClipOperation operation = Qt::ReplaceClip )

Sets the clip region to the givne region using the given clip operation. The default clip operation is to replace the current clip region.

Note that the clip region is given in logical coordinates.

See also clipRegion(), setClipRect(), and Clipping.

### void QPainter::setClipping ( bool enable )

Enables clipping if enable is true, or disables clipping if enable is false.

See also hasClipping() and Clipping.

### void QPainter::setCompositionMode ( CompositionMode mode )

Sets the composition mode to the given mode.

Warning: You can only set the composition mode for QPainter objects that operates on a QImage.

See also compositionMode().

### void QPainter::setFont ( const QFont & font )

Sets the painter's font to the given font.

This font is used by subsequent drawText() functions. The text color is the same as the pen color.

If you set a font that isn't available, Qt finds a close match. font() will return what you set using setFont() and fontInfo() returns the font actually being used (which may be the same).

See also font(), drawText(), and Settings.

### void QPainter::setLayoutDirection ( Qt::LayoutDirection direction )

Sets the layout direction used by the painter when drawing text, to the specified direction.

See also layoutDirection(), drawText(), and Settings.

### void QPainter::setMatrix ( const QMatrix & matrix, bool combine = false )

Sets the transformation matrix to matrix and enables transformations.

If combine is true, then matrix is combined with the current transformation matrix; otherwise matrix replaces the current transformation matrix.

If matrix is the identity matrix and combine is false, this function calls setMatrixEnabled(false). (The identity matrix is the matrix where QMatrix::m11() and QMatrix::m22() are 1.0 and the rest are 0.0.)

The following functions can transform the coordinate system without using a QMatrix:

- translate()
- scale()
- shear()
- rotate()

They operate on the painter's matrix() and are implemented like this:

        void QPainter::rotate(qreal angle)
        {
            QMatrix matrix;
            matrix.rotate(angle);
            setMatrix(matrix, true);
        }

Note that when using setMatrix() function you should always have combine be true when you are drawing into a QPicture. Otherwise it may not be possible to replay the picture with additional transformations; using the translate(), scale(), etc. convenience functions is safe.

For more information about the coordinate system, transformations and window-viewport conversion, see The Coordinate System documentation.

See also matrix(), matrixEnabled(), and QMatrix.

### void QPainter::setMatrixEnabled ( bool enable )

Enables transformations if enable is true, or disables transformations if enable is false. The world transformation matrix is not changed.

See also matrixEnabled(), matrix(), and Coordinate Transformations.

### void QPainter::setPen ( const QPen & pen )

Sets the painter's pen to be the given pen.

The pen defines how to draw lines and outlines, and it also defines the text color.

See also pen() and Settings.

### void QPainter::setPen ( const QColor & color )

This is an overloaded member function, provided for convenience.

Sets the painter's pen to have style Qt::SolidLine, width 0 and the specified color.

### void QPainter::setPen ( Qt::PenStyle style )

This is an overloaded member function, provided for convenience.

Sets the painter's pen to have the given style, width 0 and black color.

### void QPainter::setRedirected ( const QPaintDevice * device, QPaintDevice * replacement, const QPoint & offset = QPoint() ) `[static]`

Redirects all paint commands for the given paint device, to the replacement device. The optional point offset defines an offset within the source device.

The redirection will not be effective until the begin() function has been called; make sure to call end() for the given device's painter (if any) before redirecting. Call restoreRedirected() to restore the previous redirection.

In general, you'll probably find that calling QPixmap::grabWidget() or QPixmap::grabWindow() is an easier solution.

See also redirected() and restoreRedirected().

### void QPainter::setRenderHint ( RenderHint hint, bool on = true )

Sets the given render hint on the painter if on is true; otherwise clears the render hint.

See also renderHints() and Rendering Quality.

### void QPainter::setViewTransformEnabled ( bool enable )

Enables view transformations if enable is true, or disables view transformations if enable is false.

See also viewTransformEnabled() and Window-Viewport Conversion.

### void QPainter::setViewport ( const QRect & rectangle )

Sets the painter's viewport rectangle to the given rectangle, and enables view transformations.

The viewport rectangle is part of the view transformation. The viewport specifies the device coordinate system. Its sister, the window(), specifies the logical coordinate system.

The default viewport rectangle is the same as the device's rectangle.

See also viewport(), viewTransformEnabled(), and Window-Viewport Conversion.

### void QPainter::setViewport ( int x, int y, int width, int height )

This is an overloaded member function, provided for convenience.

Sets the painter's viewport rectangle to be the rectangle beginning at (x, y) with the given width and height.

### void QPainter::setWindow ( const QRect & rectangle )

Sets the painter's window to the given rectangle, and enables view transformations.

The window rectangle is part of the view transformation. The window specifies the logical coordinate system. Its sister, the viewport(), specifies the device coordinate system.

The default window rectangle is the same as the device's rectangle.

See also window(), viewTransformEnabled(), and Window-Viewport Conversion.

### void QPainter::setWindow ( int x, int y, int width, int height )

This is an overloaded member function, provided for convenience.

Sets the painter's window to the rectangle beginning at (x, y) and the given width and height.

### void QPainter::shear ( qreal sh, qreal sv )

Shears the coordinate system by (sh, sv).

See also setMatrix() and Coordinate Transformations.

### void QPainter::strokePath ( const QPainterPath & path, const QPen & pen )

Draws the outline (strokes) the path path with the pen specified by pen

See also fillPath() and Drawing.

### void QPainter::translate ( const QPointF & offset )

Translates the coordinate system by the given offset; i.e. the given offset is added to points.

See also setMatrix() and Coordinate Transformations.

### void QPainter::translate ( const QPoint & offset )

This is an overloaded member function, provided for convenience.

Translates the coordinate system by the given offset.

### void QPainter::translate ( qreal dx, qreal dy )

This is an overloaded member function, provided for convenience.

Translates the coordinate system by the vector (dx, dy).

### bool QPainter::viewTransformEnabled () const

Returns true if view transformation is enabled; otherwise returns false.

See also setViewTransformEnabled() and matrix().

### QRect QPainter::viewport () const

Returns the viewport rectangle.

See also setViewport() and setViewTransformEnabled().

### QRect QPainter::window () const

Returns the window rectangle.

See also setWindow() and setViewTransformEnabled().

## Related Non-Members

### void qDrawPlainRect ( QPainter * painter, int x, int y, int width, int height, const QColor & lineColor, int lineWidth = 1, const QBrush * fill = 0 )

Draws the plain rectangle beginning at (x, y) with the given width and height, using the provided painter, lineColor and lineWidth . The rectangle's interior is filled with the fill brush unless fill is 0.

Warning: This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style.

Alternatively you can use a QFrame widget and apply the QFrame::setFrameStyle() function to display a plain rectangle:

        QFrame frame:
        frame.setFrameStyle(QFrame::Box | QFrame::Plain);

See also qDrawShadeRect() and QStyle.

### void qDrawShadeLine ( QPainter * painter, int x1, int y1, int x2, int y2, const QPalette & palette, bool sunken = true, int lineWidth = 1, int midLineWidth = 0 )

Draws a horizontal (y1 == y2) or vertical (x1 == x2) shaded line using the given painter. Note that nothing is drawn if y1 != y2 and x1 != x2 (i.e. the line is neither horizontal nor vertical).

The provided palette specifies the shading colors (light, dark and middle colors). The given lineWidth specifies the line width for each of the lines; it is not the total line width. The given midLineWidth specifies the width of a middle line drawn in the QPalette::mid() color.

The line appears sunken if sunken is true, otherwise raised.

Warning: This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style.

Alternatively you can use a QFrame widget and apply the QFrame::setFrameStyle() function to display a shaded line:

        QFrame frame:
        frame.setFrameStyle(QFrame::HLine | QFrame::Sunken);

See also qDrawShadeRect(), qDrawShadePanel(), and QStyle.

### void qDrawShadePanel ( QPainter * painter, int x, int y, int width, int height, const QPalette & palette, bool sunken = false, int lineWidth = 1, const QBrush * fill = 0 )

Draws the shaded panel beginning at (x, y) with the given width and height using the provided painter and the given lineWidth.

The given palette specifies the shading colors (light, dark and middle colors). The panel's interior is filled with the fill brush unless fill is 0.

The panel appears sunken if sunken is true, otherwise raised.

Warning: This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style.

Alternatively you can use a QFrame widget and apply the QFrame::setFrameStyle() function to display a shaded panel:

        QFrame frame:
        frame.setFrameStyle( QFrame::Panel | QFrame::Sunken);

See also qDrawWinPanel(), qDrawShadeLine(), qDrawShadeRect(), and QStyle.

### void qDrawShadeRect ( QPainter * painter, int x, int y, int width, int height, const QPalette & palette, bool sunken = false, int lineWidth = 1, int midLineWidth = 0, const QBrush * fill = 0 )

Draws the shaded rectangle beginning at (x, y) with the given width and height using the provided painter.

The provide palette specifies the shading colors (light, dark and middle colors. The given lineWidth specifies the line width for each of the lines; it is not the total line width. The midLineWidth specifies the width of a middle line drawn in the QPalette::mid() color. The rectangle's interior is filled with the fill brush unless fill is 0.

The rectangle appears sunken if sunken is true, otherwise raised.

Warning: This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style.

Alternatively you can use a QFrame widget and apply the QFrame::setFrameStyle() function to display a shaded rectangle:

        QFrame frame:
        frame.setFrameStyle(QFrame::Box | QFrame::Raised);

See also qDrawShadeLine(), qDrawShadePanel(), qDrawPlainRect(), and QStyle.

### void qDrawWinButton ( QPainter * painter, int x, int y, int width, int height, const QPalette & palette, bool sunken = false, const QBrush * fill = 0 )

Draws the Windows-style button specified by the given point (x, y}, width and height using the provided painter with a line width of 2 pixels. The button's interior is filled with the fill brush unless fill is 0.

The given palette specifies the shading colors (light, dark and middle colors).

The button appears sunken if sunken is true, otherwise raised.

Warning: This function does not look at QWidget::style() or QApplication::style()-> Use the drawing functions in QStyle to make widgets that follow the current GUI style.

See also qDrawWinPanel() and QStyle.

### void qDrawWinPanel ( QPainter * painter, int x, int y, int width, int height, const QPalette & palette, bool sunken = false, const QBrush * fill = 0 )

Draws the Windows-style panel specified by the given point(x, y), width and height using the provided painter with a line width of 2 pixels. The button's interior is filled with the fill brush unless fill is 0.

The given palette specifies the shading colors. The panel appears sunken if sunken is true, otherwise raised.

Warning: This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style.

Alternatively you can use a QFrame widget and apply the QFrame::setFrameStyle() function to display a shaded panel:

        QFrame frame:
        frame.setFrameStyle(QFrame::WinPanel | QFrame::Raised);

See also qDrawShadePanel(), qDrawWinButton(), and QStyle.