1 /****************************************************************************
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtGui module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
50 #include "qpaintdevice.h"
51 #include "qpaintengine.h"
53 #include "qpainter_p.h"
54 #include "qpainterpath.h"
56 #include "qpixmapcache.h"
58 #include "qtextlayout.h"
60 #include "qvarlengtharray.h"
61 #include "qstatictext.h"
62 #include "qglyphrun.h"
64 #include <private/qfontengine_p.h>
65 #include <private/qpaintengine_p.h>
66 #include <private/qemulationpaintengine_p.h>
67 #include <private/qpainterpath_p.h>
68 #include <private/qtextengine_p.h>
69 #include <private/qpaintengine_raster_p.h>
70 #include <private/qmath_p.h>
71 #include <private/qstatictext_p.h>
72 #include <private/qglyphrun_p.h>
73 #include <private/qhexstring_p.h>
74 #include <private/qguiapplication_p.h>
75 #include <private/qrawfont_p.h>
79 #define QGradient_StretchToDevice 0x10000000
80 #define QPaintEngine_OpaqueBackground 0x40000000
82 // #define QT_DEBUG_DRAW
84 bool qt_show_painter_debug_output = true;
87 extern QPixmap qt_pixmapForBrush(int style, bool invert);
89 void qt_format_text(const QFont &font,
90 const QRectF &_r, int tf, const QTextOption *option, const QString& str, QRectF *brect,
91 int tabstops, int* tabarray, int tabarraylen,
93 static void drawTextItemDecoration(QPainter *painter, const QPointF &pos, const QFontEngine *fe,
94 QTextCharFormat::UnderlineStyle underlineStyle,
95 QTextItem::RenderFlags flags, qreal width,
96 const QTextCharFormat &charFormat);
97 // Helper function to calculate left most position, width and flags for decoration drawing
98 Q_GUI_EXPORT void qt_draw_decoration_for_glyphs(QPainter *painter, const glyph_t *glyphArray,
99 const QFixedPoint *positions, int glyphCount,
100 QFontEngine *fontEngine, const QFont &font,
101 const QTextCharFormat &charFormat);
103 static inline QGradient::CoordinateMode coordinateMode(const QBrush &brush)
105 switch (brush.style()) {
106 case Qt::LinearGradientPattern:
107 case Qt::RadialGradientPattern:
108 case Qt::ConicalGradientPattern:
109 return brush.gradient()->coordinateMode();
113 return QGradient::LogicalMode;
116 /* Returns true if the gradient requires stretch to device...*/
117 static inline bool check_gradient(const QBrush &brush)
119 return coordinateMode(brush) == QGradient::StretchToDeviceMode;
122 extern bool qHasPixmapTexture(const QBrush &);
124 static inline bool is_brush_transparent(const QBrush &brush) {
125 Qt::BrushStyle s = brush.style();
126 bool brushBitmap = qHasPixmapTexture(brush)
127 ? brush.texture().isQBitmap()
128 : (brush.textureImage().depth() == 1);
129 return ((s >= Qt::Dense1Pattern && s <= Qt::DiagCrossPattern)
130 || (s == Qt::TexturePattern && brushBitmap));
133 static inline bool is_pen_transparent(const QPen &pen) {
134 return pen.style() > Qt::SolidLine || is_brush_transparent(pen.brush());
137 /* Discards the emulation flags that are not relevant for line drawing
138 and returns the result
140 static inline uint line_emulation(uint emulation)
142 return emulation & (QPaintEngine::PrimitiveTransform
143 | QPaintEngine::AlphaBlend
144 | QPaintEngine::Antialiasing
145 | QPaintEngine::BrushStroke
146 | QPaintEngine::ConstantOpacity
147 | QGradient_StretchToDevice
148 | QPaintEngine::ObjectBoundingModeGradients
149 | QPaintEngine_OpaqueBackground);
153 static bool qt_painter_thread_test(int devType, const char *what, bool extraCondition = false)
156 case QInternal::Image:
157 case QInternal::Printer:
158 case QInternal::Picture:
159 // can be drawn onto these devices safely from any thread
166 if (QApplication::testAttribute(Qt::AA_X11InitThreads))
169 if (!extraCondition && QThread::currentThread() != qApp->thread()) {
170 qWarning("QPainter: It is not safe to use %s outside the GUI thread", what);
179 void QPainterPrivate::checkEmulation()
182 if (extended->flags() & QPaintEngineEx::DoNotEmulate)
185 bool doEmulation = false;
186 if (state->bgMode == Qt::OpaqueMode)
189 const QGradient *bg = state->brush.gradient();
190 if (bg && bg->coordinateMode() > QGradient::LogicalMode)
193 const QGradient *pg = qpen_brush(state->pen).gradient();
194 if (pg && pg->coordinateMode() > QGradient::LogicalMode)
198 if (extended != emulationEngine) {
199 if (!emulationEngine)
200 emulationEngine = new QEmulationPaintEngine(extended);
201 extended = emulationEngine;
202 extended->setState(state);
204 } else if (emulationEngine == extended) {
205 extended = emulationEngine->real_engine;
210 QPainterPrivate::~QPainterPrivate()
212 delete emulationEngine;
213 for (int i=0; i<states.size(); ++i)
221 QTransform QPainterPrivate::viewTransform() const
224 qreal scaleW = qreal(state->vw)/qreal(state->ww);
225 qreal scaleH = qreal(state->vh)/qreal(state->wh);
226 return QTransform(scaleW, 0, 0, scaleH,
227 state->vx - state->wx*scaleW, state->vy - state->wy*scaleH);
235 Returns true if using a shared painter; otherwise false.
237 bool QPainterPrivate::attachPainterPrivate(QPainter *q, QPaintDevice *pdev)
242 QPainter *sp = pdev->sharedPainter();
246 // Save the current state of the shared painter and assign
247 // the current d_ptr to the shared painter's d_ptr.
249 if (!sp->d_ptr->d_ptrs) {
250 // Allocate space for 4 d-pointers (enough for up to 4 sub-sequent
251 // redirections within the same paintEvent(), which should be enough
252 // in 99% of all cases). E.g: A renders B which renders C which renders D.
253 sp->d_ptr->d_ptrs_size = 4;
254 sp->d_ptr->d_ptrs = (QPainterPrivate **)malloc(4 * sizeof(QPainterPrivate *));
255 Q_CHECK_PTR(sp->d_ptr->d_ptrs);
256 } else if (sp->d_ptr->refcount - 1 == sp->d_ptr->d_ptrs_size) {
257 // However, to support corner cases we grow the array dynamically if needed.
258 sp->d_ptr->d_ptrs_size <<= 1;
259 const int newSize = sp->d_ptr->d_ptrs_size * sizeof(QPainterPrivate *);
260 sp->d_ptr->d_ptrs = q_check_ptr((QPainterPrivate **)realloc(sp->d_ptr->d_ptrs, newSize));
262 sp->d_ptr->d_ptrs[++sp->d_ptr->refcount - 2] = q->d_ptr.data();
264 q->d_ptr.reset(sp->d_ptr.data());
266 Q_ASSERT(q->d_ptr->state);
268 // Now initialize the painter with correct widget properties.
271 pdev->redirected(&offset);
272 offset += q->d_ptr->engine->coordinateOffset();
274 // Update system rect.
275 q->d_ptr->state->ww = q->d_ptr->state->vw = pdev->width();
276 q->d_ptr->state->wh = q->d_ptr->state->vh = pdev->height();
279 if (q->d_ptr->state->WxF) {
280 q->d_ptr->state->redirectionMatrix = q->d_ptr->state->matrix;
281 q->d_ptr->state->redirectionMatrix.translate(-offset.x(), -offset.y());
282 q->d_ptr->state->worldMatrix = QTransform();
283 q->d_ptr->state->WxF = false;
285 q->d_ptr->state->redirectionMatrix = QTransform::fromTranslate(-offset.x(), -offset.y());
287 q->d_ptr->updateMatrix();
289 QPaintEnginePrivate *enginePrivate = q->d_ptr->engine->d_func();
290 if (enginePrivate->currentClipDevice == pdev) {
291 enginePrivate->systemStateChanged();
295 // Update system transform and clip.
296 enginePrivate->currentClipDevice = pdev;
297 enginePrivate->setSystemTransform(q->d_ptr->state->matrix);
301 void QPainterPrivate::detachPainterPrivate(QPainter *q)
303 Q_ASSERT(refcount > 1);
306 QPainterPrivate *original = d_ptrs[--refcount - 1];
308 inDestructor = false;
310 original->inDestructor = true;
311 } else if (!original) {
312 original = new QPainterPrivate(q);
315 d_ptrs[refcount - 1] = 0;
318 q->d_ptr.reset(original);
320 if (emulationEngine) {
321 extended = emulationEngine->real_engine;
322 delete emulationEngine;
328 void QPainterPrivate::draw_helper(const QPainterPath &originalPath, DrawOperation op)
331 if (qt_show_painter_debug_output) {
332 printf("QPainter::drawHelper\n");
336 if (originalPath.isEmpty())
339 QPaintEngine::PaintEngineFeatures gradientStretch =
340 QPaintEngine::PaintEngineFeatures(QGradient_StretchToDevice
341 | QPaintEngine::ObjectBoundingModeGradients);
343 const bool mustEmulateObjectBoundingModeGradients = extended
344 || ((state->emulationSpecifier & QPaintEngine::ObjectBoundingModeGradients)
345 && !engine->hasFeature(QPaintEngine::PatternTransform));
347 if (!(state->emulationSpecifier & ~gradientStretch)
348 && !mustEmulateObjectBoundingModeGradients) {
349 drawStretchedGradient(originalPath, op);
351 } else if (state->emulationSpecifier & QPaintEngine_OpaqueBackground) {
352 drawOpaqueBackground(originalPath, op);
358 qreal strokeOffsetX = 0, strokeOffsetY = 0;
360 QPainterPath path = originalPath * state->matrix;
361 QRectF pathBounds = path.boundingRect();
363 bool doStroke = (op & StrokeDraw) && (state->pen.style() != Qt::NoPen);
365 qreal penWidth = state->pen.widthF();
370 // In case of complex xform
371 if (state->matrix.type() > QTransform::TxScale) {
372 QPainterPathStroker stroker;
373 stroker.setWidth(penWidth);
374 stroker.setJoinStyle(state->pen.joinStyle());
375 stroker.setCapStyle(state->pen.capStyle());
376 QPainterPath stroke = stroker.createStroke(originalPath);
377 strokeBounds = (stroke * state->matrix).boundingRect();
379 strokeOffsetX = qAbs(penWidth * state->matrix.m11() / 2.0);
380 strokeOffsetY = qAbs(penWidth * state->matrix.m22() / 2.0);
386 if (!strokeBounds.isEmpty()) {
387 absPathRect = strokeBounds.intersected(QRectF(0, 0, device->width(), device->height())).toAlignedRect();
389 absPathRect = pathBounds.adjusted(-strokeOffsetX, -strokeOffsetY, strokeOffsetX, strokeOffsetY)
390 .intersected(QRectF(0, 0, device->width(), device->height())).toAlignedRect();
393 if (q->hasClipping()) {
394 bool hasPerspectiveTransform = false;
395 for (int i = 0; i < state->clipInfo.size(); ++i) {
396 const QPainterClipInfo &info = state->clipInfo.at(i);
397 if (info.matrix.type() == QTransform::TxProject) {
398 hasPerspectiveTransform = true;
402 // avoid mapping QRegions with perspective transforms
403 if (!hasPerspectiveTransform) {
404 // The trick with txinv and invMatrix is done in order to
405 // avoid transforming the clip to logical coordinates, and
406 // then back to device coordinates. This is a problem with
407 // QRegion/QRect based clips, since they use integer
408 // coordinates and converting to/from logical coordinates will
410 bool old_txinv = txinv;
411 QTransform old_invMatrix = invMatrix;
413 invMatrix = QTransform();
414 QPainterPath clipPath = q->clipPath();
415 QRectF r = clipPath.boundingRect().intersected(absPathRect);
416 absPathRect = r.toAlignedRect();
418 invMatrix = old_invMatrix;
422 // qDebug("\nQPainterPrivate::draw_helper(), x=%d, y=%d, w=%d, h=%d",
423 // devMinX, devMinY, device->width(), device->height());
424 // qDebug() << " - matrix" << state->matrix;
425 // qDebug() << " - originalPath.bounds" << originalPath.boundingRect();
426 // qDebug() << " - path.bounds" << path.boundingRect();
428 if (absPathRect.width() <= 0 || absPathRect.height() <= 0)
431 QImage image(absPathRect.width(), absPathRect.height(), QImage::Format_ARGB32_Premultiplied);
436 p.d_ptr->helper_device = helper_device;
438 p.setOpacity(state->opacity);
439 p.translate(-absPathRect.x(), -absPathRect.y());
440 p.setTransform(state->matrix, true);
441 p.setPen(doStroke ? state->pen : QPen(Qt::NoPen));
442 p.setBrush((op & FillDraw) ? state->brush : QBrush(Qt::NoBrush));
443 p.setBackground(state->bgBrush);
444 p.setBackgroundMode(state->bgMode);
445 p.setBrushOrigin(state->brushOrigin);
447 p.setRenderHint(QPainter::Antialiasing, state->renderHints & QPainter::Antialiasing);
448 p.setRenderHint(QPainter::SmoothPixmapTransform,
449 state->renderHints & QPainter::SmoothPixmapTransform);
451 p.drawPath(originalPath);
454 static bool do_fallback_overlay = qgetenv("QT_PAINT_FALLBACK_OVERLAY").size() > 0;
455 if (do_fallback_overlay) {
456 QImage block(8, 8, QImage::Format_ARGB32_Premultiplied);
458 pt.fillRect(0, 0, 8, 8, QColor(196, 0, 196));
459 pt.drawLine(0, 0, 8, 8);
462 p.setCompositionMode(QPainter::CompositionMode_SourceAtop);
464 p.fillRect(0, 0, image.width(), image.height(), QBrush(block));
471 state->matrix = QTransform();
473 extended->transformChanged();
475 state->dirtyFlags |= QPaintEngine::DirtyTransform;
478 engine->drawImage(absPathRect,
480 QRectF(0, 0, absPathRect.width(), absPathRect.height()),
481 Qt::OrderedDither | Qt::OrderedAlphaDither);
485 void QPainterPrivate::drawOpaqueBackground(const QPainterPath &path, DrawOperation op)
489 q->setBackgroundMode(Qt::TransparentMode);
491 if (op & FillDraw && state->brush.style() != Qt::NoBrush) {
492 q->fillPath(path, state->bgBrush.color());
493 q->fillPath(path, state->brush);
496 if (op & StrokeDraw && state->pen.style() != Qt::NoPen) {
497 q->strokePath(path, QPen(state->bgBrush.color(), state->pen.width()));
498 q->strokePath(path, state->pen);
501 q->setBackgroundMode(Qt::OpaqueMode);
504 static inline QBrush stretchGradientToUserSpace(const QBrush &brush, const QRectF &boundingRect)
506 Q_ASSERT(brush.style() >= Qt::LinearGradientPattern
507 && brush.style() <= Qt::ConicalGradientPattern);
509 QTransform gradientToUser(boundingRect.width(), 0, 0, boundingRect.height(),
510 boundingRect.x(), boundingRect.y());
512 QGradient g = *brush.gradient();
513 g.setCoordinateMode(QGradient::LogicalMode);
516 b.setTransform(gradientToUser * b.transform());
520 void QPainterPrivate::drawStretchedGradient(const QPainterPath &path, DrawOperation op)
524 const qreal sw = helper_device->width();
525 const qreal sh = helper_device->height();
527 bool changedPen = false;
528 bool changedBrush = false;
529 bool needsFill = false;
531 const QPen pen = state->pen;
532 const QBrush brush = state->brush;
534 const QGradient::CoordinateMode penMode = coordinateMode(pen.brush());
535 const QGradient::CoordinateMode brushMode = coordinateMode(brush);
539 // Draw the xformed fill if the brush is a stretch gradient.
540 if ((op & FillDraw) && brush.style() != Qt::NoBrush) {
541 if (brushMode == QGradient::StretchToDeviceMode) {
542 q->setPen(Qt::NoPen);
543 changedPen = pen.style() != Qt::NoPen;
547 const qreal isw = 1.0 / sw;
548 const qreal ish = 1.0 / sh;
549 QTransform inv(isw, 0, 0, ish, 0, 0);
550 engine->drawPath(path * inv);
555 if (brushMode == QGradient::ObjectBoundingMode) {
556 Q_ASSERT(engine->hasFeature(QPaintEngine::PatternTransform));
557 boundingRect = path.boundingRect();
558 q->setBrush(stretchGradientToUserSpace(brush, boundingRect));
564 if ((op & StrokeDraw) && pen.style() != Qt::NoPen) {
565 // Draw the xformed outline if the pen is a stretch gradient.
566 if (penMode == QGradient::StretchToDeviceMode) {
567 q->setPen(Qt::NoPen);
572 engine->drawPath(path);
576 q->setBrush(pen.brush());
580 QPainterPathStroker stroker;
581 stroker.setDashPattern(pen.style());
582 stroker.setWidth(pen.widthF());
583 stroker.setJoinStyle(pen.joinStyle());
584 stroker.setCapStyle(pen.capStyle());
585 stroker.setMiterLimit(pen.miterLimit());
586 QPainterPath stroke = stroker.createStroke(path);
588 const qreal isw = 1.0 / sw;
589 const qreal ish = 1.0 / sh;
590 QTransform inv(isw, 0, 0, ish, 0, 0);
591 engine->drawPath(stroke * inv);
594 if (!needsFill && brush.style() != Qt::NoBrush) {
595 q->setBrush(Qt::NoBrush);
599 if (penMode == QGradient::ObjectBoundingMode) {
600 Q_ASSERT(engine->hasFeature(QPaintEngine::PatternTransform));
602 // avoid computing the bounding rect twice
603 if (!needsFill || brushMode != QGradient::ObjectBoundingMode)
604 boundingRect = path.boundingRect();
607 p.setBrush(stretchGradientToUserSpace(pen.brush(), boundingRect));
610 } else if (changedPen) {
616 engine->drawPath(path);
618 } else if (needsFill) {
619 if (pen.style() != Qt::NoPen) {
620 q->setPen(Qt::NoPen);
625 engine->drawPath(path);
635 void QPainterPrivate::updateMatrix()
637 state->matrix = state->WxF ? state->worldMatrix : QTransform();
639 state->matrix *= viewTransform();
641 txinv = false; // no inverted matrix
642 state->matrix *= state->redirectionMatrix;
644 extended->transformChanged();
646 state->dirtyFlags |= QPaintEngine::DirtyTransform;
648 // printf("VxF=%d, WxF=%d\n", state->VxF, state->WxF);
649 // qDebug() << " --- using matrix" << state->matrix << redirection_offset;
653 void QPainterPrivate::updateInvMatrix()
655 Q_ASSERT(txinv == false);
656 txinv = true; // creating inverted matrix
657 invMatrix = state->matrix.inverted();
660 extern bool qt_isExtendedRadialGradient(const QBrush &brush);
662 void QPainterPrivate::updateEmulationSpecifier(QPainterState *s)
665 bool linearGradient = false;
666 bool radialGradient = false;
667 bool extendedRadialGradient = false;
668 bool conicalGradient = false;
669 bool patternBrush = false;
671 bool complexXform = false;
675 // Pen and brush properties (we have to check both if one changes because the
676 // one that's unchanged can still be in a state which requires emulation)
677 if (s->state() & (QPaintEngine::DirtyPen | QPaintEngine::DirtyBrush | QPaintEngine::DirtyHints)) {
678 // Check Brush stroke emulation
679 if (!s->pen.isSolid() && !engine->hasFeature(QPaintEngine::BrushStroke))
680 s->emulationSpecifier |= QPaintEngine::BrushStroke;
682 s->emulationSpecifier &= ~QPaintEngine::BrushStroke;
686 QBrush penBrush = (qpen_style(s->pen) == Qt::NoPen) ? QBrush(Qt::NoBrush) : qpen_brush(s->pen);
687 Qt::BrushStyle brushStyle = qbrush_style(s->brush);
688 Qt::BrushStyle penBrushStyle = qbrush_style(penBrush);
689 alpha = (penBrushStyle != Qt::NoBrush
690 && (penBrushStyle < Qt::LinearGradientPattern && penBrush.color().alpha() != 255)
691 && !penBrush.isOpaque())
692 || (brushStyle != Qt::NoBrush
693 && (brushStyle < Qt::LinearGradientPattern && s->brush.color().alpha() != 255)
694 && !s->brush.isOpaque());
695 linearGradient = ((penBrushStyle == Qt::LinearGradientPattern) ||
696 (brushStyle == Qt::LinearGradientPattern));
697 radialGradient = ((penBrushStyle == Qt::RadialGradientPattern) ||
698 (brushStyle == Qt::RadialGradientPattern));
699 extendedRadialGradient = radialGradient && (qt_isExtendedRadialGradient(penBrush) || qt_isExtendedRadialGradient(s->brush));
700 conicalGradient = ((penBrushStyle == Qt::ConicalGradientPattern) ||
701 (brushStyle == Qt::ConicalGradientPattern));
702 patternBrush = (((penBrushStyle > Qt::SolidPattern
703 && penBrushStyle < Qt::LinearGradientPattern)
704 || penBrushStyle == Qt::TexturePattern) ||
705 ((brushStyle > Qt::SolidPattern
706 && brushStyle < Qt::LinearGradientPattern)
707 || brushStyle == Qt::TexturePattern));
709 bool penTextureAlpha = false;
710 if (penBrush.style() == Qt::TexturePattern)
711 penTextureAlpha = qHasPixmapTexture(penBrush)
712 ? (penBrush.texture().depth() > 1) && penBrush.texture().hasAlpha()
713 : penBrush.textureImage().hasAlphaChannel();
714 bool brushTextureAlpha = false;
715 if (s->brush.style() == Qt::TexturePattern) {
716 brushTextureAlpha = qHasPixmapTexture(s->brush)
717 ? (s->brush.texture().depth() > 1) && s->brush.texture().hasAlpha()
718 : s->brush.textureImage().hasAlphaChannel();
720 if (((penBrush.style() == Qt::TexturePattern && penTextureAlpha)
721 || (s->brush.style() == Qt::TexturePattern && brushTextureAlpha))
722 && !engine->hasFeature(QPaintEngine::MaskedBrush))
723 s->emulationSpecifier |= QPaintEngine::MaskedBrush;
725 s->emulationSpecifier &= ~QPaintEngine::MaskedBrush;
728 if (s->state() & (QPaintEngine::DirtyHints
729 | QPaintEngine::DirtyOpacity
730 | QPaintEngine::DirtyBackgroundMode)) {
738 qDebug("QPainterPrivate::updateEmulationSpecifier, state=%p\n"
740 " - linearGradient: %d\n"
741 " - radialGradient: %d\n"
742 " - conicalGradient: %d\n"
743 " - patternBrush: %d\n"
752 uint(s->renderHints),
757 if (s->state() & QPaintEngine::DirtyTransform) {
758 xform = !s->matrix.isIdentity();
759 complexXform = !s->matrix.isAffine();
760 } else if (s->matrix.type() >= QTransform::TxTranslate) {
762 complexXform = !s->matrix.isAffine();
765 const bool brushXform = (!s->brush.transform().type() == QTransform::TxNone);
766 const bool penXform = (!s->pen.brush().transform().type() == QTransform::TxNone);
768 const bool patternXform = patternBrush && (xform || brushXform || penXform);
770 // Check alphablending
771 if (alpha && !engine->hasFeature(QPaintEngine::AlphaBlend))
772 s->emulationSpecifier |= QPaintEngine::AlphaBlend;
774 s->emulationSpecifier &= ~QPaintEngine::AlphaBlend;
776 // Linear gradient emulation
777 if (linearGradient && !engine->hasFeature(QPaintEngine::LinearGradientFill))
778 s->emulationSpecifier |= QPaintEngine::LinearGradientFill;
780 s->emulationSpecifier &= ~QPaintEngine::LinearGradientFill;
782 // Radial gradient emulation
783 if (extendedRadialGradient || (radialGradient && !engine->hasFeature(QPaintEngine::RadialGradientFill)))
784 s->emulationSpecifier |= QPaintEngine::RadialGradientFill;
786 s->emulationSpecifier &= ~QPaintEngine::RadialGradientFill;
788 // Conical gradient emulation
789 if (conicalGradient && !engine->hasFeature(QPaintEngine::ConicalGradientFill))
790 s->emulationSpecifier |= QPaintEngine::ConicalGradientFill;
792 s->emulationSpecifier &= ~QPaintEngine::ConicalGradientFill;
795 if (patternBrush && !engine->hasFeature(QPaintEngine::PatternBrush))
796 s->emulationSpecifier |= QPaintEngine::PatternBrush;
798 s->emulationSpecifier &= ~QPaintEngine::PatternBrush;
801 if (patternXform && !engine->hasFeature(QPaintEngine::PatternTransform))
802 s->emulationSpecifier |= QPaintEngine::PatternTransform;
804 s->emulationSpecifier &= ~QPaintEngine::PatternTransform;
807 if (xform && !engine->hasFeature(QPaintEngine::PrimitiveTransform))
808 s->emulationSpecifier |= QPaintEngine::PrimitiveTransform;
810 s->emulationSpecifier &= ~QPaintEngine::PrimitiveTransform;
812 // Perspective XForms
813 if (complexXform && !engine->hasFeature(QPaintEngine::PerspectiveTransform))
814 s->emulationSpecifier |= QPaintEngine::PerspectiveTransform;
816 s->emulationSpecifier &= ~QPaintEngine::PerspectiveTransform;
819 if (state->opacity != 1 && !engine->hasFeature(QPaintEngine::ConstantOpacity))
820 s->emulationSpecifier |= QPaintEngine::ConstantOpacity;
822 s->emulationSpecifier &= ~QPaintEngine::ConstantOpacity;
824 bool gradientStretch = false;
825 bool objectBoundingMode = false;
826 if (linearGradient || conicalGradient || radialGradient) {
827 QGradient::CoordinateMode brushMode = coordinateMode(s->brush);
828 QGradient::CoordinateMode penMode = coordinateMode(s->pen.brush());
830 gradientStretch |= (brushMode == QGradient::StretchToDeviceMode);
831 gradientStretch |= (penMode == QGradient::StretchToDeviceMode);
833 objectBoundingMode |= (brushMode == QGradient::ObjectBoundingMode);
834 objectBoundingMode |= (penMode == QGradient::ObjectBoundingMode);
837 s->emulationSpecifier |= QGradient_StretchToDevice;
839 s->emulationSpecifier &= ~QGradient_StretchToDevice;
841 if (objectBoundingMode && !engine->hasFeature(QPaintEngine::ObjectBoundingModeGradients))
842 s->emulationSpecifier |= QPaintEngine::ObjectBoundingModeGradients;
844 s->emulationSpecifier &= ~QPaintEngine::ObjectBoundingModeGradients;
846 // Opaque backgrounds...
847 if (s->bgMode == Qt::OpaqueMode &&
848 (is_pen_transparent(s->pen) || is_brush_transparent(s->brush)))
849 s->emulationSpecifier |= QPaintEngine_OpaqueBackground;
851 s->emulationSpecifier &= ~QPaintEngine_OpaqueBackground;
854 //won't be correct either way because the device can already have
855 // something rendered to it in which case subsequent emulation
856 // on a fully transparent qimage and then blitting the results
857 // won't produce correct results
859 if (state->composition_mode > QPainter::CompositionMode_Xor &&
860 !engine->hasFeature(QPaintEngine::BlendModes))
861 s->emulationSpecifier |= QPaintEngine::BlendModes;
863 s->emulationSpecifier &= ~QPaintEngine::BlendModes;
867 void QPainterPrivate::updateStateImpl(QPainterState *newState)
869 // ### we might have to call QPainter::begin() here...
870 if (!engine->state) {
871 engine->state = newState;
872 engine->setDirty(QPaintEngine::AllDirty);
875 if (engine->state->painter() != newState->painter)
876 // ### this could break with clip regions vs paths.
877 engine->setDirty(QPaintEngine::AllDirty);
879 // Upon restore, revert all changes since last save
880 else if (engine->state != newState)
881 newState->dirtyFlags |= QPaintEngine::DirtyFlags(static_cast<QPainterState *>(engine->state)->changeFlags);
883 // We need to store all changes made so that restore can deal with them
885 newState->changeFlags |= newState->dirtyFlags;
887 updateEmulationSpecifier(newState);
889 // Unset potential dirty background mode
890 newState->dirtyFlags &= ~(QPaintEngine::DirtyBackgroundMode
891 | QPaintEngine::DirtyBackground);
893 engine->state = newState;
894 engine->updateState(*newState);
895 engine->clearDirty(QPaintEngine::AllDirty);
899 void QPainterPrivate::updateState(QPainterState *newState)
903 engine->state = newState;
905 } else if (newState->state() || engine->state!=newState) {
906 bool setNonCosmeticPen = (newState->renderHints & QPainter::NonCosmeticDefaultPen)
907 && newState->pen.widthF() == 0;
908 if (setNonCosmeticPen) {
909 // Override the default pen's cosmetic state if the
910 // NonCosmeticDefaultPen render hint is used.
911 QPen oldPen = newState->pen;
912 newState->pen.setWidth(1);
913 newState->pen.setCosmetic(false);
914 newState->dirtyFlags |= QPaintEngine::DirtyPen;
916 updateStateImpl(newState);
918 // Restore the state pen back to its default to preserve visible
920 newState->pen = oldPen;
922 updateStateImpl(newState);
930 \brief The QPainter class performs low-level painting on widgets and
937 QPainter provides highly optimized functions to do most of the
938 drawing GUI programs require. It can draw everything from simple
939 lines to complex shapes like pies and chords. It can also draw
940 aligned text and pixmaps. Normally, it draws in a "natural"
941 coordinate system, but it can also do view and world
942 transformation. QPainter can operate on any object that inherits
943 the QPaintDevice class.
945 The common use of QPainter is inside a widget's paint event:
946 Construct and customize (e.g. set the pen or the brush) the
947 painter. Then draw. Remember to destroy the QPainter object after
948 drawing. For example:
950 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 0
952 The core functionality of QPainter is drawing, but the class also
953 provide several functions that allows you to customize QPainter's
954 settings and its rendering quality, and others that enable
955 clipping. In addition you can control how different shapes are
956 merged together by specifying the painter's composition mode.
958 The isActive() function indicates whether the painter is active. A
959 painter is activated by the begin() function and the constructor
960 that takes a QPaintDevice argument. The end() function, and the
961 destructor, deactivates it.
963 Together with the QPaintDevice and QPaintEngine classes, QPainter
964 form the basis for Qt's paint system. QPainter is the class used
965 to perform drawing operations. QPaintDevice represents a device
966 that can be painted on using a QPainter. QPaintEngine provides the
967 interface that the painter uses to draw onto different types of
968 devices. If the painter is active, device() returns the paint
969 device on which the painter paints, and paintEngine() returns the
970 paint engine that the painter is currently operating on. For more
971 information, see the \l {Paint System}.
973 Sometimes it is desirable to make someone else paint on an unusual
974 QPaintDevice. QPainter supports a static function to do this,
977 \warning When the paintdevice is a widget, QPainter can only be
978 used inside a paintEvent() function or in a function called by
979 paintEvent(); that is unless the Qt::WA_PaintOutsidePaintEvent
980 widget attribute is set. On Mac OS X and Windows, you can only
981 paint in a paintEvent() function regardless of this attribute's
988 There are several settings that you can customize to make QPainter
989 draw according to your preferences:
993 \o font() is the font used for drawing text. If the painter
994 isActive(), you can retrieve information about the currently set
995 font, and its metrics, using the fontInfo() and fontMetrics()
996 functions respectively.
998 \o brush() defines the color or pattern that is used for filling
1001 \o pen() defines the color or stipple that is used for drawing
1002 lines or boundaries.
1004 \o backgroundMode() defines whether there is a background() or
1005 not, i.e it is either Qt::OpaqueMode or Qt::TransparentMode.
1007 \o background() only applies when backgroundMode() is \l
1008 Qt::OpaqueMode and pen() is a stipple. In that case, it
1009 describes the color of the background pixels in the stipple.
1011 \o brushOrigin() defines the origin of the tiled brushes, normally
1012 the origin of widget's background.
1014 \o viewport(), window(), worldTransform() make up the painter's coordinate
1015 transformation system. For more information, see the \l
1016 {Coordinate Transformations} section and the \l {Coordinate
1017 System} documentation.
1019 \o hasClipping() tells whether the painter clips at all. (The paint
1020 device clips, too.) If the painter clips, it clips to clipRegion().
1022 \o layoutDirection() defines the layout direction used by the
1023 painter when drawing text.
1025 \o worldMatrixEnabled() tells whether world transformation is enabled.
1027 \o viewTransformEnabled() tells whether view transformation is
1032 Note that some of these settings mirror settings in some paint
1033 devices, e.g. QWidget::font(). The QPainter::begin() function (or
1034 equivalently the QPainter constructor) copies these attributes
1035 from the paint device.
1037 You can at any time save the QPainter's state by calling the
1038 save() function which saves all the available settings on an
1039 internal stack. The restore() function pops them back.
1043 QPainter provides functions to draw most primitives: drawPoint(),
1044 drawPoints(), drawLine(), drawRect(), drawRoundedRect(),
1045 drawEllipse(), drawArc(), drawPie(), drawChord(), drawPolyline(),
1046 drawPolygon(), drawConvexPolygon() and drawCubicBezier(). The two
1047 convenience functions, drawRects() and drawLines(), draw the given
1048 number of rectangles or lines in the given array of \l
1049 {QRect}{QRects} or \l {QLine}{QLines} using the current pen and
1052 The QPainter class also provides the fillRect() function which
1053 fills the given QRect, with the given QBrush, and the eraseRect()
1054 function that erases the area inside the given rectangle.
1056 All of these functions have both integer and floating point
1061 \o \inlineimage qpainter-basicdrawing.png
1063 \bold {Basic Drawing Example}
1065 The \l {painting/basicdrawing}{Basic Drawing} example shows how to
1066 display basic graphics primitives in a variety of styles using the
1071 If you need to draw a complex shape, especially if you need to do
1072 so repeatedly, consider creating a QPainterPath and drawing it
1078 \bold {Painter Paths example}
1080 The QPainterPath class provides a container for painting
1081 operations, enabling graphical shapes to be constructed and
1084 The \l {painting/painterpaths}{Painter Paths} example shows how
1085 painter paths can be used to build complex shapes for rendering.
1087 \o \inlineimage qpainter-painterpaths.png
1090 QPainter also provides the fillPath() function which fills the
1091 given QPainterPath with the given QBrush, and the strokePath()
1092 function that draws the outline of the given path (i.e. strokes
1095 See also the \l {painting/deform}{Vector Deformation} example which
1096 shows how to use advanced vector techniques to draw text using a
1097 QPainterPath, the \l {painting/gradients}{Gradients} example which shows
1098 the different types of gradients that are available in Qt, and the \l
1099 {painting/pathstroke}{Path Stroking} example which shows Qt's built-in
1100 dash patterns and shows how custom patterns can be used to extend
1101 the range of available patterns.
1105 \o \l {painting/deform}{Vector Deformation}
1106 \o \l {painting/gradients}{Gradients}
1107 \o \l {painting/pathstroke}{Path Stroking}
1109 \o \inlineimage qpainter-vectordeformation.png
1110 \o \inlineimage qpainter-gradients.png
1111 \o \inlineimage qpainter-pathstroking.png
1115 There are functions to draw pixmaps/images, namely drawPixmap(),
1116 drawImage() and drawTiledPixmap(). Both drawPixmap() and drawImage()
1117 produce the same result, except that drawPixmap() is faster
1118 on-screen while drawImage() may be faster on a QPrinter or other
1121 Text drawing is done using drawText(). When you need
1122 fine-grained positioning, boundingRect() tells you where a given
1123 drawText() command will draw.
1125 There is a drawPicture() function that draws the contents of an
1126 entire QPicture. The drawPicture() function is the only function
1127 that disregards all the painter's settings as QPicture has its own
1130 \section1 Rendering Quality
1132 To get the optimal rendering result using QPainter, you should use
1133 the platform independent QImage as paint device; i.e. using QImage
1134 will ensure that the result has an identical pixel representation
1137 The QPainter class also provides a means of controlling the
1138 rendering quality through its RenderHint enum and the support for
1139 floating point precision: All the functions for drawing primitives
1140 has a floating point version. These are often used in combination
1141 with the \l {RenderHint}{QPainter::Antialiasing} render hint.
1145 \o \inlineimage qpainter-concentriccircles.png
1147 \bold {Concentric Circles Example}
1149 The \l {painting/concentriccircles}{Concentric Circles} example
1150 shows the improved rendering quality that can be obtained using
1151 floating point precision and anti-aliasing when drawing custom
1154 The application's main window displays several widgets which are
1155 drawn using the various combinations of precision and
1160 The RenderHint enum specifies flags to QPainter that may or may
1161 not be respected by any given engine. \l
1162 {RenderHint}{QPainter::Antialiasing} indicates that the engine
1163 should antialias edges of primitives if possible, \l
1164 {RenderHint}{QPainter::TextAntialiasing} indicates that the engine
1165 should antialias text if possible, and the \l
1166 {RenderHint}{QPainter::SmoothPixmapTransform} indicates that the
1167 engine should use a smooth pixmap transformation algorithm.
1168 \l {RenderHint}{HighQualityAntialiasing} is an OpenGL-specific rendering hint
1169 indicating that the engine should use fragment programs and offscreen
1170 rendering for antialiasing.
1172 The renderHints() function returns a flag that specifies the
1173 rendering hints that are set for this painter. Use the
1174 setRenderHint() function to set or clear the currently set
1177 \section1 Coordinate Transformations
1179 Normally, the QPainter operates on the device's own coordinate
1180 system (usually pixels), but QPainter has good support for
1181 coordinate transformations.
1185 \o nop \o rotate() \o scale() \o translate()
1187 \o \inlineimage qpainter-clock.png
1188 \o \inlineimage qpainter-rotation.png
1189 \o \inlineimage qpainter-scale.png
1190 \o \inlineimage qpainter-translation.png
1193 The most commonly used transformations are scaling, rotation,
1194 translation and shearing. Use the scale() function to scale the
1195 coordinate system by a given offset, the rotate() function to
1196 rotate it clockwise and translate() to translate it (i.e. adding a
1197 given offset to the points). You can also twist the coordinate
1198 system around the origin using the shear() function. See the \l
1199 {painting/affine}{Affine Transformations} example for a visualization of
1200 a sheared coordinate system.
1202 See also the \l {painting/transformations}{Transformations}
1203 example which shows how transformations influence the way that
1204 QPainter renders graphics primitives. In particular it shows how
1205 the order of transformations affects the result.
1210 \bold {Affine Transformations Example}
1212 The \l {painting/affine}{Affine Transformations} example shows Qt's
1213 ability to perform affine transformations on painting
1214 operations. The demo also allows the user to experiment with the
1215 transformation operations and see the results immediately.
1217 \o \inlineimage qpainter-affinetransformations.png
1220 All the tranformation operations operate on the transformation
1221 worldTransform(). A matrix transforms a point in the plane to another
1222 point. For more information about the transformation matrix, see
1223 the \l {Coordinate System} and QTransform documentation.
1225 The setWorldTransform() function can replace or add to the currently
1226 set worldTransform(). The resetTransform() function resets any
1227 transformations that were made using translate(), scale(),
1228 shear(), rotate(), setWorldTransform(), setViewport() and setWindow()
1229 functions. The deviceTransform() returns the matrix that transforms
1230 from logical coordinates to device coordinates of the platform
1231 dependent paint device. The latter function is only needed when
1232 using platform painting commands on the platform dependent handle,
1233 and the platform does not do transformations nativly.
1235 When drawing with QPainter, we specify points using logical
1236 coordinates which then are converted into the physical coordinates
1237 of the paint device. The mapping of the logical coordinates to the
1238 physical coordinates are handled by QPainter's combinedTransform(), a
1239 combination of viewport() and window() and worldTransform(). The
1240 viewport() represents the physical coordinates specifying an
1241 arbitrary rectangle, the window() describes the same rectangle in
1242 logical coordinates, and the worldTransform() is identical with the
1243 transformation matrix.
1245 See also \l {Coordinate System}
1249 QPainter can clip any drawing operation to a rectangle, a region,
1250 or a vector path. The current clip is available using the
1251 functions clipRegion() and clipPath(). Whether paths or regions are
1252 preferred (faster) depends on the underlying paintEngine(). For
1253 example, the QImage paint engine prefers paths while the X11 paint
1254 engine prefers regions. Setting a clip is done in the painters
1255 logical coordinates.
1257 After QPainter's clipping, the paint device may also clip. For
1258 example, most widgets clip away the pixels used by child widgets,
1259 and most printers clip away an area near the edges of the paper.
1260 This additional clipping is not reflected by the return value of
1261 clipRegion() or hasClipping().
1263 \section1 Composition Modes
1264 \target Composition Modes
1266 QPainter provides the CompositionMode enum which defines the
1267 Porter-Duff rules for digital image compositing; it describes a
1268 model for combining the pixels in one image, the source, with the
1269 pixels in another image, the destination.
1271 The two most common forms of composition are \l
1272 {QPainter::CompositionMode}{Source} and \l
1273 {QPainter::CompositionMode}{SourceOver}. \l
1274 {QPainter::CompositionMode}{Source} is used to draw opaque objects
1275 onto a paint device. In this mode, each pixel in the source
1276 replaces the corresponding pixel in the destination. In \l
1277 {QPainter::CompositionMode}{SourceOver} composition mode, the
1278 source object is transparent and is drawn on top of the
1281 Note that composition transformation operates pixelwise. For that
1282 reason, there is a difference between using the graphic primitive
1283 itself and its bounding rectangle: The bounding rect contains
1284 pixels with alpha == 0 (i.e the pixels surrounding the
1285 primitive). These pixels will overwrite the other image's pixels,
1286 affectively clearing those, while the primitive only overwrites
1291 \o \inlineimage qpainter-compositiondemo.png
1294 \bold {Composition Modes Example}
1296 The \l {painting/composition}{Composition Modes} example, available in
1297 Qt's examples directory, allows you to experiment with the various
1298 composition modes and see the results immediately.
1302 \section1 Limitations
1305 If you are using coordinates with Qt's raster-based paint engine, it is
1306 important to note that, while coordinates greater than +/- 2\sup 15 can
1307 be used, any painting performed with coordinates outside this range is not
1308 guaranteed to be shown; the drawing may be clipped. This is due to the
1309 use of \c{short int} in the implementation.
1311 The outlines generated by Qt's stroker are only an approximation when dealing
1312 with curved shapes. It is in most cases impossible to represent the outline of
1313 a bezier curve segment using another bezier curve segment, and so Qt approximates
1314 the curve outlines by using several smaller curves. For performance reasons there
1315 is a limit to how many curves Qt uses for these outlines, and thus when using
1316 large pen widths or scales the outline error increases. To generate outlines with
1317 smaller errors it is possible to use the QPainterPathStroker class, which has the
1318 setCurveThreshold member function which let's the user specify the error tolerance.
1319 Another workaround is to convert the paths to polygons first and then draw the
1322 \section1 Performance
1324 QPainter is a rich framework that allows developers to do a great
1325 variety of graphical operations, such as gradients, composition
1326 modes and vector graphics. And QPainter can do this across a
1327 variety of different hardware and software stacks. Naturally the
1328 underlying combination of hardware and software has some
1329 implications for performance, and ensuring that every single
1330 operation is fast in combination with all the various combinations
1331 of composition modes, brushes, clipping, transformation, etc, is
1332 close to an impossible task because of the number of
1333 permutations. As a compromise we have selected a subset of the
1334 QPainter API and backends, where performance is guaranteed to be as
1335 good as we can sensibly get it for the given combination of
1336 hardware and software.
1338 The backends we focus on as high-performance engines are:
1342 \o Raster - This backend implements all rendering in pure software
1343 and is always used to render into QImages. For optimal performance
1344 only use the format types QImage::Format_ARGB32_Premultiplied,
1345 QImage::Format_RGB32 or QImage::Format_RGB16. Any other format,
1346 including QImage::Format_ARGB32, has significantly worse
1347 performance. This engine is used by default for QWidget and QPixmap.
1349 \o OpenGL 2.0 (ES) - This backend is the primary backend for
1350 hardware accelerated graphics. It can be run on desktop machines
1351 and embedded devices supporting the OpenGL 2.0 or OpenGL/ES 2.0
1352 specification. This includes most graphics chips produced in the
1353 last couple of years. The engine can be enabled by using QPainter
1354 onto a QOpenGLWidget or by passing \c {-graphicssystem opengl} on the
1355 command line when the underlying system supports it.
1357 \o OpenVG - This backend implements the Khronos standard for 2D
1358 and Vector Graphics. It is primarily for embedded devices with
1359 hardware support for OpenVG. The engine can be enabled by
1360 passing \c {-graphicssystem openvg} on the command line when
1361 the underlying system supports it.
1365 These operations are:
1369 \o Simple transformations, meaning translation and scaling, pluss
1370 0, 90, 180, 270 degree rotations.
1372 \o \c drawPixmap() in combination with simple transformations and
1373 opacity with non-smooth transformation mode
1374 (\c QPainter::SmoothPixmapTransform not enabled as a render hint).
1376 \o Rectangle fills with solid color, two-color linear gradients
1377 and simple transforms.
1379 \o Rectangular clipping with simple transformations and intersect
1382 \o Composition Modes \c QPainter::CompositionMode_Source and
1383 QPainter::CompositionMode_SourceOver
1385 \o Rounded rectangle filling using solid color and two-color
1386 linear gradients fills.
1388 \o 3x3 patched pixmaps, via qDrawBorderPixmap.
1392 This list gives an indication of which features to safely use in
1393 an application where performance is critical. For certain setups,
1394 other operations may be fast too, but before making extensive use
1395 of them, it is recommended to benchmark and verify them on the
1396 system where the software will run in the end. There are also
1397 cases where expensive operations are ok to use, for instance when
1398 the result is cached in a QPixmap.
1400 \sa QPaintDevice, QPaintEngine, {QtSvg Module}, {Basic Drawing Example},
1401 {Drawing Utility Functions}
1405 \enum QPainter::RenderHint
1407 Renderhints are used to specify flags to QPainter that may or
1408 may not be respected by any given engine.
1410 \value Antialiasing Indicates that the engine should antialias
1411 edges of primitives if possible.
1413 \value TextAntialiasing Indicates that the engine should antialias
1414 text if possible. To forcibly disable antialiasing for text, do not
1415 use this hint. Instead, set QFont::NoAntialias on your font's style
1418 \value SmoothPixmapTransform Indicates that the engine should use
1419 a smooth pixmap transformation algorithm (such as bilinear) rather
1420 than nearest neighbor.
1422 \value HighQualityAntialiasing An OpenGL-specific rendering hint
1423 indicating that the engine should use fragment programs and offscreen
1424 rendering for antialiasing.
1426 \value NonCosmeticDefaultPen The engine should interpret pens with a width
1427 of 0 (which otherwise enables QPen::isCosmetic()) as being a non-cosmetic
1428 pen with a width of 1.
1430 \sa renderHints(), setRenderHint(), {QPainter#Rendering
1431 Quality}{Rendering Quality}, {Concentric Circles Example}
1436 Constructs a painter.
1441 QPainter::QPainter()
1442 : d_ptr(new QPainterPrivate(this))
1447 \fn QPainter::QPainter(QPaintDevice *device)
1449 Constructs a painter that begins painting the paint \a device
1452 This constructor is convenient for short-lived painters, e.g. in a
1453 QWidget::paintEvent() and should be used only once. The
1454 constructor calls begin() for you and the QPainter destructor
1455 automatically calls end().
1457 Here's an example using begin() and end():
1458 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 1
1460 The same example using this constructor:
1461 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 2
1463 Since the constructor cannot provide feedback when the initialization
1464 of the painter failed you should rather use begin() and end() to paint
1465 on external devices, e.g. printers.
1470 QPainter::QPainter(QPaintDevice *pd)
1474 if (!QPainterPrivate::attachPainterPrivate(this, pd)) {
1475 d_ptr.reset(new QPainterPrivate(this));
1482 Destroys the painter.
1484 QPainter::~QPainter()
1486 d_ptr->inDestructor = true;
1490 else if (d_ptr->refcount > 1)
1491 d_ptr->detachPainterPrivate(this);
1493 // don't throw anything in the destructor.
1496 // Make sure we haven't messed things up.
1497 Q_ASSERT(d_ptr->inDestructor);
1498 d_ptr->inDestructor = false;
1499 Q_ASSERT(d_ptr->refcount == 1);
1501 free(d_ptr->d_ptrs);
1506 Returns the paint device on which this painter is currently
1507 painting, or 0 if the painter is not active.
1512 QPaintDevice *QPainter::device() const
1514 Q_D(const QPainter);
1515 if (isActive() && d->engine->d_func()->currentClipDevice)
1516 return d->engine->d_func()->currentClipDevice;
1517 return d->original_device;
1521 Returns true if begin() has been called and end() has not yet been
1522 called; otherwise returns false.
1524 \sa begin(), QPaintDevice::paintingActive()
1527 bool QPainter::isActive() const
1529 Q_D(const QPainter);
1534 Initializes the painters pen, background and font to the same as
1535 the given \a paint device.
1539 \sa begin(), {QPainter#Settings}{Settings}
1541 void QPainter::initFrom(const QPaintDevice *device)
1543 Q_ASSERT_X(device, "QPainter::initFrom(const QPaintDevice *device)", "QPaintDevice cannot be 0");
1546 qWarning("QPainter::initFrom: Painter not active, aborted");
1553 d->extended->penChanged();
1554 } else if (d->engine) {
1555 d->engine->setDirty(QPaintEngine::DirtyPen);
1556 d->engine->setDirty(QPaintEngine::DirtyBrush);
1557 d->engine->setDirty(QPaintEngine::DirtyFont);
1563 Saves the current painter state (pushes the state onto a stack). A
1564 save() must be followed by a corresponding restore(); the end()
1565 function unwinds the stack.
1570 void QPainter::save()
1572 #ifdef QT_DEBUG_DRAW
1573 if (qt_show_painter_debug_output)
1574 printf("QPainter::save()\n");
1578 qWarning("QPainter::save: Painter not active");
1583 d->state = d->extended->createState(d->states.back());
1584 d->extended->setState(d->state);
1586 d->updateState(d->state);
1587 d->state = new QPainterState(d->states.back());
1588 d->engine->state = d->state;
1590 d->states.push_back(d->state);
1594 Restores the current painter state (pops a saved state off the
1600 void QPainter::restore()
1602 #ifdef QT_DEBUG_DRAW
1603 if (qt_show_painter_debug_output)
1604 printf("QPainter::restore()\n");
1607 if (d->states.size()<=1) {
1608 qWarning("QPainter::restore: Unbalanced save/restore");
1610 } else if (!d->engine) {
1611 qWarning("QPainter::restore: Painter not active");
1615 QPainterState *tmp = d->state;
1616 d->states.pop_back();
1617 d->state = d->states.back();
1621 d->checkEmulation();
1622 d->extended->setState(d->state);
1627 // trigger clip update if the clip path/region has changed since
1629 if (!d->state->clipInfo.isEmpty()
1630 && (tmp->changeFlags & (QPaintEngine::DirtyClipRegion | QPaintEngine::DirtyClipPath))) {
1631 // reuse the tmp state to avoid any extra allocs...
1632 tmp->dirtyFlags = QPaintEngine::DirtyClipPath;
1633 tmp->clipOperation = Qt::NoClip;
1634 tmp->clipPath = QPainterPath();
1635 d->engine->updateState(*tmp);
1636 // replay the list of clip states,
1637 for (int i=0; i<d->state->clipInfo.size(); ++i) {
1638 const QPainterClipInfo &info = d->state->clipInfo.at(i);
1639 tmp->matrix = info.matrix;
1640 tmp->matrix *= d->state->redirectionMatrix;
1641 tmp->clipOperation = info.operation;
1642 if (info.clipType == QPainterClipInfo::RectClip) {
1643 tmp->dirtyFlags = QPaintEngine::DirtyClipRegion | QPaintEngine::DirtyTransform;
1644 tmp->clipRegion = info.rect;
1645 } else if (info.clipType == QPainterClipInfo::RegionClip) {
1646 tmp->dirtyFlags = QPaintEngine::DirtyClipRegion | QPaintEngine::DirtyTransform;
1647 tmp->clipRegion = info.region;
1648 } else { // clipType == QPainterClipInfo::PathClip
1649 tmp->dirtyFlags = QPaintEngine::DirtyClipPath | QPaintEngine::DirtyTransform;
1650 tmp->clipPath = info.path;
1652 d->engine->updateState(*tmp);
1656 //Since we've updated the clip region anyway, pretend that the clip path hasn't changed:
1657 d->state->dirtyFlags &= ~(QPaintEngine::DirtyClipPath | QPaintEngine::DirtyClipRegion);
1658 tmp->changeFlags &= ~(QPaintEngine::DirtyClipPath | QPaintEngine::DirtyClipRegion);
1659 tmp->changeFlags |= QPaintEngine::DirtyTransform;
1662 d->updateState(d->state);
1669 \fn bool QPainter::begin(QPaintDevice *device)
1671 Begins painting the paint \a device and returns true if
1672 successful; otherwise returns false.
1674 Notice that all painter settings (setPen(), setBrush() etc.) are reset
1675 to default values when begin() is called.
1677 The errors that can occur are serious problems, such as these:
1679 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 3
1681 Note that most of the time, you can use one of the constructors
1682 instead of begin(), and that end() is automatically done at
1685 \warning A paint device can only be painted by one painter at a
1688 \warning Painting on a QImage with the format
1689 QImage::Format_Indexed8 is not supported.
1691 \sa end(), QPainter()
1694 static inline void qt_cleanup_painter_state(QPainterPrivate *d)
1703 bool QPainter::begin(QPaintDevice *pd)
1707 if (pd->painters > 0) {
1708 qWarning("QPainter::begin: A paint device can only be painted by one painter at a time.");
1712 if (d_ptr->engine) {
1713 qWarning("QPainter::begin: Painter already active");
1717 if (QPainterPrivate::attachPainterPrivate(this, pd))
1722 d->helper_device = pd;
1723 d->original_device = pd;
1725 QPoint redirectionOffset;
1726 QPaintDevice *rpd = pd->redirected(&redirectionOffset);
1730 #ifdef QT_DEBUG_DRAW
1731 if (qt_show_painter_debug_output)
1732 printf("QPainter::begin(), device=%p, type=%d\n", pd, pd->devType());
1735 if (pd->devType() == QInternal::Pixmap)
1736 static_cast<QPixmap *>(pd)->detach();
1737 else if (pd->devType() == QInternal::Image)
1738 static_cast<QImage *>(pd)->detach();
1740 d->engine = pd->paintEngine();
1743 qWarning("QPainter::begin: Paint device returned engine == 0, type: %d", pd->devType());
1749 d->extended = d->engine->isExtended() ? static_cast<QPaintEngineEx *>(d->engine) : 0;
1750 if (d->emulationEngine)
1751 d->emulationEngine->real_engine = d->extended;
1753 // Setup new state...
1754 Q_ASSERT(!d->state);
1755 d->state = d->extended ? d->extended->createState(0) : new QPainterState;
1756 d->state->painter = this;
1757 d->states.push_back(d->state);
1759 d->state->redirectionMatrix.translate(-redirectionOffset.x(), -redirectionOffset.y());
1760 d->state->brushOrigin = QPointF();
1762 // Slip a painter state into the engine before we do any other operations
1764 d->extended->setState(d->state);
1766 d->engine->state = d->state;
1768 switch (pd->devType()) {
1770 // is this needed any more??
1771 case QInternal::Widget:
1773 const QWidget *widget = static_cast<const QWidget *>(pd);
1776 const bool paintOutsidePaintEvent = widget->testAttribute(Qt::WA_PaintOutsidePaintEvent);
1777 const bool inPaintEvent = widget->testAttribute(Qt::WA_WState_InPaintEvent);
1779 // Adjust offset for alien widgets painting outside the paint event.
1780 if (!inPaintEvent && paintOutsidePaintEvent && !widget->internalWinId()
1781 && widget->testAttribute(Qt::WA_WState_Created)) {
1782 const QPoint offset = widget->mapTo(widget->nativeParentWidget(), QPoint());
1783 d->state->redirectionMatrix.translate(offset.x(), offset.y());
1788 case QInternal::Pixmap:
1790 QPixmap *pm = static_cast<QPixmap *>(pd);
1793 qWarning("QPainter::begin: Cannot paint on a null pixmap");
1794 qt_cleanup_painter_state(d);
1798 if (pm->depth() == 1) {
1799 d->state->pen = QPen(Qt::color1);
1800 d->state->brush = QBrush(Qt::color0);
1804 case QInternal::Image:
1806 QImage *img = static_cast<QImage *>(pd);
1808 if (img->isNull()) {
1809 qWarning("QPainter::begin: Cannot paint on a null image");
1810 qt_cleanup_painter_state(d);
1812 } else if (img->format() == QImage::Format_Indexed8) {
1813 // Painting on indexed8 images is not supported.
1814 qWarning("QPainter::begin: Cannot paint on an image with the QImage::Format_Indexed8 format");
1815 qt_cleanup_painter_state(d);
1818 if (img->depth() == 1) {
1819 d->state->pen = QPen(Qt::color1);
1820 d->state->brush = QBrush(Qt::color0);
1827 if (d->state->ww == 0) // For compat with 3.x painter defaults
1828 d->state->ww = d->state->wh = d->state->vw = d->state->vh = 1024;
1830 d->engine->setPaintDevice(pd);
1832 bool begun = d->engine->begin(pd);
1834 qWarning("QPainter::begin(): Returned false");
1835 if (d->engine->isActive()) {
1838 qt_cleanup_painter_state(d);
1842 d->engine->setActive(begun);
1845 // Copy painter properties from original paint device,
1846 // required for QPixmap::grabWidget()
1847 if (d->original_device->devType() == QInternal::Widget) {
1848 initFrom(d->original_device);
1850 d->state->layoutDirection = Qt::LayoutDirectionAuto;
1851 // make sure we have a font compatible with the paintdevice
1852 d->state->deviceFont = d->state->font = QFont(d->state->deviceFont, device());
1855 QRect systemRect = d->engine->systemRect();
1856 if (!systemRect.isEmpty()) {
1857 d->state->ww = d->state->vw = systemRect.width();
1858 d->state->wh = d->state->vh = systemRect.height();
1860 d->state->ww = d->state->vw = pd->metric(QPaintDevice::PdmWidth);
1861 d->state->wh = d->state->vh = pd->metric(QPaintDevice::PdmHeight);
1864 const QPoint coordinateOffset = d->engine->coordinateOffset();
1865 d->state->redirectionMatrix.translate(-coordinateOffset.x(), -coordinateOffset.y());
1867 Q_ASSERT(d->engine->isActive());
1869 if (!d->state->redirectionMatrix.isIdentity())
1872 Q_ASSERT(d->engine->isActive());
1873 d->state->renderHints = QPainter::TextAntialiasing;
1874 ++d->device->painters;
1876 d->state->emulationSpecifier = 0;
1882 Ends painting. Any resources used while painting are released. You
1883 don't normally need to call this since it is called by the
1886 Returns true if the painter is no longer active; otherwise returns false.
1888 \sa begin(), isActive()
1891 bool QPainter::end()
1893 #ifdef QT_DEBUG_DRAW
1894 if (qt_show_painter_debug_output)
1895 printf("QPainter::end()\n");
1900 qWarning("QPainter::end: Painter not active, aborted");
1901 qt_cleanup_painter_state(d);
1905 if (d->refcount > 1) {
1906 d->detachPainterPrivate(this);
1912 if (d->engine->isActive()) {
1913 ended = d->engine->end();
1916 --d->device->painters;
1917 if (d->device->painters == 0) {
1918 d->engine->setPaintDevice(0);
1919 d->engine->setActive(false);
1923 if (d->states.size() > 1) {
1924 qWarning("QPainter::end: Painter ended with %d saved states",
1928 if (d->engine->autoDestruct()) {
1932 if (d->emulationEngine) {
1933 delete d->emulationEngine;
1934 d->emulationEngine = 0;
1941 qt_cleanup_painter_state(d);
1948 Returns the paint engine that the painter is currently operating
1949 on if the painter is active; otherwise 0.
1953 QPaintEngine *QPainter::paintEngine() const
1955 Q_D(const QPainter);
1962 Flushes the painting pipeline and prepares for the user issuing commands
1963 directly to the underlying graphics context. Must be followed by a call to
1964 endNativePainting().
1966 Note that only the states the underlying paint engine changes will be reset
1967 to their respective default states. The states we reset may change from
1968 release to release. The following states are currently reset in the OpenGL
1972 \i blending is disabled
1973 \i the depth, stencil and scissor tests are disabled
1974 \i the active texture unit is reset to 0
1975 \i the depth mask, depth function and the clear depth are reset to their
1977 \i the stencil mask, stencil operation and stencil function are reset to
1978 their default values
1979 \i the current color is reset to solid white
1982 If, for example, the OpenGL polygon mode is changed by the user inside a
1983 beginNativePaint()/endNativePainting() block, it will not be reset to the
1984 default state by endNativePainting(). Here is an example that shows
1985 intermixing of painter commands and raw OpenGL commands:
1987 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 21
1989 \sa endNativePainting()
1991 void QPainter::beginNativePainting()
1995 qWarning("QPainter::beginNativePainting: Painter not active");
2000 d->extended->beginNativePainting();
2006 Restores the painter after manually issuing native painting commands. Lets
2007 the painter restore any native state that it relies on before calling any
2008 other painter commands.
2010 \sa beginNativePainting()
2012 void QPainter::endNativePainting()
2014 Q_D(const QPainter);
2016 qWarning("QPainter::beginNativePainting: Painter not active");
2021 d->extended->endNativePainting();
2023 d->engine->syncState();
2027 Returns the font metrics for the painter if the painter is
2028 active. Otherwise, the return value is undefined.
2030 \sa font(), isActive(), {QPainter#Settings}{Settings}
2033 QFontMetrics QPainter::fontMetrics() const
2035 Q_D(const QPainter);
2037 qWarning("QPainter::fontMetrics: Painter not active");
2038 return QFontMetrics(QFont());
2040 return QFontMetrics(d->state->font);
2045 Returns the font info for the painter if the painter is
2046 active. Otherwise, the return value is undefined.
2048 \sa font(), isActive(), {QPainter#Settings}{Settings}
2051 QFontInfo QPainter::fontInfo() const
2053 Q_D(const QPainter);
2055 qWarning("QPainter::fontInfo: Painter not active");
2056 return QFontInfo(QFont());
2058 return QFontInfo(d->state->font);
2064 Returns the opacity of the painter. The default value is
2068 qreal QPainter::opacity() const
2070 Q_D(const QPainter);
2072 qWarning("QPainter::opacity: Painter not active");
2075 return d->state->opacity;
2081 Sets the opacity of the painter to \a opacity. The value should
2082 be in the range 0.0 to 1.0, where 0.0 is fully transparent and
2083 1.0 is fully opaque.
2085 Opacity set on the painter will apply to all drawing operations
2089 void QPainter::setOpacity(qreal opacity)
2094 qWarning("QPainter::setOpacity: Painter not active");
2098 opacity = qMin(qreal(1), qMax(qreal(0), opacity));
2100 if (opacity == d->state->opacity)
2103 d->state->opacity = opacity;
2106 d->extended->opacityChanged();
2108 d->state->dirtyFlags |= QPaintEngine::DirtyOpacity;
2113 Returns the currently set brush origin.
2115 \sa setBrushOrigin(), {QPainter#Settings}{Settings}
2118 QPoint QPainter::brushOrigin() const
2120 Q_D(const QPainter);
2122 qWarning("QPainter::brushOrigin: Painter not active");
2125 return QPointF(d->state->brushOrigin).toPoint();
2129 \fn void QPainter::setBrushOrigin(const QPointF &position)
2131 Sets the brush origin to \a position.
2133 The brush origin specifies the (0, 0) coordinate of the painter's
2136 Note that while the brushOrigin() was necessary to adopt the
2137 parent's background for a widget in Qt 3, this is no longer the
2138 case since the Qt 4 painter doesn't paint the background unless
2139 you explicitly tell it to do so by setting the widget's \l
2140 {QWidget::autoFillBackground}{autoFillBackground} property to
2143 \sa brushOrigin(), {QPainter#Settings}{Settings}
2146 void QPainter::setBrushOrigin(const QPointF &p)
2149 #ifdef QT_DEBUG_DRAW
2150 if (qt_show_painter_debug_output)
2151 printf("QPainter::setBrushOrigin(), (%.2f,%.2f)\n", p.x(), p.y());
2155 qWarning("QPainter::setBrushOrigin: Painter not active");
2159 d->state->brushOrigin = p;
2162 d->extended->brushOriginChanged();
2166 d->state->dirtyFlags |= QPaintEngine::DirtyBrushOrigin;
2170 \fn void QPainter::setBrushOrigin(const QPoint &position)
2173 Sets the brush's origin to the given \a position.
2177 \fn void QPainter::setBrushOrigin(int x, int y)
2181 Sets the brush's origin to point (\a x, \a y).
2185 \enum QPainter::CompositionMode
2187 Defines the modes supported for digital image compositing.
2188 Composition modes are used to specify how the pixels in one image,
2189 the source, are merged with the pixel in another image, the
2192 Please note that the bitwise raster operation modes, denoted with
2193 a RasterOp prefix, are only natively supported in the X11 and
2194 raster paint engines. This means that the only way to utilize
2195 these modes on the Mac is via a QImage. The RasterOp denoted blend
2196 modes are \e not supported for pens and brushes with alpha
2197 components. Also, turning on the QPainter::Antialiasing render
2198 hint will effectively disable the RasterOp modes.
2201 \image qpainter-compositionmode1.png
2202 \image qpainter-compositionmode2.png
2204 The most common type is SourceOver (often referred to as just
2205 alpha blending) where the source pixel is blended on top of the
2206 destination pixel in such a way that the alpha component of the
2207 source defines the translucency of the pixel.
2209 When the paint device is a QImage, the image format must be set to
2210 \l {QImage::Format}{Format_ARGB32Premultiplied} or
2211 \l {QImage::Format}{Format_ARGB32} for the composition modes to have
2212 any effect. For performance the premultiplied version is the preferred
2215 When a composition mode is set it applies to all painting
2216 operator, pens, brushes, gradients and pixmap/image drawing.
2218 \value CompositionMode_SourceOver This is the default mode. The
2219 alpha of the source is used to blend the pixel on top of the
2222 \value CompositionMode_DestinationOver The alpha of the
2223 destination is used to blend it on top of the source pixels. This
2224 mode is the inverse of CompositionMode_SourceOver.
2226 \value CompositionMode_Clear The pixels in the destination are
2227 cleared (set to fully transparent) independent of the source.
2229 \value CompositionMode_Source The output is the source
2230 pixel. (This means a basic copy operation and is identical to
2231 SourceOver when the source pixel is opaque).
2233 \value CompositionMode_Destination The output is the destination
2234 pixel. This means that the blending has no effect. This mode is
2235 the inverse of CompositionMode_Source.
2237 \value CompositionMode_SourceIn The output is the source, where
2238 the alpha is reduced by that of the destination.
2240 \value CompositionMode_DestinationIn The output is the
2241 destination, where the alpha is reduced by that of the
2242 source. This mode is the inverse of CompositionMode_SourceIn.
2244 \value CompositionMode_SourceOut The output is the source, where
2245 the alpha is reduced by the inverse of destination.
2247 \value CompositionMode_DestinationOut The output is the
2248 destination, where the alpha is reduced by the inverse of the
2249 source. This mode is the inverse of CompositionMode_SourceOut.
2251 \value CompositionMode_SourceAtop The source pixel is blended on
2252 top of the destination, with the alpha of the source pixel reduced
2253 by the alpha of the destination pixel.
2255 \value CompositionMode_DestinationAtop The destination pixel is
2256 blended on top of the source, with the alpha of the destination
2257 pixel is reduced by the alpha of the destination pixel. This mode
2258 is the inverse of CompositionMode_SourceAtop.
2260 \value CompositionMode_Xor The source, whose alpha is reduced with
2261 the inverse of the destination alpha, is merged with the
2262 destination, whose alpha is reduced by the inverse of the source
2263 alpha. CompositionMode_Xor is not the same as the bitwise Xor.
2265 \value CompositionMode_Plus Both the alpha and color of the source
2266 and destination pixels are added together.
2268 \value CompositionMode_Multiply The output is the source color
2269 multiplied by the destination. Multiplying a color with white
2270 leaves the color unchanged, while multiplying a color
2271 with black produces black.
2273 \value CompositionMode_Screen The source and destination colors
2274 are inverted and then multiplied. Screening a color with white
2275 produces white, whereas screening a color with black leaves the
2278 \value CompositionMode_Overlay Multiplies or screens the colors
2279 depending on the destination color. The destination color is mixed
2280 with the source color to reflect the lightness or darkness of the
2283 \value CompositionMode_Darken The darker of the source and
2284 destination colors is selected.
2286 \value CompositionMode_Lighten The lighter of the source and
2287 destination colors is selected.
2289 \value CompositionMode_ColorDodge The destination color is
2290 brightened to reflect the source color. A black source color
2291 leaves the destination color unchanged.
2293 \value CompositionMode_ColorBurn The destination color is darkened
2294 to reflect the source color. A white source color leaves the
2295 destination color unchanged.
2297 \value CompositionMode_HardLight Multiplies or screens the colors
2298 depending on the source color. A light source color will lighten
2299 the destination color, whereas a dark source color will darken the
2302 \value CompositionMode_SoftLight Darkens or lightens the colors
2303 depending on the source color. Similar to
2304 CompositionMode_HardLight.
2306 \value CompositionMode_Difference Subtracts the darker of the
2307 colors from the lighter. Painting with white inverts the
2308 destination color, whereas painting with black leaves the
2309 destination color unchanged.
2311 \value CompositionMode_Exclusion Similar to
2312 CompositionMode_Difference, but with a lower contrast. Painting
2313 with white inverts the destination color, whereas painting with
2314 black leaves the destination color unchanged.
2316 \value RasterOp_SourceOrDestination Does a bitwise OR operation on
2317 the source and destination pixels (src OR dst).
2319 \value RasterOp_SourceAndDestination Does a bitwise AND operation
2320 on the source and destination pixels (src AND dst).
2322 \value RasterOp_SourceXorDestination Does a bitwise XOR operation
2323 on the source and destination pixels (src XOR dst).
2325 \value RasterOp_NotSourceAndNotDestination Does a bitwise NOR
2326 operation on the source and destination pixels ((NOT src) AND (NOT
2329 \value RasterOp_NotSourceOrNotDestination Does a bitwise NAND
2330 operation on the source and destination pixels ((NOT src) OR (NOT
2333 \value RasterOp_NotSourceXorDestination Does a bitwise operation
2334 where the source pixels are inverted and then XOR'ed with the
2335 destination ((NOT src) XOR dst).
2337 \value RasterOp_NotSource Does a bitwise operation where the
2338 source pixels are inverted (NOT src).
2340 \value RasterOp_NotSourceAndDestination Does a bitwise operation
2341 where the source is inverted and then AND'ed with the destination
2342 ((NOT src) AND dst).
2344 \value RasterOp_SourceAndNotDestination Does a bitwise operation
2345 where the source is AND'ed with the inverted destination pixels
2346 (src AND (NOT dst)).
2348 \sa compositionMode(), setCompositionMode(), {QPainter#Composition
2349 Modes}{Composition Modes}, {Image Composition Example}
2353 Sets the composition mode to the given \a mode.
2355 \warning Only a QPainter operating on a QImage fully supports all
2356 composition modes. The RasterOp modes are supported for X11 as
2357 described in compositionMode().
2359 \sa compositionMode()
2361 void QPainter::setCompositionMode(CompositionMode mode)
2365 qWarning("QPainter::setCompositionMode: Painter not active");
2368 if (d->state->composition_mode == mode)
2371 d->state->composition_mode = mode;
2372 d->extended->compositionModeChanged();
2376 if (mode >= QPainter::RasterOp_SourceOrDestination) {
2377 if (!d->engine->hasFeature(QPaintEngine::RasterOpModes)) {
2378 qWarning("QPainter::setCompositionMode: "
2379 "Raster operation modes not supported on device");
2382 } else if (mode >= QPainter::CompositionMode_Plus) {
2383 if (!d->engine->hasFeature(QPaintEngine::BlendModes)) {
2384 qWarning("QPainter::setCompositionMode: "
2385 "Blend modes not supported on device");
2388 } else if (!d->engine->hasFeature(QPaintEngine::PorterDuff)) {
2389 if (mode != CompositionMode_Source && mode != CompositionMode_SourceOver) {
2390 qWarning("QPainter::setCompositionMode: "
2391 "PorterDuff modes not supported on device");
2396 d->state->composition_mode = mode;
2397 d->state->dirtyFlags |= QPaintEngine::DirtyCompositionMode;
2401 Returns the current composition mode.
2403 \sa CompositionMode, setCompositionMode()
2405 QPainter::CompositionMode QPainter::compositionMode() const
2407 Q_D(const QPainter);
2409 qWarning("QPainter::compositionMode: Painter not active");
2410 return QPainter::CompositionMode_SourceOver;
2412 return d->state->composition_mode;
2416 Returns the current background brush.
2418 \sa setBackground(), {QPainter#Settings}{Settings}
2421 const QBrush &QPainter::background() const
2423 Q_D(const QPainter);
2425 qWarning("QPainter::background: Painter not active");
2426 return d->fakeState()->brush;
2428 return d->state->bgBrush;
2433 Returns true if clipping has been set; otherwise returns false.
2435 \sa setClipping(), {QPainter#Clipping}{Clipping}
2438 bool QPainter::hasClipping() const
2440 Q_D(const QPainter);
2442 qWarning("QPainter::hasClipping: Painter not active");
2445 return d->state->clipEnabled && d->state->clipOperation != Qt::NoClip;
2450 Enables clipping if \a enable is true, or disables clipping if \a
2453 \sa hasClipping(), {QPainter#Clipping}{Clipping}
2456 void QPainter::setClipping(bool enable)
2459 #ifdef QT_DEBUG_DRAW
2460 if (qt_show_painter_debug_output)
2461 printf("QPainter::setClipping(), enable=%s, was=%s\n",
2462 enable ? "on" : "off",
2463 hasClipping() ? "on" : "off");
2466 qWarning("QPainter::setClipping: Painter not active, state will be reset by begin");
2470 if (hasClipping() == enable)
2473 // we can't enable clipping if we don't have a clip
2475 && (d->state->clipInfo.isEmpty() || d->state->clipInfo.last().operation == Qt::NoClip))
2477 d->state->clipEnabled = enable;
2480 d->extended->clipEnabledChanged();
2484 d->state->dirtyFlags |= QPaintEngine::DirtyClipEnabled;
2485 d->updateState(d->state);
2490 Returns the currently set clip region. Note that the clip region
2491 is given in logical coordinates.
2493 \warning QPainter does not store the combined clip explicitly as
2494 this is handled by the underlying QPaintEngine, so the path is
2495 recreated on demand and transformed to the current logical
2496 coordinate system. This is potentially an expensive operation.
2498 \sa setClipRegion(), clipPath(), setClipping()
2501 QRegion QPainter::clipRegion() const
2503 Q_D(const QPainter);
2505 qWarning("QPainter::clipRegion: Painter not active");
2510 bool lastWasNothing = true;
2513 const_cast<QPainter *>(this)->d_ptr->updateInvMatrix();
2515 // ### Falcon: Use QPainterPath
2516 for (int i=0; i<d->state->clipInfo.size(); ++i) {
2517 const QPainterClipInfo &info = d->state->clipInfo.at(i);
2518 switch (info.clipType) {
2520 case QPainterClipInfo::RegionClip: {
2521 QTransform matrix = (info.matrix * d->invMatrix);
2522 if (lastWasNothing) {
2523 region = info.region * matrix;
2524 lastWasNothing = false;
2527 if (info.operation == Qt::IntersectClip)
2528 region &= info.region * matrix;
2529 else if (info.operation == Qt::NoClip) {
2530 lastWasNothing = true;
2533 region = info.region * matrix;
2537 case QPainterClipInfo::PathClip: {
2538 QTransform matrix = (info.matrix * d->invMatrix);
2539 if (lastWasNothing) {
2540 region = QRegion((info.path * matrix).toFillPolygon().toPolygon(),
2541 info.path.fillRule());
2542 lastWasNothing = false;
2545 if (info.operation == Qt::IntersectClip) {
2546 region &= QRegion((info.path * matrix).toFillPolygon().toPolygon(),
2547 info.path.fillRule());
2548 } else if (info.operation == Qt::NoClip) {
2549 lastWasNothing = true;
2552 region = QRegion((info.path * matrix).toFillPolygon().toPolygon(),
2553 info.path.fillRule());
2558 case QPainterClipInfo::RectClip: {
2559 QTransform matrix = (info.matrix * d->invMatrix);
2560 if (lastWasNothing) {
2561 region = QRegion(info.rect) * matrix;
2562 lastWasNothing = false;
2565 if (info.operation == Qt::IntersectClip) {
2566 // Use rect intersection if possible.
2567 if (matrix.type() <= QTransform::TxScale)
2568 region &= matrix.mapRect(info.rect);
2570 region &= matrix.map(QRegion(info.rect));
2571 } else if (info.operation == Qt::NoClip) {
2572 lastWasNothing = true;
2575 region = QRegion(info.rect) * matrix;
2580 case QPainterClipInfo::RectFClip: {
2581 QTransform matrix = (info.matrix * d->invMatrix);
2582 if (lastWasNothing) {
2583 region = QRegion(info.rectf.toRect()) * matrix;
2584 lastWasNothing = false;
2587 if (info.operation == Qt::IntersectClip) {
2588 // Use rect intersection if possible.
2589 if (matrix.type() <= QTransform::TxScale)
2590 region &= matrix.mapRect(info.rectf.toRect());
2592 region &= matrix.map(QRegion(info.rectf.toRect()));
2593 } else if (info.operation == Qt::NoClip) {
2594 lastWasNothing = true;
2597 region = QRegion(info.rectf.toRect()) * matrix;
2607 extern QPainterPath qt_regionToPath(const QRegion ®ion);
2610 Returns the currently clip as a path. Note that the clip path is
2611 given in logical coordinates.
2613 \warning QPainter does not store the combined clip explicitly as
2614 this is handled by the underlying QPaintEngine, so the path is
2615 recreated on demand and transformed to the current logical
2616 coordinate system. This is potentially an expensive operation.
2618 \sa setClipPath(), clipRegion(), setClipping()
2620 QPainterPath QPainter::clipPath() const
2622 Q_D(const QPainter);
2624 // ### Since we do not support path intersections and path unions yet,
2625 // we just use clipRegion() here...
2627 qWarning("QPainter::clipPath: Painter not active");
2628 return QPainterPath();
2631 // No clip, return empty
2632 if (d->state->clipInfo.size() == 0) {
2633 return QPainterPath();
2636 // Update inverse matrix, used below.
2638 const_cast<QPainter *>(this)->d_ptr->updateInvMatrix();
2640 // For the simple case avoid conversion.
2641 if (d->state->clipInfo.size() == 1
2642 && d->state->clipInfo.at(0).clipType == QPainterClipInfo::PathClip) {
2643 QTransform matrix = (d->state->clipInfo.at(0).matrix * d->invMatrix);
2644 return d->state->clipInfo.at(0).path * matrix;
2646 } else if (d->state->clipInfo.size() == 1
2647 && d->state->clipInfo.at(0).clipType == QPainterClipInfo::RectClip) {
2648 QTransform matrix = (d->state->clipInfo.at(0).matrix * d->invMatrix);
2650 path.addRect(d->state->clipInfo.at(0).rect);
2651 return path * matrix;
2653 // Fallback to clipRegion() for now, since we don't have isect/unite for paths
2654 return qt_regionToPath(clipRegion());
2660 Returns the bounding rectangle of the current clip if there is a clip;
2661 otherwise returns an empty rectangle. Note that the clip region is
2662 given in logical coordinates.
2664 The bounding rectangle is not guaranteed to be tight.
2666 \sa setClipRect(), setClipPath(), setClipRegion()
2671 QRectF QPainter::clipBoundingRect() const
2673 Q_D(const QPainter);
2676 qWarning("QPainter::clipBoundingRect: Painter not active");
2680 // Accumulate the bounding box in device space. This is not 100%
2681 // precise, but it fits within the guarantee and it is reasonably
2684 for (int i=0; i<d->state->clipInfo.size(); ++i) {
2686 const QPainterClipInfo &info = d->state->clipInfo.at(i);
2688 if (info.clipType == QPainterClipInfo::RectClip)
2690 else if (info.clipType == QPainterClipInfo::RectFClip)
2692 else if (info.clipType == QPainterClipInfo::RegionClip)
2693 r = info.region.boundingRect();
2695 r = info.path.boundingRect();
2697 r = info.matrix.mapRect(r);
2701 else if (info.operation == Qt::IntersectClip)
2706 // Map the rectangle back into logical space using the inverse
2709 const_cast<QPainter *>(this)->d_ptr->updateInvMatrix();
2711 return d->invMatrix.mapRect(bounds);
2715 \fn void QPainter::setClipRect(const QRectF &rectangle, Qt::ClipOperation operation)
2717 Enables clipping, and sets the clip region to the given \a
2718 rectangle using the given clip \a operation. The default operation
2719 is to replace the current clip rectangle.
2721 Note that the clip rectangle is specified in logical (painter)
2724 \sa clipRegion(), setClipping(), {QPainter#Clipping}{Clipping}
2726 void QPainter::setClipRect(const QRectF &rect, Qt::ClipOperation op)
2731 if ((!d->state->clipEnabled && op != Qt::NoClip))
2732 op = Qt::ReplaceClip;
2735 qWarning("QPainter::setClipRect: Painter not active");
2738 qreal right = rect.x() + rect.width();
2739 qreal bottom = rect.y() + rect.height();
2740 qreal pts[] = { rect.x(), rect.y(),
2744 QVectorPath vp(pts, 4, 0, QVectorPath::RectangleHint);
2745 d->state->clipEnabled = true;
2746 d->extended->clip(vp, op);
2747 if (op == Qt::ReplaceClip || op == Qt::NoClip)
2748 d->state->clipInfo.clear();
2749 d->state->clipInfo << QPainterClipInfo(rect, op, d->state->matrix);
2750 d->state->clipOperation = op;
2754 if (qreal(int(rect.top())) == rect.top()
2755 && qreal(int(rect.bottom())) == rect.bottom()
2756 && qreal(int(rect.left())) == rect.left()
2757 && qreal(int(rect.right())) == rect.right())
2759 setClipRect(rect.toRect(), op);
2763 if (rect.isEmpty()) {
2764 setClipRegion(QRegion(), op);
2770 setClipPath(path, op);
2774 \fn void QPainter::setClipRect(const QRect &rectangle, Qt::ClipOperation operation)
2777 Enables clipping, and sets the clip region to the given \a rectangle using the given
2780 void QPainter::setClipRect(const QRect &rect, Qt::ClipOperation op)
2785 qWarning("QPainter::setClipRect: Painter not active");
2789 if ((!d->state->clipEnabled && op != Qt::NoClip))
2790 op = Qt::ReplaceClip;
2793 d->state->clipEnabled = true;
2794 d->extended->clip(rect, op);
2795 if (op == Qt::ReplaceClip || op == Qt::NoClip)
2796 d->state->clipInfo.clear();
2797 d->state->clipInfo << QPainterClipInfo(rect, op, d->state->matrix);
2798 d->state->clipOperation = op;
2802 if (d->state->clipOperation == Qt::NoClip && op == Qt::IntersectClip)
2803 op = Qt::ReplaceClip;
2805 d->state->clipRegion = rect;
2806 d->state->clipOperation = op;
2807 if (op == Qt::NoClip || op == Qt::ReplaceClip)
2808 d->state->clipInfo.clear();
2809 d->state->clipInfo << QPainterClipInfo(rect, op, d->state->matrix);
2810 d->state->clipEnabled = true;
2811 d->state->dirtyFlags |= QPaintEngine::DirtyClipRegion | QPaintEngine::DirtyClipEnabled;
2812 d->updateState(d->state);
2816 \fn void QPainter::setClipRect(int x, int y, int width, int height, Qt::ClipOperation operation)
2818 Enables clipping, and sets the clip region to the rectangle beginning at (\a x, \a y)
2819 with the given \a width and \a height.
2823 \fn void QPainter::setClipRegion(const QRegion ®ion, Qt::ClipOperation operation)
2825 Sets the clip region to the given \a region using the specified clip
2826 \a operation. The default clip operation is to replace the current
2829 Note that the clip region is given in logical coordinates.
2831 \sa clipRegion(), setClipRect(), {QPainter#Clipping}{Clipping}
2833 void QPainter::setClipRegion(const QRegion &r, Qt::ClipOperation op)
2836 #ifdef QT_DEBUG_DRAW
2837 QRect rect = r.boundingRect();
2838 if (qt_show_painter_debug_output)
2839 printf("QPainter::setClipRegion(), size=%d, [%d,%d,%d,%d]\n",
2840 r.rects().size(), rect.x(), rect.y(), rect.width(), rect.height());
2843 qWarning("QPainter::setClipRegion: Painter not active");
2847 if ((!d->state->clipEnabled && op != Qt::NoClip))
2848 op = Qt::ReplaceClip;
2851 d->state->clipEnabled = true;
2852 d->extended->clip(r, op);
2853 if (op == Qt::NoClip || op == Qt::ReplaceClip)
2854 d->state->clipInfo.clear();
2855 d->state->clipInfo << QPainterClipInfo(r, op, d->state->matrix);
2856 d->state->clipOperation = op;
2860 if (d->state->clipOperation == Qt::NoClip && op == Qt::IntersectClip)
2861 op = Qt::ReplaceClip;
2863 d->state->clipRegion = r;
2864 d->state->clipOperation = op;
2865 if (op == Qt::NoClip || op == Qt::ReplaceClip)
2866 d->state->clipInfo.clear();
2867 d->state->clipInfo << QPainterClipInfo(r, op, d->state->matrix);
2868 d->state->clipEnabled = true;
2869 d->state->dirtyFlags |= QPaintEngine::DirtyClipRegion | QPaintEngine::DirtyClipEnabled;
2870 d->updateState(d->state);
2877 Sets the transformation matrix to \a matrix and enables transformations.
2879 \note It is advisable to use setWorldTransform() instead of this function to
2880 preserve the properties of perspective transformations.
2882 If \a combine is true, then \a matrix is combined with the current
2883 transformation matrix; otherwise \a matrix replaces the current
2884 transformation matrix.
2886 If \a matrix is the identity matrix and \a combine is false, this
2887 function calls setWorldMatrixEnabled(false). (The identity matrix is the
2888 matrix where QMatrix::m11() and QMatrix::m22() are 1.0 and the
2891 The following functions can transform the coordinate system without using
2900 They operate on the painter's worldMatrix() and are implemented like this:
2902 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 4
2904 Note that when using setWorldMatrix() function you should always have
2905 \a combine be true when you are drawing into a QPicture. Otherwise
2906 it may not be possible to replay the picture with additional
2907 transformations; using the translate(), scale(), etc. convenience
2910 For more information about the coordinate system, transformations
2911 and window-viewport conversion, see \l {Coordinate System}.
2913 \sa setWorldTransform(), QTransform
2916 void QPainter::setWorldMatrix(const QMatrix &matrix, bool combine)
2918 setWorldTransform(QTransform(matrix), combine);
2925 Returns the world transformation matrix.
2927 It is advisable to use worldTransform() because worldMatrix() does not
2928 preserve the properties of perspective transformations.
2930 \sa {QPainter#Coordinate Transformations}{Coordinate Transformations},
2934 const QMatrix &QPainter::worldMatrix() const
2936 Q_D(const QPainter);
2938 qWarning("QPainter::worldMatrix: Painter not active");
2939 return d->fakeState()->transform.toAffine();
2941 return d->state->worldMatrix.toAffine();
2947 Use setWorldTransform() instead.
2949 \sa setWorldTransform()
2952 void QPainter::setMatrix(const QMatrix &matrix, bool combine)
2954 setWorldTransform(QTransform(matrix), combine);
2960 Use worldTransform() instead.
2962 \sa worldTransform()
2965 const QMatrix &QPainter::matrix() const
2967 return worldMatrix();
2975 Returns the transformation matrix combining the current
2976 window/viewport and world transformation.
2978 It is advisable to use combinedTransform() instead of this
2979 function to preserve the properties of perspective transformations.
2981 \sa setWorldTransform(), setWindow(), setViewport()
2983 QMatrix QPainter::combinedMatrix() const
2985 return combinedTransform().toAffine();
2992 Returns the matrix that transforms from logical coordinates to
2993 device coordinates of the platform dependent paint device.
2995 \note It is advisable to use deviceTransform() instead of this
2996 function to preserve the properties of perspective transformations.
2998 This function is \e only needed when using platform painting
2999 commands on the platform dependent handle (Qt::HANDLE), and the
3000 platform does not do transformations nativly.
3002 The QPaintEngine::PaintEngineFeature enum can be queried to
3003 determine whether the platform performs the transformations or
3006 \sa worldMatrix(), QPaintEngine::hasFeature(),
3008 const QMatrix &QPainter::deviceMatrix() const
3010 Q_D(const QPainter);
3012 qWarning("QPainter::deviceMatrix: Painter not active");
3013 return d->fakeState()->transform.toAffine();
3015 return d->state->matrix.toAffine();
3021 Resets any transformations that were made using translate(), scale(),
3022 shear(), rotate(), setWorldMatrix(), setViewport() and
3025 It is advisable to use resetTransform() instead of this function
3026 to preserve the properties of perspective transformations.
3028 \sa {QPainter#Coordinate Transformations}{Coordinate
3032 void QPainter::resetMatrix()
3041 Enables transformations if \a enable is true, or disables
3042 transformations if \a enable is false. The world transformation
3043 matrix is not changed.
3045 \sa worldMatrixEnabled(), worldTransform(), {QPainter#Coordinate
3046 Transformations}{Coordinate Transformations}
3049 void QPainter::setWorldMatrixEnabled(bool enable)
3052 #ifdef QT_DEBUG_DRAW
3053 if (qt_show_painter_debug_output)
3054 printf("QPainter::setMatrixEnabled(), enable=%d\n", enable);
3058 qWarning("QPainter::setMatrixEnabled: Painter not active");
3061 if (enable == d->state->WxF)
3064 d->state->WxF = enable;
3071 Returns true if world transformation is enabled; otherwise returns
3074 \sa setWorldMatrixEnabled(), worldTransform(), {Coordinate System}
3077 bool QPainter::worldMatrixEnabled() const
3079 Q_D(const QPainter);
3081 qWarning("QPainter::worldMatrixEnabled: Painter not active");
3084 return d->state->WxF;
3090 Use setWorldMatrixEnabled() instead.
3092 \sa setWorldMatrixEnabled()
3095 void QPainter::setMatrixEnabled(bool enable)
3097 setWorldMatrixEnabled(enable);
3103 Use worldMatrixEnabled() instead
3105 \sa worldMatrixEnabled()
3108 bool QPainter::matrixEnabled() const
3110 return worldMatrixEnabled();
3114 Scales the coordinate system by (\a{sx}, \a{sy}).
3116 \sa setWorldTransform() {QPainter#Coordinate Transformations}{Coordinate
3120 void QPainter::scale(qreal sx, qreal sy)
3122 #ifdef QT_DEBUG_DRAW
3123 if (qt_show_painter_debug_output)
3124 printf("QPainter::scale(), sx=%f, sy=%f\n", sx, sy);
3128 qWarning("QPainter::scale: Painter not active");
3132 d->state->worldMatrix.scale(sx,sy);
3133 d->state->WxF = true;
3138 Shears the coordinate system by (\a{sh}, \a{sv}).
3140 \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate
3144 void QPainter::shear(qreal sh, qreal sv)
3146 #ifdef QT_DEBUG_DRAW
3147 if (qt_show_painter_debug_output)
3148 printf("QPainter::shear(), sh=%f, sv=%f\n", sh, sv);
3152 qWarning("QPainter::shear: Painter not active");
3156 d->state->worldMatrix.shear(sh, sv);
3157 d->state->WxF = true;
3162 \fn void QPainter::rotate(qreal angle)
3164 Rotates the coordinate system the given \a angle clockwise.
3166 \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate
3170 void QPainter::rotate(qreal a)
3172 #ifdef QT_DEBUG_DRAW
3173 if (qt_show_painter_debug_output)
3174 printf("QPainter::rotate(), angle=%f\n", a);
3178 qWarning("QPainter::rotate: Painter not active");
3182 d->state->worldMatrix.rotate(a);
3183 d->state->WxF = true;
3188 Translates the coordinate system by the given \a offset; i.e. the
3189 given \a offset is added to points.
3191 \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate
3194 void QPainter::translate(const QPointF &offset)
3196 qreal dx = offset.x();
3197 qreal dy = offset.y();
3198 #ifdef QT_DEBUG_DRAW
3199 if (qt_show_painter_debug_output)
3200 printf("QPainter::translate(), dx=%f, dy=%f\n", dx, dy);
3204 qWarning("QPainter::translate: Painter not active");
3208 d->state->worldMatrix.translate(dx, dy);
3209 d->state->WxF = true;
3214 \fn void QPainter::translate(const QPoint &offset)
3217 Translates the coordinate system by the given \a offset.
3221 \fn void QPainter::translate(qreal dx, qreal dy)
3224 Translates the coordinate system by the vector (\a dx, \a dy).
3228 \fn void QPainter::setClipPath(const QPainterPath &path, Qt::ClipOperation operation)
3230 Enables clipping, and sets the clip path for the painter to the
3231 given \a path, with the clip \a operation.
3233 Note that the clip path is specified in logical (painter)
3236 \sa clipPath(), clipRegion(), {QPainter#Clipping}{Clipping}
3239 void QPainter::setClipPath(const QPainterPath &path, Qt::ClipOperation op)
3241 #ifdef QT_DEBUG_DRAW
3242 if (qt_show_painter_debug_output) {
3243 QRectF b = path.boundingRect();
3244 printf("QPainter::setClipPath(), size=%d, op=%d, bounds=[%.2f,%.2f,%.2f,%.2f]\n",
3245 path.elementCount(), op, b.x(), b.y(), b.width(), b.height());
3251 qWarning("QPainter::setClipPath: Painter not active");
3255 if ((!d->state->clipEnabled && op != Qt::NoClip))
3256 op = Qt::ReplaceClip;
3259 d->state->clipEnabled = true;
3260 d->extended->clip(path, op);
3261 if (op == Qt::NoClip || op == Qt::ReplaceClip)
3262 d->state->clipInfo.clear();
3263 d->state->clipInfo << QPainterClipInfo(path, op, d->state->matrix);
3264 d->state->clipOperation = op;
3268 if (d->state->clipOperation == Qt::NoClip && op == Qt::IntersectClip)
3269 op = Qt::ReplaceClip;
3271 d->state->clipPath = path;
3272 d->state->clipOperation = op;
3273 if (op == Qt::NoClip || op == Qt::ReplaceClip)
3274 d->state->clipInfo.clear();
3275 d->state->clipInfo << QPainterClipInfo(path, op, d->state->matrix);
3276 d->state->clipEnabled = true;
3277 d->state->dirtyFlags |= QPaintEngine::DirtyClipPath | QPaintEngine::DirtyClipEnabled;
3278 d->updateState(d->state);
3282 Draws the outline (strokes) the path \a path with the pen specified
3285 \sa fillPath(), {QPainter#Drawing}{Drawing}
3287 void QPainter::strokePath(const QPainterPath &path, const QPen &pen)
3292 qWarning("QPainter::strokePath: Painter not active");
3300 const QGradient *g = qpen_brush(pen).gradient();
3301 if (!g || g->coordinateMode() == QGradient::LogicalMode) {
3302 d->extended->stroke(qtVectorPathForPath(path), pen);
3307 QBrush oldBrush = d->state->brush;
3308 QPen oldPen = d->state->pen;
3311 setBrush(Qt::NoBrush);
3321 Fills the given \a path using the given \a brush. The outline is
3324 Alternatively, you can specify a QColor instead of a QBrush; the
3325 QBrush constructor (taking a QColor argument) will automatically
3326 create a solid pattern brush.
3330 void QPainter::fillPath(const QPainterPath &path, const QBrush &brush)
3335 qWarning("QPainter::fillPath: Painter not active");
3343 const QGradient *g = brush.gradient();
3344 if (!g || g->coordinateMode() == QGradient::LogicalMode) {
3345 d->extended->fill(qtVectorPathForPath(path), brush);
3350 QBrush oldBrush = d->state->brush;
3351 QPen oldPen = d->state->pen;
3364 Draws the given painter \a path using the current pen for outline
3365 and the current brush for filling.
3369 \o \inlineimage qpainter-path.png
3371 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 5
3374 \sa {painting/painterpaths}{the Painter Paths
3375 example},{painting/deform}{the Vector Deformation example}
3377 void QPainter::drawPath(const QPainterPath &path)
3379 #ifdef QT_DEBUG_DRAW
3380 QRectF pathBounds = path.boundingRect();
3381 if (qt_show_painter_debug_output)
3382 printf("QPainter::drawPath(), size=%d, [%.2f,%.2f,%.2f,%.2f]\n",
3383 path.elementCount(),
3384 pathBounds.x(), pathBounds.y(), pathBounds.width(), pathBounds.height());
3390 qWarning("QPainter::drawPath: Painter not active");
3395 d->extended->drawPath(path);
3398 d->updateState(d->state);
3400 if (d->engine->hasFeature(QPaintEngine::PainterPaths) && d->state->emulationSpecifier == 0) {
3401 d->engine->drawPath(path);
3403 d->draw_helper(path);
3408 \fn void QPainter::drawLine(const QLineF &line)
3410 Draws a line defined by \a line.
3414 \o \inlineimage qpainter-line.png
3416 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 6
3419 \sa drawLines(), drawPolyline(), {Coordinate System}
3423 \fn void QPainter::drawLine(const QLine &line)
3426 Draws a line defined by \a line.
3430 \fn void QPainter::drawLine(const QPoint &p1, const QPoint &p2)
3433 Draws a line from \a p1 to \a p2.
3437 \fn void QPainter::drawLine(const QPointF &p1, const QPointF &p2)
3440 Draws a line from \a p1 to \a p2.
3444 \fn void QPainter::drawLine(int x1, int y1, int x2, int y2)
3447 Draws a line from (\a x1, \a y1) to (\a x2, \a y2) and sets the
3448 current pen position to (\a x2, \a y2).
3452 \fn void QPainter::drawRect(const QRectF &rectangle)
3454 Draws the current \a rectangle with the current pen and brush.
3456 A filled rectangle has a size of \a{rectangle}.size(). A stroked
3457 rectangle has a size of \a{rectangle}.size() plus the pen width.
3461 \o \inlineimage qpainter-rectangle.png
3463 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 7
3466 \sa drawRects(), drawPolygon(), {Coordinate System}
3470 \fn void QPainter::drawRect(const QRect &rectangle)
3474 Draws the current \a rectangle with the current pen and brush.
3478 \fn void QPainter::drawRect(int x, int y, int width, int height)
3482 Draws a rectangle with upper left corner at (\a{x}, \a{y}) and
3483 with the given \a width and \a height.
3487 \fn void QPainter::drawRects(const QRectF *rectangles, int rectCount)
3489 Draws the first \a rectCount of the given \a rectangles using the
3490 current pen and brush.
3494 void QPainter::drawRects(const QRectF *rects, int rectCount)
3496 #ifdef QT_DEBUG_DRAW
3497 if (qt_show_painter_debug_output)
3498 printf("QPainter::drawRects(), count=%d\n", rectCount);
3503 qWarning("QPainter::drawRects: Painter not active");
3511 d->extended->drawRects(rects, rectCount);
3515 d->updateState(d->state);
3517 if (!d->state->emulationSpecifier) {
3518 d->engine->drawRects(rects, rectCount);
3522 if (d->state->emulationSpecifier == QPaintEngine::PrimitiveTransform
3523 && d->state->matrix.type() == QTransform::TxTranslate) {
3524 for (int i=0; i<rectCount; ++i) {
3525 QRectF r(rects[i].x() + d->state->matrix.dx(),
3526 rects[i].y() + d->state->matrix.dy(),
3529 d->engine->drawRects(&r, 1);
3532 if (d->state->brushNeedsResolving() || d->state->penNeedsResolving()) {
3533 for (int i=0; i<rectCount; ++i) {
3534 QPainterPath rectPath;
3535 rectPath.addRect(rects[i]);
3536 d->draw_helper(rectPath, QPainterPrivate::StrokeAndFillDraw);
3539 QPainterPath rectPath;
3540 for (int i=0; i<rectCount; ++i)
3541 rectPath.addRect(rects[i]);
3542 d->draw_helper(rectPath, QPainterPrivate::StrokeAndFillDraw);
3548 \fn void QPainter::drawRects(const QRect *rectangles, int rectCount)
3551 Draws the first \a rectCount of the given \a rectangles using the
3552 current pen and brush.
3554 void QPainter::drawRects(const QRect *rects, int rectCount)
3556 #ifdef QT_DEBUG_DRAW
3557 if (qt_show_painter_debug_output)
3558 printf("QPainter::drawRects(), count=%d\n", rectCount);
3563 qWarning("QPainter::drawRects: Painter not active");
3571 d->extended->drawRects(rects, rectCount);
3575 d->updateState(d->state);
3577 if (!d->state->emulationSpecifier) {
3578 d->engine->drawRects(rects, rectCount);
3582 if (d->state->emulationSpecifier == QPaintEngine::PrimitiveTransform
3583 && d->state->matrix.type() == QTransform::TxTranslate) {
3584 for (int i=0; i<rectCount; ++i) {
3585 QRectF r(rects[i].x() + d->state->matrix.dx(),
3586 rects[i].y() + d->state->matrix.dy(),
3590 d->engine->drawRects(&r, 1);
3593 if (d->state->brushNeedsResolving() || d->state->penNeedsResolving()) {
3594 for (int i=0; i<rectCount; ++i) {
3595 QPainterPath rectPath;
3596 rectPath.addRect(rects[i]);
3597 d->draw_helper(rectPath, QPainterPrivate::StrokeAndFillDraw);
3600 QPainterPath rectPath;
3601 for (int i=0; i<rectCount; ++i)
3602 rectPath.addRect(rects[i]);
3604 d->draw_helper(rectPath, QPainterPrivate::StrokeAndFillDraw);
3610 \fn void QPainter::drawRects(const QVector<QRectF> &rectangles)
3613 Draws the given \a rectangles using the current pen and brush.
3617 \fn void QPainter::drawRects(const QVector<QRect> &rectangles)
3621 Draws the given \a rectangles using the current pen and brush.
3625 \fn void QPainter::drawPoint(const QPointF &position)
3627 Draws a single point at the given \a position using the current
3630 \sa {Coordinate System}
3634 \fn void QPainter::drawPoint(const QPoint &position)
3637 Draws a single point at the given \a position using the current
3641 /*! \fn void QPainter::drawPoint(int x, int y)
3645 Draws a single point at position (\a x, \a y).
3649 Draws the first \a pointCount points in the array \a points using
3650 the current pen's color.
3652 \sa {Coordinate System}
3654 void QPainter::drawPoints(const QPointF *points, int pointCount)
3656 #ifdef QT_DEBUG_DRAW
3657 if (qt_show_painter_debug_output)
3658 printf("QPainter::drawPoints(), count=%d\n", pointCount);
3663 qWarning("QPainter::drawPoints: Painter not active");
3667 if (pointCount <= 0)
3671 d->extended->drawPoints(points, pointCount);
3675 d->updateState(d->state);
3677 if (!d->state->emulationSpecifier) {
3678 d->engine->drawPoints(points, pointCount);
3682 if (d->state->emulationSpecifier == QPaintEngine::PrimitiveTransform
3683 && d->state->matrix.type() == QTransform::TxTranslate) {
3684 // ### use drawPoints function
3685 for (int i=0; i<pointCount; ++i) {
3686 QPointF pt(points[i].x() + d->state->matrix.dx(),
3687 points[i].y() + d->state->matrix.dy());
3688 d->engine->drawPoints(&pt, 1);
3691 QPen pen = d->state->pen;
3692 bool flat_pen = pen.capStyle() == Qt::FlatCap;
3695 pen.setCapStyle(Qt::SquareCap);
3699 for (int i=0; i<pointCount; ++i) {
3700 path.moveTo(points[i].x(), points[i].y());
3701 path.lineTo(points[i].x() + 0.0001, points[i].y());
3703 d->draw_helper(path, QPainterPrivate::StrokeDraw);
3712 Draws the first \a pointCount points in the array \a points using
3713 the current pen's color.
3716 void QPainter::drawPoints(const QPoint *points, int pointCount)
3718 #ifdef QT_DEBUG_DRAW
3719 if (qt_show_painter_debug_output)
3720 printf("QPainter::drawPoints(), count=%d\n", pointCount);
3725 qWarning("QPainter::drawPoints: Painter not active");
3729 if (pointCount <= 0)
3733 d->extended->drawPoints(points, pointCount);
3737 d->updateState(d->state);
3739 if (!d->state->emulationSpecifier) {
3740 d->engine->drawPoints(points, pointCount);
3744 if (d->state->emulationSpecifier == QPaintEngine::PrimitiveTransform
3745 && d->state->matrix.type() == QTransform::TxTranslate) {
3746 // ### use drawPoints function
3747 for (int i=0; i<pointCount; ++i) {
3748 QPointF pt(points[i].x() + d->state->matrix.dx(),
3749 points[i].y() + d->state->matrix.dy());
3750 d->engine->drawPoints(&pt, 1);
3753 QPen pen = d->state->pen;
3754 bool flat_pen = (pen.capStyle() == Qt::FlatCap);
3757 pen.setCapStyle(Qt::SquareCap);
3761 for (int i=0; i<pointCount; ++i) {
3762 path.moveTo(points[i].x(), points[i].y());
3763 path.lineTo(points[i].x() + 0.0001, points[i].y());
3765 d->draw_helper(path, QPainterPrivate::StrokeDraw);
3772 \fn void QPainter::drawPoints(const QPolygonF &points)
3776 Draws the points in the vector \a points.
3780 \fn void QPainter::drawPoints(const QPolygon &points)
3784 Draws the points in the vector \a points.
3788 Sets the background mode of the painter to the given \a mode
3790 Qt::TransparentMode (the default) draws stippled lines and text
3791 without setting the background pixels. Qt::OpaqueMode fills these
3792 space with the current background color.
3794 Note that in order to draw a bitmap or pixmap transparently, you
3795 must use QPixmap::setMask().
3797 \sa backgroundMode(), setBackground(),
3798 {QPainter#Settings}{Settings}
3801 void QPainter::setBackgroundMode(Qt::BGMode mode)
3803 #ifdef QT_DEBUG_DRAW
3804 if (qt_show_painter_debug_output)
3805 printf("QPainter::setBackgroundMode(), mode=%d\n", mode);
3810 qWarning("QPainter::setBackgroundMode: Painter not active");
3813 if (d->state->bgMode == mode)
3816 d->state->bgMode = mode;
3818 d->checkEmulation();
3820 d->state->dirtyFlags |= QPaintEngine::DirtyBackgroundMode;
3825 Returns the current background mode.
3827 \sa setBackgroundMode(), {QPainter#Settings}{Settings}
3829 Qt::BGMode QPainter::backgroundMode() const
3831 Q_D(const QPainter);
3833 qWarning("QPainter::backgroundMode: Painter not active");
3834 return Qt::TransparentMode;
3836 return d->state->bgMode;
3843 Sets the painter's pen to have style Qt::SolidLine, width 0 and the
3847 void QPainter::setPen(const QColor &color)
3849 #ifdef QT_DEBUG_DRAW
3850 if (qt_show_painter_debug_output)
3851 printf("QPainter::setPen(), color=%04x\n", color.rgb());
3855 qWarning("QPainter::setPen: Painter not active");
3859 if (d->state->pen.style() == Qt::SolidLine
3860 && d->state->pen.widthF() == 0
3861 && d->state->pen.isSolid()
3862 && d->state->pen.color() == color)
3865 QPen pen(color.isValid() ? color : QColor(Qt::black), 0, Qt::SolidLine);
3867 d->state->pen = pen;
3869 d->extended->penChanged();
3871 d->state->dirtyFlags |= QPaintEngine::DirtyPen;
3875 Sets the painter's pen to be the given \a pen.
3877 The \a pen defines how to draw lines and outlines, and it also
3878 defines the text color.
3880 \sa pen(), {QPainter#Settings}{Settings}
3883 void QPainter::setPen(const QPen &pen)
3886 #ifdef QT_DEBUG_DRAW
3887 if (qt_show_painter_debug_output)
3888 printf("QPainter::setPen(), color=%04x, (brushStyle=%d) style=%d, cap=%d, join=%d\n",
3889 pen.color().rgb(), pen.brush().style(), pen.style(), pen.capStyle(), pen.joinStyle());
3893 qWarning("QPainter::setPen: Painter not active");
3897 if (d->state->pen == pen)
3900 d->state->pen = pen;
3903 d->checkEmulation();
3904 d->extended->penChanged();
3908 d->state->dirtyFlags |= QPaintEngine::DirtyPen;
3914 Sets the painter's pen to have the given \a style, width 0 and
3918 void QPainter::setPen(Qt::PenStyle style)
3922 qWarning("QPainter::setPen: Painter not active");
3926 if (d->state->pen.style() == style
3927 && (style == Qt::NoPen || (d->state->pen.widthF() == 0
3928 && d->state->pen.isSolid()
3929 && d->state->pen.color() == QColor(Qt::black))))
3932 // QPen(Qt::NoPen) is to avoid creating QPenData, including its brush (from the color)
3933 // Note that this works well as long as QPen(Qt::NoPen) returns a black, zero-width pen
3934 d->state->pen = (style == Qt::NoPen) ? QPen(Qt::NoPen) : QPen(Qt::black, 0, style);
3937 d->extended->penChanged();
3939 d->state->dirtyFlags |= QPaintEngine::DirtyPen;
3944 Returns the painter's current pen.
3946 \sa setPen(), {QPainter#Settings}{Settings}
3949 const QPen &QPainter::pen() const
3951 Q_D(const QPainter);
3953 qWarning("QPainter::pen: Painter not active");
3954 return d->fakeState()->pen;
3956 return d->state->pen;
3961 Sets the painter's brush to the given \a brush.
3963 The painter's brush defines how shapes are filled.
3965 \sa brush(), {QPainter#Settings}{Settings}
3968 void QPainter::setBrush(const QBrush &brush)
3970 #ifdef QT_DEBUG_DRAW
3971 if (qt_show_painter_debug_output)
3972 printf("QPainter::setBrush(), color=%04x, style=%d\n", brush.color().rgb(), brush.style());
3976 qWarning("QPainter::setBrush: Painter not active");
3980 if (d->state->brush.d == brush.d)
3984 d->state->brush = brush;
3985 d->checkEmulation();
3986 d->extended->brushChanged();
3990 d->state->brush = brush;
3991 d->state->dirtyFlags |= QPaintEngine::DirtyBrush;
3998 Sets the painter's brush to black color and the specified \a
4002 void QPainter::setBrush(Qt::BrushStyle style)
4006 qWarning("QPainter::setBrush: Painter not active");
4009 if (d->state->brush.style() == style &&
4010 (style == Qt::NoBrush
4011 || (style == Qt::SolidPattern && d->state->brush.color() == QColor(0, 0, 0))))
4013 d->state->brush = QBrush(Qt::black, style);
4015 d->extended->brushChanged();
4017 d->state->dirtyFlags |= QPaintEngine::DirtyBrush;
4021 Returns the painter's current brush.
4023 \sa QPainter::setBrush(), {QPainter#Settings}{Settings}
4026 const QBrush &QPainter::brush() const
4028 Q_D(const QPainter);
4030 qWarning("QPainter::brush: Painter not active");
4031 return d->fakeState()->brush;
4033 return d->state->brush;
4037 \fn void QPainter::setBackground(const QBrush &brush)
4039 Sets the background brush of the painter to the given \a brush.
4041 The background brush is the brush that is filled in when drawing
4042 opaque text, stippled lines and bitmaps. The background brush has
4043 no effect in transparent background mode (which is the default).
4045 \sa background(), setBackgroundMode(),
4046 {QPainter#Settings}{Settings}
4049 void QPainter::setBackground(const QBrush &bg)
4051 #ifdef QT_DEBUG_DRAW
4052 if (qt_show_painter_debug_output)
4053 printf("QPainter::setBackground(), color=%04x, style=%d\n", bg.color().rgb(), bg.style());
4058 qWarning("QPainter::setBackground: Painter not active");
4061 d->state->bgBrush = bg;
4063 d->state->dirtyFlags |= QPaintEngine::DirtyBackground;
4067 Sets the painter's font to the given \a font.
4069 This font is used by subsequent drawText() functions. The text
4070 color is the same as the pen color.
4072 If you set a font that isn't available, Qt finds a close match.
4073 font() will return what you set using setFont() and fontInfo() returns the
4074 font actually being used (which may be the same).
4076 \sa font(), drawText(), {QPainter#Settings}{Settings}
4079 void QPainter::setFont(const QFont &font)
4083 #ifdef QT_DEBUG_DRAW
4084 if (qt_show_painter_debug_output)
4085 printf("QPainter::setFont(), family=%s, pointSize=%d\n", font.family().toLatin1().constData(), font.pointSize());
4089 qWarning("QPainter::setFont: Painter not active");
4093 d->state->font = QFont(font.resolve(d->state->deviceFont), device());
4095 d->state->dirtyFlags |= QPaintEngine::DirtyFont;
4099 Returns the currently set font used for drawing text.
4101 \sa setFont(), drawText(), {QPainter#Settings}{Settings}
4103 const QFont &QPainter::font() const
4105 Q_D(const QPainter);
4107 qWarning("QPainter::font: Painter not active");
4108 return d->fakeState()->font;
4110 return d->state->font;
4116 Draws the given rectangle \a rect with rounded corners.
4118 The \a xRadius and \a yRadius arguments specify the radii
4119 of the ellipses defining the corners of the rounded rectangle.
4120 When \a mode is Qt::RelativeSize, \a xRadius and
4121 \a yRadius are specified in percentage of half the rectangle's
4122 width and height respectively, and should be in the range
4125 A filled rectangle has a size of rect.size(). A stroked rectangle
4126 has a size of rect.size() plus the pen width.
4130 \o \inlineimage qpainter-roundrect.png
4132 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 8
4135 \sa drawRect(), QPen
4137 void QPainter::drawRoundedRect(const QRectF &rect, qreal xRadius, qreal yRadius, Qt::SizeMode mode)
4139 #ifdef QT_DEBUG_DRAW
4140 if (qt_show_painter_debug_output)
4141 printf("QPainter::drawRoundedRect(), [%.2f,%.2f,%.2f,%.2f]\n", rect.x(), rect.y(), rect.width(), rect.height());
4148 if (xRadius <= 0 || yRadius <= 0) { // draw normal rectangle
4154 d->extended->drawRoundedRect(rect, xRadius, yRadius, mode);
4159 path.addRoundedRect(rect, xRadius, yRadius, mode);
4164 \fn void QPainter::drawRoundedRect(const QRect &rect, qreal xRadius, qreal yRadius,
4165 Qt::SizeMode mode = Qt::AbsoluteSize);
4169 Draws the given rectangle \a rect with rounded corners.
4173 \fn void QPainter::drawRoundedRect(int x, int y, int w, int h, qreal xRadius, qreal yRadius,
4174 Qt::SizeMode mode = Qt::AbsoluteSize);
4178 Draws the given rectangle \a x, \a y, \a w, \a h with rounded corners.
4184 Draws a rectangle \a r with rounded corners.
4186 The \a xRnd and \a yRnd arguments specify how rounded the corners
4187 should be. 0 is angled corners, 99 is maximum roundedness.
4189 A filled rectangle has a size of r.size(). A stroked rectangle
4190 has a size of r.size() plus the pen width.
4192 \sa drawRoundedRect()
4194 void QPainter::drawRoundRect(const QRectF &r, int xRnd, int yRnd)
4196 drawRoundedRect(r, xRnd, yRnd, Qt::RelativeSize);
4201 \fn void QPainter::drawRoundRect(const QRect &r, int xRnd = 25, int yRnd = 25)
4206 Draws the rectangle \a r with rounded corners.
4212 \fn QPainter::drawRoundRect(int x, int y, int w, int h, int xRnd, int yRnd)
4216 Draws the rectangle \a x, \a y, \a w, \a h with rounded corners.
4220 \fn void QPainter::drawEllipse(const QRectF &rectangle)
4222 Draws the ellipse defined by the given \a rectangle.
4224 A filled ellipse has a size of \a{rectangle}.\l
4225 {QRect::size()}{size()}. A stroked ellipse has a size of
4226 \a{rectangle}.\l {QRect::size()}{size()} plus the pen width.
4230 \o \inlineimage qpainter-ellipse.png
4232 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 9
4235 \sa drawPie(), {Coordinate System}
4237 void QPainter::drawEllipse(const QRectF &r)
4239 #ifdef QT_DEBUG_DRAW
4240 if (qt_show_painter_debug_output)
4241 printf("QPainter::drawEllipse(), [%.2f,%.2f,%.2f,%.2f]\n", r.x(), r.y(), r.width(), r.height());
4248 QRectF rect(r.normalized());
4251 d->extended->drawEllipse(rect);
4255 d->updateState(d->state);
4256 if (d->state->emulationSpecifier) {
4257 if (d->state->emulationSpecifier == QPaintEngine::PrimitiveTransform
4258 && d->state->matrix.type() == QTransform::TxTranslate) {
4259 rect.translate(QPointF(d->state->matrix.dx(), d->state->matrix.dy()));
4262 path.addEllipse(rect);
4263 d->draw_helper(path, QPainterPrivate::StrokeAndFillDraw);
4268 d->engine->drawEllipse(rect);
4272 \fn QPainter::drawEllipse(const QRect &rectangle)
4276 Draws the ellipse defined by the given \a rectangle.
4278 void QPainter::drawEllipse(const QRect &r)
4280 #ifdef QT_DEBUG_DRAW
4281 if (qt_show_painter_debug_output)
4282 printf("QPainter::drawEllipse(), [%d,%d,%d,%d]\n", r.x(), r.y(), r.width(), r.height());
4289 QRect rect(r.normalized());
4292 d->extended->drawEllipse(rect);
4296 d->updateState(d->state);
4298 if (d->state->emulationSpecifier) {
4299 if (d->state->emulationSpecifier == QPaintEngine::PrimitiveTransform
4300 && d->state->matrix.type() == QTransform::TxTranslate) {
4301 rect.translate(QPoint(qRound(d->state->matrix.dx()), qRound(d->state->matrix.dy())));
4304 path.addEllipse(rect);
4305 d->draw_helper(path, QPainterPrivate::StrokeAndFillDraw);
4310 d->engine->drawEllipse(rect);
4314 \fn QPainter::drawEllipse(int x, int y, int width, int height)
4318 Draws the ellipse defined by the rectangle beginning at (\a{x},
4319 \a{y}) with the given \a width and \a height.
4325 \fn QPainter::drawEllipse(const QPointF ¢er, qreal rx, qreal ry)
4329 Draws the ellipse positioned at \a{center} with radii \a{rx} and \a{ry}.
4335 \fn QPainter::drawEllipse(const QPoint ¢er, int rx, int ry)
4339 Draws the ellipse positioned at \a{center} with radii \a{rx} and \a{ry}.
4343 \fn void QPainter::drawArc(const QRectF &rectangle, int startAngle, int spanAngle)
4345 Draws the arc defined by the given \a rectangle, \a startAngle and
4348 The \a startAngle and \a spanAngle must be specified in 1/16th of
4349 a degree, i.e. a full circle equals 5760 (16 * 360). Positive
4350 values for the angles mean counter-clockwise while negative values
4351 mean the clockwise direction. Zero degrees is at the 3 o'clock
4356 \o \inlineimage qpainter-arc.png
4358 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 10
4361 \sa drawPie(), drawChord(), {Coordinate System}
4364 void QPainter::drawArc(const QRectF &r, int a, int alen)
4366 #ifdef QT_DEBUG_DRAW
4367 if (qt_show_painter_debug_output)
4368 printf("QPainter::drawArc(), [%.2f,%.2f,%.2f,%.2f], angle=%d, sweep=%d\n",
4369 r.x(), r.y(), r.width(), r.height(), a/16, alen/16);
4376 QRectF rect = r.normalized();
4379 path.arcMoveTo(rect, a/16.0);
4380 path.arcTo(rect, a/16.0, alen/16.0);
4381 strokePath(path, d->state->pen);
4384 /*! \fn void QPainter::drawArc(const QRect &rectangle, int startAngle,
4389 Draws the arc defined by the given \a rectangle, \a startAngle and
4394 \fn void QPainter::drawArc(int x, int y, int width, int height,
4395 int startAngle, int spanAngle)
4399 Draws the arc defined by the rectangle beginning at (\a x, \a y)
4400 with the specified \a width and \a height, and the given \a
4401 startAngle and \a spanAngle.
4405 \fn void QPainter::drawPie(const QRectF &rectangle, int startAngle, int spanAngle)
4407 Draws a pie defined by the given \a rectangle, \a startAngle and
4410 The pie is filled with the current brush().
4412 The startAngle and spanAngle must be specified in 1/16th of a
4413 degree, i.e. a full circle equals 5760 (16 * 360). Positive values
4414 for the angles mean counter-clockwise while negative values mean
4415 the clockwise direction. Zero degrees is at the 3 o'clock
4420 \o \inlineimage qpainter-pie.png
4422 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 11
4425 \sa drawEllipse(), drawChord(), {Coordinate System}
4427 void QPainter::drawPie(const QRectF &r, int a, int alen)
4429 #ifdef QT_DEBUG_DRAW
4430 if (qt_show_painter_debug_output)
4431 printf("QPainter::drawPie(), [%.2f,%.2f,%.2f,%.2f], angle=%d, sweep=%d\n",
4432 r.x(), r.y(), r.width(), r.height(), a/16, alen/16);
4443 if (a < 0) a += (360*16);
4446 QRectF rect = r.normalized();
4449 path.moveTo(rect.center());
4450 path.arcTo(rect.x(), rect.y(), rect.width(), rect.height(), a/16.0, alen/16.0);
4451 path.closeSubpath();
4457 \fn void QPainter::drawPie(const QRect &rectangle, int startAngle, int spanAngle)
4460 Draws a pie defined by the given \a rectangle, \a startAngle and
4465 \fn void QPainter::drawPie(int x, int y, int width, int height, int
4466 startAngle, int spanAngle)
4470 Draws the pie defined by the rectangle beginning at (\a x, \a y) with
4471 the specified \a width and \a height, and the given \a startAngle and
4476 \fn void QPainter::drawChord(const QRectF &rectangle, int startAngle, int spanAngle)
4478 Draws the chord defined by the given \a rectangle, \a startAngle and
4479 \a spanAngle. The chord is filled with the current brush().
4481 The startAngle and spanAngle must be specified in 1/16th of a
4482 degree, i.e. a full circle equals 5760 (16 * 360). Positive values
4483 for the angles mean counter-clockwise while negative values mean
4484 the clockwise direction. Zero degrees is at the 3 o'clock
4489 \o \inlineimage qpainter-chord.png
4491 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 12
4494 \sa drawArc(), drawPie(), {Coordinate System}
4496 void QPainter::drawChord(const QRectF &r, int a, int alen)
4498 #ifdef QT_DEBUG_DRAW
4499 if (qt_show_painter_debug_output)
4500 printf("QPainter::drawChord(), [%.2f,%.2f,%.2f,%.2f], angle=%d, sweep=%d\n",
4501 r.x(), r.y(), r.width(), r.height(), a/16, alen/16);
4508 QRectF rect = r.normalized();
4511 path.arcMoveTo(rect, a/16.0);
4512 path.arcTo(rect, a/16.0, alen/16.0);
4513 path.closeSubpath();
4517 \fn void QPainter::drawChord(const QRect &rectangle, int startAngle, int spanAngle)
4521 Draws the chord defined by the given \a rectangle, \a startAngle and
4526 \fn void QPainter::drawChord(int x, int y, int width, int height, int
4527 startAngle, int spanAngle)
4531 Draws the chord defined by the rectangle beginning at (\a x, \a y)
4532 with the specified \a width and \a height, and the given \a
4533 startAngle and \a spanAngle.
4538 Draws the first \a lineCount lines in the array \a lines
4539 using the current pen.
4541 \sa drawLine(), drawPolyline()
4543 void QPainter::drawLines(const QLineF *lines, int lineCount)
4545 #ifdef QT_DEBUG_DRAW
4546 if (qt_show_painter_debug_output)
4547 printf("QPainter::drawLines(), line count=%d\n", lineCount);
4552 if (!d->engine || lineCount < 1)
4556 d->extended->drawLines(lines, lineCount);
4560 d->updateState(d->state);
4562 uint lineEmulation = line_emulation(d->state->emulationSpecifier);
4564 if (lineEmulation) {
4565 if (lineEmulation == QPaintEngine::PrimitiveTransform
4566 && d->state->matrix.type() == QTransform::TxTranslate) {
4567 for (int i = 0; i < lineCount; ++i) {
4568 QLineF line = lines[i];
4569 line.translate(d->state->matrix.dx(), d->state->matrix.dy());
4570 d->engine->drawLines(&line, 1);
4573 QPainterPath linePath;
4574 for (int i = 0; i < lineCount; ++i) {
4575 linePath.moveTo(lines[i].p1());
4576 linePath.lineTo(lines[i].p2());
4578 d->draw_helper(linePath, QPainterPrivate::StrokeDraw);
4582 d->engine->drawLines(lines, lineCount);
4586 \fn void QPainter::drawLines(const QLine *lines, int lineCount)
4589 Draws the first \a lineCount lines in the array \a lines
4590 using the current pen.
4592 void QPainter::drawLines(const QLine *lines, int lineCount)
4594 #ifdef QT_DEBUG_DRAW
4595 if (qt_show_painter_debug_output)
4596 printf("QPainter::drawLine(), line count=%d\n", lineCount);
4601 if (!d->engine || lineCount < 1)
4605 d->extended->drawLines(lines, lineCount);
4609 d->updateState(d->state);
4611 uint lineEmulation = line_emulation(d->state->emulationSpecifier);
4613 if (lineEmulation) {
4614 if (lineEmulation == QPaintEngine::PrimitiveTransform
4615 && d->state->matrix.type() == QTransform::TxTranslate) {
4616 for (int i = 0; i < lineCount; ++i) {
4617 QLineF line = lines[i];
4618 line.translate(d->state->matrix.dx(), d->state->matrix.dy());
4619 d->engine->drawLines(&line, 1);
4622 QPainterPath linePath;
4623 for (int i = 0; i < lineCount; ++i) {
4624 linePath.moveTo(lines[i].p1());
4625 linePath.lineTo(lines[i].p2());
4627 d->draw_helper(linePath, QPainterPrivate::StrokeDraw);
4631 d->engine->drawLines(lines, lineCount);
4637 Draws the first \a lineCount lines in the array \a pointPairs
4638 using the current pen. The lines are specified as pairs of points
4639 so the number of entries in \a pointPairs must be at least \a
4642 void QPainter::drawLines(const QPointF *pointPairs, int lineCount)
4644 Q_ASSERT(sizeof(QLineF) == 2*sizeof(QPointF));
4646 drawLines((QLineF*)pointPairs, lineCount);
4652 Draws the first \a lineCount lines in the array \a pointPairs
4653 using the current pen.
4655 void QPainter::drawLines(const QPoint *pointPairs, int lineCount)
4657 Q_ASSERT(sizeof(QLine) == 2*sizeof(QPoint));
4659 drawLines((QLine*)pointPairs, lineCount);
4664 \fn void QPainter::drawLines(const QVector<QPointF> &pointPairs)
4667 Draws a line for each pair of points in the vector \a pointPairs
4668 using the current pen. If there is an odd number of points in the
4669 array, the last point will be ignored.
4673 \fn void QPainter::drawLines(const QVector<QPoint> &pointPairs)
4676 Draws a line for each pair of points in the vector \a pointPairs
4677 using the current pen.
4681 \fn void QPainter::drawLines(const QVector<QLineF> &lines)
4684 Draws the set of lines defined by the list \a lines using the
4685 current pen and brush.
4689 \fn void QPainter::drawLines(const QVector<QLine> &lines)
4692 Draws the set of lines defined by the list \a lines using the
4693 current pen and brush.
4697 Draws the polyline defined by the first \a pointCount points in \a
4698 points using the current pen.
4700 Note that unlike the drawPolygon() function the last point is \e
4701 not connected to the first, neither is the polyline filled.
4706 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 13
4709 \sa drawLines(), drawPolygon(), {Coordinate System}
4711 void QPainter::drawPolyline(const QPointF *points, int pointCount)
4713 #ifdef QT_DEBUG_DRAW
4714 if (qt_show_painter_debug_output)
4715 printf("QPainter::drawPolyline(), count=%d\n", pointCount);
4719 if (!d->engine || pointCount < 2)
4723 d->extended->drawPolygon(points, pointCount, QPaintEngine::PolylineMode);
4727 d->updateState(d->state);
4729 uint lineEmulation = line_emulation(d->state->emulationSpecifier);
4731 if (lineEmulation) {
4733 // if (lineEmulation == QPaintEngine::PrimitiveTransform
4734 // && d->state->matrix.type() == QTransform::TxTranslate) {
4736 QPainterPath polylinePath(points[0]);
4737 for (int i=1; i<pointCount; ++i)
4738 polylinePath.lineTo(points[i]);
4739 d->draw_helper(polylinePath, QPainterPrivate::StrokeDraw);
4742 d->engine->drawPolygon(points, pointCount, QPaintEngine::PolylineMode);
4749 Draws the polyline defined by the first \a pointCount points in \a
4750 points using the current pen.
4752 void QPainter::drawPolyline(const QPoint *points, int pointCount)
4754 #ifdef QT_DEBUG_DRAW
4755 if (qt_show_painter_debug_output)
4756 printf("QPainter::drawPolyline(), count=%d\n", pointCount);
4760 if (!d->engine || pointCount < 2)
4764 d->extended->drawPolygon(points, pointCount, QPaintEngine::PolylineMode);
4768 d->updateState(d->state);
4770 uint lineEmulation = line_emulation(d->state->emulationSpecifier);
4772 if (lineEmulation) {
4774 // if (lineEmulation == QPaintEngine::PrimitiveTransform
4775 // && d->state->matrix.type() == QTransform::TxTranslate) {
4777 QPainterPath polylinePath(points[0]);
4778 for (int i=1; i<pointCount; ++i)
4779 polylinePath.lineTo(points[i]);
4780 d->draw_helper(polylinePath, QPainterPrivate::StrokeDraw);
4783 d->engine->drawPolygon(points, pointCount, QPaintEngine::PolylineMode);
4788 \fn void QPainter::drawPolyline(const QPolygonF &points)
4792 Draws the polyline defined by the given \a points using the
4797 \fn void QPainter::drawPolyline(const QPolygon &points)
4801 Draws the polyline defined by the given \a points using the
4806 Draws the polygon defined by the first \a pointCount points in the
4807 array \a points using the current pen and brush.
4811 \o \inlineimage qpainter-polygon.png
4813 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 14
4816 The first point is implicitly connected to the last point, and the
4817 polygon is filled with the current brush().
4819 If \a fillRule is Qt::WindingFill, the polygon is filled using the
4820 winding fill algorithm. If \a fillRule is Qt::OddEvenFill, the
4821 polygon is filled using the odd-even fill algorithm. See
4822 \l{Qt::FillRule} for a more detailed description of these fill
4825 \sa drawConvexPolygon(), drawPolyline(), {Coordinate System}
4827 void QPainter::drawPolygon(const QPointF *points, int pointCount, Qt::FillRule fillRule)
4829 #ifdef QT_DEBUG_DRAW
4830 if (qt_show_painter_debug_output)
4831 printf("QPainter::drawPolygon(), count=%d\n", pointCount);
4836 if (!d->engine || pointCount < 2)
4840 d->extended->drawPolygon(points, pointCount, QPaintEngine::PolygonDrawMode(fillRule));
4844 d->updateState(d->state);
4846 uint emulationSpecifier = d->state->emulationSpecifier;
4848 if (emulationSpecifier) {
4849 QPainterPath polygonPath(points[0]);
4850 for (int i=1; i<pointCount; ++i)
4851 polygonPath.lineTo(points[i]);
4852 polygonPath.closeSubpath();
4853 polygonPath.setFillRule(fillRule);
4854 d->draw_helper(polygonPath);
4858 d->engine->drawPolygon(points, pointCount, QPaintEngine::PolygonDrawMode(fillRule));
4863 Draws the polygon defined by the first \a pointCount points in the
4866 void QPainter::drawPolygon(const QPoint *points, int pointCount, Qt::FillRule fillRule)
4868 #ifdef QT_DEBUG_DRAW
4869 if (qt_show_painter_debug_output)
4870 printf("QPainter::drawPolygon(), count=%d\n", pointCount);
4875 if (!d->engine || pointCount < 2)
4879 d->extended->drawPolygon(points, pointCount, QPaintEngine::PolygonDrawMode(fillRule));
4883 d->updateState(d->state);
4885 uint emulationSpecifier = d->state->emulationSpecifier;
4887 if (emulationSpecifier) {
4888 QPainterPath polygonPath(points[0]);
4889 for (int i=1; i<pointCount; ++i)
4890 polygonPath.lineTo(points[i]);
4891 polygonPath.closeSubpath();
4892 polygonPath.setFillRule(fillRule);
4893 d->draw_helper(polygonPath);
4897 d->engine->drawPolygon(points, pointCount, QPaintEngine::PolygonDrawMode(fillRule));
4900 /*! \fn void QPainter::drawPolygon(const QPolygonF &points, Qt::FillRule fillRule)
4904 Draws the polygon defined by the given \a points using the fill
4908 /*! \fn void QPainter::drawPolygon(const QPolygon &points, Qt::FillRule fillRule)
4912 Draws the polygon defined by the given \a points using the fill
4917 \fn void QPainter::drawConvexPolygon(const QPointF *points, int pointCount)
4919 Draws the convex polygon defined by the first \a pointCount points
4920 in the array \a points using the current pen.
4924 \o \inlineimage qpainter-polygon.png
4926 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 15
4929 The first point is implicitly connected to the last point, and the
4930 polygon is filled with the current brush(). If the supplied
4931 polygon is not convex, i.e. it contains at least one angle larger
4932 than 180 degrees, the results are undefined.
4934 On some platforms (e.g. X11), the drawConvexPolygon() function can
4935 be faster than the drawPolygon() function.
4937 \sa drawPolygon(), drawPolyline(), {Coordinate System}
4941 \fn void QPainter::drawConvexPolygon(const QPoint *points, int pointCount)
4944 Draws the convex polygon defined by the first \a pointCount points
4945 in the array \a points using the current pen.
4949 \fn void QPainter::drawConvexPolygon(const QPolygonF &polygon)
4953 Draws the convex polygon defined by \a polygon using the current
4958 \fn void QPainter::drawConvexPolygon(const QPolygon &polygon)
4961 Draws the convex polygon defined by \a polygon using the current
4965 void QPainter::drawConvexPolygon(const QPoint *points, int pointCount)
4967 #ifdef QT_DEBUG_DRAW
4968 if (qt_show_painter_debug_output)
4969 printf("QPainter::drawConvexPolygon(), count=%d\n", pointCount);
4974 if (!d->engine || pointCount < 2)
4978 d->extended->drawPolygon(points, pointCount, QPaintEngine::ConvexMode);
4982 d->updateState(d->state);
4984 uint emulationSpecifier = d->state->emulationSpecifier;
4986 if (emulationSpecifier) {
4987 QPainterPath polygonPath(points[0]);
4988 for (int i=1; i<pointCount; ++i)
4989 polygonPath.lineTo(points[i]);
4990 polygonPath.closeSubpath();
4991 polygonPath.setFillRule(Qt::WindingFill);
4992 d->draw_helper(polygonPath);
4996 d->engine->drawPolygon(points, pointCount, QPaintEngine::ConvexMode);
4999 void QPainter::drawConvexPolygon(const QPointF *points, int pointCount)
5001 #ifdef QT_DEBUG_DRAW
5002 if (qt_show_painter_debug_output)
5003 printf("QPainter::drawConvexPolygon(), count=%d\n", pointCount);
5008 if (!d->engine || pointCount < 2)
5012 d->extended->drawPolygon(points, pointCount, QPaintEngine::ConvexMode);
5016 d->updateState(d->state);
5018 uint emulationSpecifier = d->state->emulationSpecifier;
5020 if (emulationSpecifier) {
5021 QPainterPath polygonPath(points[0]);
5022 for (int i=1; i<pointCount; ++i)
5023 polygonPath.lineTo(points[i]);
5024 polygonPath.closeSubpath();
5025 polygonPath.setFillRule(Qt::WindingFill);
5026 d->draw_helper(polygonPath);
5030 d->engine->drawPolygon(points, pointCount, QPaintEngine::ConvexMode);
5033 static inline QPointF roundInDeviceCoordinates(const QPointF &p, const QTransform &m)
5035 return m.inverted().map(QPointF(m.map(p).toPoint()));
5039 \fn void QPainter::drawPixmap(const QRectF &target, const QPixmap &pixmap, const QRectF &source)
5041 Draws the rectangular portion \a source of the given \a pixmap
5042 into the given \a target in the paint device.
5044 \note The pixmap is scaled to fit the rectangle, if both the pixmap and rectangle size disagree.
5049 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 16
5052 If \a pixmap is a QBitmap it is drawn with the bits that are "set"
5053 using the pens color. If backgroundMode is Qt::OpaqueMode, the
5054 "unset" bits are drawn using the color of the background brush; if
5055 backgroundMode is Qt::TransparentMode, the "unset" bits are
5056 transparent. Drawing bitmaps with gradient or texture colors is
5061 void QPainter::drawPixmap(const QPointF &p, const QPixmap &pm)
5063 #if defined QT_DEBUG_DRAW
5064 if (qt_show_painter_debug_output)
5065 printf("QPainter::drawPixmap(), p=[%.2f,%.2f], pix=[%d,%d]\n",
5067 pm.width(), pm.height());
5072 if (!d->engine || pm.isNull())
5076 qt_painter_thread_test(d->device->devType(), "drawPixmap()", true);
5080 d->extended->drawPixmap(p, pm);
5088 int h = pm.height();
5093 // Emulate opaque background for bitmaps
5094 if (d->state->bgMode == Qt::OpaqueMode && pm.isQBitmap()) {
5095 fillRect(QRectF(x, y, w, h), d->state->bgBrush.color());
5098 d->updateState(d->state);
5100 if ((d->state->matrix.type() > QTransform::TxTranslate
5101 && !d->engine->hasFeature(QPaintEngine::PixmapTransform))
5102 || (!d->state->matrix.isAffine() && !d->engine->hasFeature(QPaintEngine::PerspectiveTransform))
5103 || (d->state->opacity != 1.0 && !d->engine->hasFeature(QPaintEngine::ConstantOpacity)))
5106 // If there is no rotation involved we have to make sure we use the
5107 // antialiased and not the aliased coordinate system by rounding the coordinates.
5108 if (d->state->matrix.type() <= QTransform::TxScale) {
5109 const QPointF p = roundInDeviceCoordinates(QPointF(x, y), d->state->matrix);
5114 setBackgroundMode(Qt::TransparentMode);
5115 setRenderHint(Antialiasing, renderHints() & SmoothPixmapTransform);
5116 QBrush brush(d->state->pen.color(), pm);
5119 setBrushOrigin(QPointF(0, 0));
5121 drawRect(pm.rect());
5124 if (!d->engine->hasFeature(QPaintEngine::PixmapTransform)) {
5125 x += d->state->matrix.dx();
5126 y += d->state->matrix.dy();
5128 d->engine->drawPixmap(QRectF(x, y, w, h), pm, QRectF(0, 0, w, h));
5132 void QPainter::drawPixmap(const QRectF &r, const QPixmap &pm, const QRectF &sr)
5134 #if defined QT_DEBUG_DRAW
5135 if (qt_show_painter_debug_output)
5136 printf("QPainter::drawPixmap(), target=[%.2f,%.2f,%.2f,%.2f], pix=[%d,%d], source=[%.2f,%.2f,%.2f,%.2f]\n",
5137 r.x(), r.y(), r.width(), r.height(),
5138 pm.width(), pm.height(),
5139 sr.x(), sr.y(), sr.width(), sr.height());
5143 if (!d->engine || pm.isNull())
5146 qt_painter_thread_test(d->device->devType(), "drawPixmap()", true);
5151 qreal w = r.width();
5152 qreal h = r.height();
5155 qreal sw = sr.width();
5156 qreal sh = sr.height();
5158 // Sanity-check clipping
5160 sw = pm.width() - sx;
5163 sh = pm.height() - sy;
5171 qreal w_ratio = sx * w/sw;
5179 qreal h_ratio = sy * h/sh;
5186 if (sw + sx > pm.width()) {
5187 qreal delta = sw - (pm.width() - sx);
5188 qreal w_ratio = delta * w/sw;
5193 if (sh + sy > pm.height()) {
5194 qreal delta = sh - (pm.height() - sy);
5195 qreal h_ratio = delta * h/sh;
5200 if (w == 0 || h == 0 || sw <= 0 || sh <= 0)
5204 d->extended->drawPixmap(QRectF(x, y, w, h), pm, QRectF(sx, sy, sw, sh));
5208 // Emulate opaque background for bitmaps
5209 if (d->state->bgMode == Qt::OpaqueMode && pm.isQBitmap())
5210 fillRect(QRectF(x, y, w, h), d->state->bgBrush.color());
5212 d->updateState(d->state);
5214 if ((d->state->matrix.type() > QTransform::TxTranslate
5215 && !d->engine->hasFeature(QPaintEngine::PixmapTransform))
5216 || (!d->state->matrix.isAffine() && !d->engine->hasFeature(QPaintEngine::PerspectiveTransform))
5217 || (d->state->opacity != 1.0 && !d->engine->hasFeature(QPaintEngine::ConstantOpacity))
5218 || ((sw != w || sh != h) && !d->engine->hasFeature(QPaintEngine::PixmapTransform)))
5221 // If there is no rotation involved we have to make sure we use the
5222 // antialiased and not the aliased coordinate system by rounding the coordinates.
5223 if (d->state->matrix.type() <= QTransform::TxScale) {
5224 const QPointF p = roundInDeviceCoordinates(QPointF(x, y), d->state->matrix);
5229 if (d->state->matrix.type() <= QTransform::TxTranslate && sw == w && sh == h) {
5237 scale(w / sw, h / sh);
5238 setBackgroundMode(Qt::TransparentMode);
5239 setRenderHint(Antialiasing, renderHints() & SmoothPixmapTransform);
5242 if (sw == pm.width() && sh == pm.height())
5243 brush = QBrush(d->state->pen.color(), pm);
5245 brush = QBrush(d->state->pen.color(), pm.copy(sx, sy, sw, sh));
5250 drawRect(QRectF(0, 0, sw, sh));
5253 if (!d->engine->hasFeature(QPaintEngine::PixmapTransform)) {
5254 x += d->state->matrix.dx();
5255 y += d->state->matrix.dy();
5257 d->engine->drawPixmap(QRectF(x, y, w, h), pm, QRectF(sx, sy, sw, sh));
5263 \fn void QPainter::drawPixmap(const QRect &target, const QPixmap &pixmap,
5264 const QRect &source)
5267 Draws the rectangular portion \a source of the given \a pixmap
5268 into the given \a target in the paint device.
5270 \note The pixmap is scaled to fit the rectangle, if both the pixmap and rectangle size disagree.
5274 \fn void QPainter::drawPixmap(const QPointF &point, const QPixmap &pixmap,
5275 const QRectF &source)
5278 Draws the rectangular portion \a source of the given \a pixmap
5279 with its origin at the given \a point.
5283 \fn void QPainter::drawPixmap(const QPoint &point, const QPixmap &pixmap,
5284 const QRect &source)
5288 Draws the rectangular portion \a source of the given \a pixmap
5289 with its origin at the given \a point.
5293 \fn void QPainter::drawPixmap(const QPointF &point, const QPixmap &pixmap)
5296 Draws the given \a pixmap with its origin at the given \a point.
5300 \fn void QPainter::drawPixmap(const QPoint &point, const QPixmap &pixmap)
5303 Draws the given \a pixmap with its origin at the given \a point.
5307 \fn void QPainter::drawPixmap(int x, int y, const QPixmap &pixmap)
5311 Draws the given \a pixmap at position (\a{x}, \a{y}).
5315 \fn void QPainter::drawPixmap(const QRect &rectangle, const QPixmap &pixmap)
5318 Draws the given \a pixmap into the given \a rectangle.
5320 \note The pixmap is scaled to fit the rectangle, if both the pixmap and rectangle size disagree.
5324 \fn void QPainter::drawPixmap(int x, int y, int width, int height,
5325 const QPixmap &pixmap)
5329 Draws the \a pixmap into the rectangle at position (\a{x}, \a{y})
5330 with the given \a width and \a height.
5334 \fn void QPainter::drawPixmap(int x, int y, int w, int h, const QPixmap &pixmap,
5335 int sx, int sy, int sw, int sh)
5339 Draws the rectangular portion with the origin (\a{sx}, \a{sy}),
5340 width \a sw and height \a sh, of the given \a pixmap , at the
5341 point (\a{x}, \a{y}), with a width of \a w and a height of \a h.
5342 If sw or sh are equal to zero the width/height of the pixmap
5343 is used and adjusted by the offset sx/sy;
5347 \fn void QPainter::drawPixmap(int x, int y, const QPixmap &pixmap,
5348 int sx, int sy, int sw, int sh)
5352 Draws a pixmap at (\a{x}, \a{y}) by copying a part of the given \a
5353 pixmap into the paint device.
5355 (\a{x}, \a{y}) specifies the top-left point in the paint device that is
5356 to be drawn onto. (\a{sx}, \a{sy}) specifies the top-left point in \a
5357 pixmap that is to be drawn. The default is (0, 0).
5359 (\a{sw}, \a{sh}) specifies the size of the pixmap that is to be drawn.
5360 The default, (0, 0) (and negative) means all the way to the
5361 bottom-right of the pixmap.
5364 void QPainter::drawImage(const QPointF &p, const QImage &image)
5368 if (!d->engine || image.isNull())
5372 d->extended->drawImage(p, image);
5379 int w = image.width();
5380 int h = image.height();
5382 d->updateState(d->state);
5384 if (((d->state->matrix.type() > QTransform::TxTranslate)
5385 && !d->engine->hasFeature(QPaintEngine::PixmapTransform))
5386 || (!d->state->matrix.isAffine() && !d->engine->hasFeature(QPaintEngine::PerspectiveTransform))
5387 || (d->state->opacity != 1.0 && !d->engine->hasFeature(QPaintEngine::ConstantOpacity)))
5390 // If there is no rotation involved we have to make sure we use the
5391 // antialiased and not the aliased coordinate system by rounding the coordinates.
5392 if (d->state->matrix.type() <= QTransform::TxScale) {
5393 const QPointF p = roundInDeviceCoordinates(QPointF(x, y), d->state->matrix);
5398 setBackgroundMode(Qt::TransparentMode);
5399 setRenderHint(Antialiasing, renderHints() & SmoothPixmapTransform);
5400 QBrush brush(image);
5403 setBrushOrigin(QPointF(0, 0));
5405 drawRect(image.rect());
5410 if (d->state->matrix.type() == QTransform::TxTranslate
5411 && !d->engine->hasFeature(QPaintEngine::PixmapTransform)) {
5412 x += d->state->matrix.dx();
5413 y += d->state->matrix.dy();
5416 d->engine->drawImage(QRectF(x, y, w, h), image, QRectF(0, 0, w, h), Qt::AutoColor);
5419 void QPainter::drawImage(const QRectF &targetRect, const QImage &image, const QRectF &sourceRect,
5420 Qt::ImageConversionFlags flags)
5424 if (!d->engine || image.isNull())
5427 qreal x = targetRect.x();
5428 qreal y = targetRect.y();
5429 qreal w = targetRect.width();
5430 qreal h = targetRect.height();
5431 qreal sx = sourceRect.x();
5432 qreal sy = sourceRect.y();
5433 qreal sw = sourceRect.width();
5434 qreal sh = sourceRect.height();
5436 // Sanity-check clipping
5438 sw = image.width() - sx;
5441 sh = image.height() - sy;
5449 qreal w_ratio = sx * w/sw;
5457 qreal h_ratio = sy * h/sh;
5464 if (sw + sx > image.width()) {
5465 qreal delta = sw - (image.width() - sx);
5466 qreal w_ratio = delta * w/sw;
5471 if (sh + sy > image.height()) {
5472 qreal delta = sh - (image.height() - sy);
5473 qreal h_ratio = delta * h/sh;
5478 if (w == 0 || h == 0 || sw <= 0 || sh <= 0)
5482 d->extended->drawImage(QRectF(x, y, w, h), image, QRectF(sx, sy, sw, sh), flags);
5486 d->updateState(d->state);
5488 if (((d->state->matrix.type() > QTransform::TxTranslate || (sw != w || sh != h))
5489 && !d->engine->hasFeature(QPaintEngine::PixmapTransform))
5490 || (!d->state->matrix.isAffine() && !d->engine->hasFeature(QPaintEngine::PerspectiveTransform))
5491 || (d->state->opacity != 1.0 && !d->engine->hasFeature(QPaintEngine::ConstantOpacity)))
5494 // If there is no rotation involved we have to make sure we use the
5495 // antialiased and not the aliased coordinate system by rounding the coordinates.
5496 if (d->state->matrix.type() <= QTransform::TxScale) {
5497 const QPointF p = roundInDeviceCoordinates(QPointF(x, y), d->state->matrix);
5502 if (d->state->matrix.type() <= QTransform::TxTranslate && sw == w && sh == h) {
5509 scale(w / sw, h / sh);
5510 setBackgroundMode(Qt::TransparentMode);
5511 setRenderHint(Antialiasing, renderHints() & SmoothPixmapTransform);
5512 QBrush brush(image);
5515 setBrushOrigin(QPointF(-sx, -sy));
5517 drawRect(QRectF(0, 0, sw, sh));
5522 if (d->state->matrix.type() == QTransform::TxTranslate
5523 && !d->engine->hasFeature(QPaintEngine::PixmapTransform)) {
5524 x += d->state->matrix.dx();
5525 y += d->state->matrix.dy();
5528 d->engine->drawImage(QRectF(x, y, w, h), image, QRectF(sx, sy, sw, sh), flags);
5532 \fn void QPainter::drawGlyphRun(const QPointF &position, const QGlyphRun &glyphs)
5534 Draws the glyphs represented by \a glyphs at \a position. The \a position gives the
5535 edge of the baseline for the string of glyphs. The glyphs will be retrieved from the font
5536 selected on \a glyphs and at offsets given by the positions in \a glyphs.
5540 \sa QGlyphRun::setRawFont(), QGlyphRun::setPositions(), QGlyphRun::setGlyphIndexes()
5542 #if !defined(QT_NO_RAWFONT)
5543 void QPainter::drawGlyphRun(const QPointF &position, const QGlyphRun &glyphRun)
5547 QRawFont font = glyphRun.rawFont();
5548 if (!font.isValid())
5551 QGlyphRunPrivate *glyphRun_d = QGlyphRunPrivate::get(glyphRun);
5553 const quint32 *glyphIndexes = glyphRun_d->glyphIndexData;
5554 const QPointF *glyphPositions = glyphRun_d->glyphPositionData;
5556 int count = qMin(glyphRun_d->glyphIndexDataSize, glyphRun_d->glyphPositionDataSize);
5557 QVarLengthArray<QFixedPoint, 128> fixedPointPositions(count);
5559 QRawFontPrivate *fontD = QRawFontPrivate::get(font);
5560 bool supportsTransformations;
5561 if (d->extended != 0) {
5562 supportsTransformations = d->extended->supportsTransformations(fontD->fontEngine->fontDef.pixelSize,
5565 supportsTransformations = d->engine->type() == QPaintEngine::CoreGraphics
5566 || d->state->matrix.isAffine();
5569 for (int i=0; i<count; ++i) {
5570 QPointF processedPosition = position + glyphPositions[i];
5571 if (!supportsTransformations)
5572 processedPosition = d->state->transform().map(processedPosition);
5573 fixedPointPositions[i] = QFixedPoint::fromPointF(processedPosition);
5576 d->drawGlyphs(glyphIndexes, fixedPointPositions.data(), count, font, glyphRun.overline(),
5577 glyphRun.underline(), glyphRun.strikeOut());
5580 void QPainterPrivate::drawGlyphs(const quint32 *glyphArray, QFixedPoint *positions,
5582 const QRawFont &font, bool overline, bool underline,
5589 QRawFontPrivate *fontD = QRawFontPrivate::get(font);
5590 QFontEngine *fontEngine = fontD->fontEngine;
5595 for (int i=0; i<glyphCount; ++i) {
5596 glyph_metrics_t gm = fontEngine->boundingBox(glyphArray[i]);
5597 if (i == 0 || leftMost > positions[i].x)
5598 leftMost = positions[i].x;
5600 // We don't support glyphs that do not share a common baseline. If this turns out to
5601 // be a relevant use case, then we need to find clusters of glyphs that share a baseline
5602 // and do a drawTextItemDecorations call per cluster.
5603 if (i == 0 || baseLine < positions[i].y)
5604 baseLine = positions[i].y;
5606 // We use the advance rather than the actual bounds to match the algorithm in drawText()
5607 if (i == 0 || rightMost < positions[i].x + gm.xoff)
5608 rightMost = positions[i].x + gm.xoff;
5611 QFixed width = rightMost - leftMost;
5613 if (extended != 0 && state->matrix.isAffine()) {
5614 QStaticTextItem staticTextItem;
5615 staticTextItem.color = state->pen.color();
5616 staticTextItem.font = state->font;
5617 staticTextItem.setFontEngine(fontEngine);
5618 staticTextItem.numGlyphs = glyphCount;
5619 staticTextItem.glyphs = reinterpret_cast<glyph_t *>(const_cast<glyph_t *>(glyphArray));
5620 staticTextItem.glyphPositions = positions;
5622 extended->drawStaticTextItem(&staticTextItem);
5624 QTextItemInt textItem;
5625 textItem.fontEngine = fontEngine;
5627 QVarLengthArray<QFixed, 128> advances(glyphCount);
5628 QVarLengthArray<QGlyphJustification, 128> glyphJustifications(glyphCount);
5629 QVarLengthArray<HB_GlyphAttributes, 128> glyphAttributes(glyphCount);
5630 qMemSet(glyphAttributes.data(), 0, glyphAttributes.size() * sizeof(HB_GlyphAttributes));
5631 qMemSet(advances.data(), 0, advances.size() * sizeof(QFixed));
5632 qMemSet(glyphJustifications.data(), 0, glyphJustifications.size() * sizeof(QGlyphJustification));
5634 textItem.glyphs.numGlyphs = glyphCount;
5635 textItem.glyphs.glyphs = reinterpret_cast<HB_Glyph *>(const_cast<quint32 *>(glyphArray));
5636 textItem.glyphs.offsets = positions;
5637 textItem.glyphs.advances_x = advances.data();
5638 textItem.glyphs.advances_y = advances.data();
5639 textItem.glyphs.justifications = glyphJustifications.data();
5640 textItem.glyphs.attributes = glyphAttributes.data();
5642 engine->drawTextItem(QPointF(0, 0), textItem);
5645 QTextItemInt::RenderFlags flags;
5647 flags |= QTextItemInt::Underline;
5649 flags |= QTextItemInt::Overline;
5651 flags |= QTextItemInt::StrikeOut;
5653 drawTextItemDecoration(q, QPointF(leftMost.toReal(), baseLine.toReal()),
5656 ? QTextCharFormat::SingleUnderline
5657 : QTextCharFormat::NoUnderline),
5658 flags, width.toReal(), QTextCharFormat());
5660 #endif // QT_NO_RAWFONT
5664 \fn void QPainter::drawStaticText(const QPoint &topLeftPosition, const QStaticText &staticText)
5668 Draws the \a staticText at the \a topLeftPosition.
5670 \note The y-position is used as the top of the font.
5675 \fn void QPainter::drawStaticText(int left, int top, const QStaticText &staticText)
5679 Draws the \a staticText at coordinates \a left and \a top.
5681 \note The y-position is used as the top of the font.
5685 \fn void QPainter::drawText(const QPointF &position, const QString &text)
5687 Draws the given \a text with the currently defined text direction,
5688 beginning at the given \a position.
5690 This function does not handle the newline character (\n), as it cannot
5691 break text into multiple lines, and it cannot display the newline character.
5692 Use the QPainter::drawText() overload that takes a rectangle instead
5693 if you want to draw multiple lines of text with the newline character, or
5694 if you want the text to be wrapped.
5696 By default, QPainter draws text anti-aliased.
5698 \note The y-position is used as the baseline of the font.
5701 void QPainter::drawText(const QPointF &p, const QString &str)
5703 drawText(p, str, 0, 0);
5709 Draws the given \a staticText at the given \a topLeftPosition.
5711 The text will be drawn using the font and the transformation set on the painter. If the
5712 font and/or transformation set on the painter are different from the ones used to initialize
5713 the layout of the QStaticText, then the layout will have to be recalculated. Use
5714 QStaticText::prepare() to initialize \a staticText with the font and transformation with which
5715 it will later be drawn.
5717 If \a topLeftPosition is not the same as when \a staticText was initialized, or when it was
5718 last drawn, then there will be a slight overhead when translating the text to its new position.
5720 \note If the painter's transformation is not affine, then \a staticText will be drawn using
5721 regular calls to drawText(), losing any potential for performance improvement.
5723 \note The y-position is used as the top of the font.
5727 void QPainter::drawStaticText(const QPointF &topLeftPosition, const QStaticText &staticText)
5730 if (!d->engine || staticText.text().isEmpty() || pen().style() == Qt::NoPen)
5733 QStaticTextPrivate *staticText_d =
5734 const_cast<QStaticTextPrivate *>(QStaticTextPrivate::get(&staticText));
5736 if (font() != staticText_d->font) {
5737 staticText_d->font = font();
5738 staticText_d->needsRelayout = true;
5741 // If we don't have an extended paint engine, or if the painter is projected,
5742 // we go through standard code path
5743 if (d->extended == 0 || !d->state->matrix.isAffine()) {
5744 staticText_d->paintText(topLeftPosition, this);
5748 bool supportsTransformations = d->extended->supportsTransformations(staticText_d->font.pixelSize(),
5750 if (supportsTransformations && !staticText_d->untransformedCoordinates) {
5751 staticText_d->untransformedCoordinates = true;
5752 staticText_d->needsRelayout = true;
5753 } else if (!supportsTransformations && staticText_d->untransformedCoordinates) {
5754 staticText_d->untransformedCoordinates = false;
5755 staticText_d->needsRelayout = true;
5758 // Don't recalculate entire layout because of translation, rather add the dx and dy
5759 // into the position to move each text item the correct distance.
5760 QPointF transformedPosition = topLeftPosition;
5761 if (!staticText_d->untransformedCoordinates)
5762 transformedPosition = transformedPosition * d->state->matrix;
5763 QTransform oldMatrix;
5765 // The translation has been applied to transformedPosition. Remove translation
5766 // component from matrix.
5767 if (d->state->matrix.isTranslating() && !staticText_d->untransformedCoordinates) {
5768 qreal m11 = d->state->matrix.m11();
5769 qreal m12 = d->state->matrix.m12();
5770 qreal m13 = d->state->matrix.m13();
5771 qreal m21 = d->state->matrix.m21();
5772 qreal m22 = d->state->matrix.m22();
5773 qreal m23 = d->state->matrix.m23();
5774 qreal m33 = d->state->matrix.m33();
5776 oldMatrix = d->state->matrix;
5777 d->state->matrix.setMatrix(m11, m12, m13,
5782 // If the transform is not identical to the text transform,
5783 // we have to relayout the text (for other transformations than plain translation)
5784 bool staticTextNeedsReinit = staticText_d->needsRelayout;
5785 if (!staticText_d->untransformedCoordinates && staticText_d->matrix != d->state->matrix) {
5786 staticText_d->matrix = d->state->matrix;
5787 staticTextNeedsReinit = true;
5790 // Recreate the layout of the static text because the matrix or font has changed
5791 if (staticTextNeedsReinit)
5792 staticText_d->init();
5794 if (transformedPosition != staticText_d->position) { // Translate to actual position
5795 QFixed fx = QFixed::fromReal(transformedPosition.x());
5796 QFixed fy = QFixed::fromReal(transformedPosition.y());
5797 QFixed oldX = QFixed::fromReal(staticText_d->position.x());
5798 QFixed oldY = QFixed::fromReal(staticText_d->position.y());
5799 for (int item=0; item<staticText_d->itemCount;++item) {
5800 QStaticTextItem *textItem = staticText_d->items + item;
5801 for (int i=0; i<textItem->numGlyphs; ++i) {
5802 textItem->glyphPositions[i].x += fx - oldX;
5803 textItem->glyphPositions[i].y += fy - oldY;
5805 textItem->userDataNeedsUpdate = true;
5808 staticText_d->position = transformedPosition;
5811 QPen oldPen = d->state->pen;
5812 QColor currentColor = oldPen.color();
5813 for (int i=0; i<staticText_d->itemCount; ++i) {
5814 QStaticTextItem *item = staticText_d->items + i;
5815 if (item->color.isValid() && currentColor != item->color) {
5816 setPen(item->color);
5817 currentColor = item->color;
5819 d->extended->drawStaticTextItem(item);
5821 qt_draw_decoration_for_glyphs(this, item->glyphs, item->glyphPositions,
5822 item->numGlyphs, item->fontEngine(), staticText_d->font,
5825 if (currentColor != oldPen.color())
5828 if (!staticText_d->untransformedCoordinates && oldMatrix.isTranslating())
5829 d->state->matrix = oldMatrix;
5835 void QPainter::drawText(const QPointF &p, const QString &str, int tf, int justificationPadding)
5837 #ifdef QT_DEBUG_DRAW
5838 if (qt_show_painter_debug_output)
5839 printf("QPainter::drawText(), pos=[%.2f,%.2f], str='%s'\n", p.x(), p.y(), str.toLatin1().constData());
5844 if (!d->engine || str.isEmpty() || pen().style() == Qt::NoPen)
5847 if (tf & Qt::TextBypassShaping) {
5848 // Skip harfbuzz complex shaping, shape using glyph advances only
5849 int len = str.length();
5850 int numGlyphs = len;
5851 QVarLengthGlyphLayoutArray glyphs(len);
5852 QFontEngine *fontEngine = d->state->font.d->engineForScript(QUnicodeTables::Common);
5853 if (!fontEngine->stringToCMap(str.data(), len, &glyphs, &numGlyphs, 0)) {
5854 glyphs.resize(numGlyphs);
5855 if (!fontEngine->stringToCMap(str.data(), len, &glyphs, &numGlyphs, 0))
5856 Q_ASSERT_X(false, Q_FUNC_INFO, "stringToCMap shouldn't fail twice");
5859 QTextItemInt gf(glyphs, &d->state->font, str.data(), len, fontEngine);
5860 drawTextItem(p, gf);
5864 QStackTextEngine engine(str, d->state->font);
5865 engine.option.setTextDirection(d->state->layoutDirection);
5866 if (tf & (Qt::TextForceLeftToRight|Qt::TextForceRightToLeft)) {
5867 engine.ignoreBidi = true;
5868 engine.option.setTextDirection((tf & Qt::TextForceLeftToRight) ? Qt::LeftToRight : Qt::RightToLeft);
5872 line.length = str.length();
5873 engine.shapeLine(line);
5875 int nItems = engine.layoutData->items.size();
5876 QVarLengthArray<int> visualOrder(nItems);
5877 QVarLengthArray<uchar> levels(nItems);
5878 for (int i = 0; i < nItems; ++i)
5879 levels[i] = engine.layoutData->items[i].analysis.bidiLevel;
5880 QTextEngine::bidiReorder(nItems, levels.data(), visualOrder.data());
5882 if (justificationPadding > 0) {
5883 engine.option.setAlignment(Qt::AlignJustify);
5884 engine.forceJustification = true;
5885 // this works because justify() is only interested in the difference between width and textWidth
5886 line.width = justificationPadding;
5887 engine.justify(line);
5889 QFixed x = QFixed::fromReal(p.x());
5891 for (int i = 0; i < nItems; ++i) {
5892 int item = visualOrder[i];
5893 const QScriptItem &si = engine.layoutData->items.at(item);
5894 if (si.analysis.flags >= QScriptAnalysis::TabOrObject) {
5898 QFont f = engine.font(si);
5899 QTextItemInt gf(si, &f);
5900 gf.glyphs = engine.shapedGlyphs(&si);
5901 gf.chars = engine.layoutData->string.unicode() + si.position;
5902 gf.num_chars = engine.length(item);
5903 if (engine.forceJustification) {
5904 for (int j=0; j<gf.glyphs.numGlyphs; ++j)
5905 gf.width += gf.glyphs.effectiveAdvance(j);
5907 gf.width = si.width;
5909 gf.logClusters = engine.logClusters(&si);
5911 drawTextItem(QPointF(x.toReal(), p.y()), gf);
5917 void QPainter::drawText(const QRect &r, int flags, const QString &str, QRect *br)
5919 #ifdef QT_DEBUG_DRAW
5920 if (qt_show_painter_debug_output)
5921 printf("QPainter::drawText(), r=[%d,%d,%d,%d], flags=%d, str='%s'\n",
5922 r.x(), r.y(), r.width(), r.height(), flags, str.toLatin1().constData());
5927 if (!d->engine || str.length() == 0 || pen().style() == Qt::NoPen)
5931 d->updateState(d->state);
5934 qt_format_text(d->state->font, r, flags, 0, str, br ? &bounds : 0, 0, 0, 0, this);
5936 *br = bounds.toAlignedRect();
5940 \fn void QPainter::drawText(const QPoint &position, const QString &text)
5944 Draws the given \a text with the currently defined text direction,
5945 beginning at the given \a position.
5947 By default, QPainter draws text anti-aliased.
5949 \note The y-position is used as the baseline of the font.
5954 \fn void QPainter::drawText(const QRectF &rectangle, int flags, const QString &text, QRectF *boundingRect)
5957 Draws the given \a text within the provided \a rectangle.
5961 \o \inlineimage qpainter-text.png
5963 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 17
5966 The \a boundingRect (if not null) is set to the what the bounding rectangle
5967 should be in order to enclose the whole text. The \a flags argument is a bitwise
5968 OR of the following flags:
5980 \o Qt::TextSingleLine
5981 \o Qt::TextExpandTabs
5982 \o Qt::TextShowMnemonic
5984 \o Qt::TextIncludeTrailingSpaces
5987 \sa Qt::AlignmentFlag, Qt::TextFlag, boundingRect(), layoutDirection()
5989 By default, QPainter draws text anti-aliased.
5991 \note The y-coordinate of \a rectangle is used as the top of the font.
5993 void QPainter::drawText(const QRectF &r, int flags, const QString &str, QRectF *br)
5995 #ifdef QT_DEBUG_DRAW
5996 if (qt_show_painter_debug_output)
5997 printf("QPainter::drawText(), r=[%.2f,%.2f,%.2f,%.2f], flags=%d, str='%s'\n",
5998 r.x(), r.y(), r.width(), r.height(), flags, str.toLatin1().constData());
6003 if (!d->engine || str.length() == 0 || pen().style() == Qt::NoPen)
6007 d->updateState(d->state);
6009 qt_format_text(d->state->font, r, flags, 0, str, br, 0, 0, 0, this);
6013 \fn void QPainter::drawText(const QRect &rectangle, int flags, const QString &text, QRect *boundingRect)
6016 Draws the given \a text within the provided \a rectangle according
6017 to the specified \a flags. The \a boundingRect (if not null) is set to
6018 the what the bounding rectangle should be in order to enclose the whole text.
6020 By default, QPainter draws text anti-aliased.
6022 \note The y-coordinate of \a rectangle is used as the top of the font.
6026 \fn void QPainter::drawText(int x, int y, const QString &text)
6030 Draws the given \a text at position (\a{x}, \a{y}), using the painter's
6031 currently defined text direction.
6033 By default, QPainter draws text anti-aliased.
6035 \note The y-position is used as the baseline of the font.
6040 \fn void QPainter::drawText(int x, int y, int width, int height, int flags,
6041 const QString &text, QRect *boundingRect)
6045 Draws the given \a text within the rectangle with origin (\a{x},
6046 \a{y}), \a width and \a height.
6048 The \a boundingRect (if not null) is set to the actual bounding
6049 rectangle of the output. The \a flags argument is a bitwise OR of
6050 the following flags:
6061 \o Qt::TextSingleLine
6062 \o Qt::TextExpandTabs
6063 \o Qt::TextShowMnemonic
6067 By default, QPainter draws text anti-aliased.
6069 \note The y-position is used as the top of the font.
6071 \sa Qt::AlignmentFlag, Qt::TextFlag
6075 \fn void QPainter::drawText(const QRectF &rectangle, const QString &text,
6076 const QTextOption &option)
6079 Draws the given \a text in the \a rectangle specified using the \a option
6080 to control its positioning and orientation.
6082 By default, QPainter draws text anti-aliased.
6084 \note The y-coordinate of \a rectangle is used as the top of the font.
6086 void QPainter::drawText(const QRectF &r, const QString &text, const QTextOption &o)
6088 #ifdef QT_DEBUG_DRAW
6089 if (qt_show_painter_debug_output)
6090 printf("QPainter::drawText(), r=[%.2f,%.2f,%.2f,%.2f], str='%s'\n",
6091 r.x(), r.y(), r.width(), r.height(), text.toLatin1().constData());
6096 if (!d->engine || text.length() == 0 || pen().style() == Qt::NoPen)
6100 d->updateState(d->state);
6102 qt_format_text(d->state->font, r, 0, &o, text, 0, 0, 0, 0, this);
6106 \fn void QPainter::drawTextItem(int x, int y, const QTextItem &ti)
6113 \fn void QPainter::drawTextItem(const QPoint &p, const QTextItem &ti)
6118 Draws the text item \a ti at position \a p.
6122 \fn void QPainter::drawTextItem(const QPointF &p, const QTextItem &ti)
6127 Draws the text item \a ti at position \a p.
6129 This method ignores the painters background mode and
6130 color. drawText and qt_format_text have to do it themselves, as
6131 only they know the extents of the complete string.
6133 It ignores the font set on the painter as the text item has one of its own.
6135 The underline and strikeout parameters of the text items font are
6136 ignored aswell. You'll need to pass in the correct flags to get
6137 underlining and strikeout.
6140 static QPixmap generateWavyPixmap(qreal maxRadius, const QPen &pen)
6142 const qreal radiusBase = qMax(qreal(1), maxRadius);
6144 QString key = QLatin1Literal("WaveUnderline-")
6145 % pen.color().name()
6146 % HexString<qreal>(radiusBase);
6149 if (QPixmapCache::find(key, pixmap))
6152 const qreal halfPeriod = qMax(qreal(2), qreal(radiusBase * 1.61803399)); // the golden ratio
6153 const int width = qCeil(100 / (2 * halfPeriod)) * (2 * halfPeriod);
6154 const int radius = qFloor(radiusBase);
6161 while (xs < width) {
6164 path.quadTo(xs - halfPeriod / 2, ys, xs, 0);
6167 pixmap = QPixmap(width, radius * 2);
6168 pixmap.fill(Qt::transparent);
6171 wavePen.setCapStyle(Qt::SquareCap);
6173 // This is to protect against making the line too fat, as happens on Mac OS X
6174 // due to it having a rather thick width for the regular underline.
6175 const qreal maxPenWidth = .8 * radius;
6176 if (wavePen.widthF() > maxPenWidth)
6177 wavePen.setWidth(maxPenWidth);
6179 QPainter imgPainter(&pixmap);
6180 imgPainter.setPen(wavePen);
6181 imgPainter.setRenderHint(QPainter::Antialiasing);
6182 imgPainter.translate(0, radius);
6183 imgPainter.drawPath(path);
6186 QPixmapCache::insert(key, pixmap);
6191 static void drawTextItemDecoration(QPainter *painter, const QPointF &pos, const QFontEngine *fe,
6192 QTextCharFormat::UnderlineStyle underlineStyle,
6193 QTextItem::RenderFlags flags, qreal width,
6194 const QTextCharFormat &charFormat)
6196 if (underlineStyle == QTextCharFormat::NoUnderline
6197 && !(flags & (QTextItem::StrikeOut | QTextItem::Overline)))
6200 const QPen oldPen = painter->pen();
6201 const QBrush oldBrush = painter->brush();
6202 painter->setBrush(Qt::NoBrush);
6204 pen.setStyle(Qt::SolidLine);
6205 pen.setWidthF(fe->lineThickness().toReal());
6206 pen.setCapStyle(Qt::FlatCap);
6208 QLineF line(pos.x(), pos.y(), pos.x() + qFloor(width), pos.y());
6210 const qreal underlineOffset = fe->underlinePosition().toReal();
6211 // deliberately ceil the offset to avoid the underline coming too close to
6212 // the text above it.
6213 const qreal aliasedCoordinateDelta = 0.5 - 0.015625;
6214 const qreal underlinePos = pos.y() + qCeil(underlineOffset) - aliasedCoordinateDelta;
6216 if (underlineStyle == QTextCharFormat::SpellCheckUnderline) {
6217 underlineStyle = QTextCharFormat::SpellCheckUnderline; // ### Qt5 QTextCharFormat::UnderlineStyle(QApplication::style()->styleHint(QStyle::SH_SpellCheckUnderlineStyle));
6220 if (underlineStyle == QTextCharFormat::WaveUnderline) {
6222 painter->translate(0, pos.y() + 1);
6224 QColor uc = charFormat.underlineColor();
6228 // Adapt wave to underlineOffset or pen width, whatever is larger, to make it work on all platforms
6229 const QPixmap wave = generateWavyPixmap(qMax(underlineOffset, pen.widthF()), pen);
6230 const int descent = (int) fe->descent().toReal();
6232 painter->setBrushOrigin(painter->brushOrigin().x(), 0);
6233 painter->fillRect(pos.x(), 0, qCeil(width), qMin(wave.height(), descent), wave);
6235 } else if (underlineStyle != QTextCharFormat::NoUnderline) {
6236 QLineF underLine(line.x1(), underlinePos, line.x2(), underlinePos);
6238 QColor uc = charFormat.underlineColor();
6242 pen.setStyle((Qt::PenStyle)(underlineStyle));
6243 painter->setPen(pen);
6244 painter->drawLine(underLine);
6247 pen.setStyle(Qt::SolidLine);
6248 pen.setColor(oldPen.color());
6250 if (flags & QTextItem::StrikeOut) {
6251 QLineF strikeOutLine = line;
6252 strikeOutLine.translate(0., - fe->ascent().toReal() / 3.);
6253 painter->setPen(pen);
6254 painter->drawLine(strikeOutLine);
6257 if (flags & QTextItem::Overline) {
6258 QLineF overLine = line;
6259 overLine.translate(0., - fe->ascent().toReal());
6260 painter->setPen(pen);
6261 painter->drawLine(overLine);
6264 painter->setPen(oldPen);
6265 painter->setBrush(oldBrush);
6268 Q_GUI_EXPORT void qt_draw_decoration_for_glyphs(QPainter *painter, const glyph_t *glyphArray,
6269 const QFixedPoint *positions, int glyphCount,
6270 QFontEngine *fontEngine, const QFont &font,
6271 const QTextCharFormat &charFormat)
6273 if (!(font.underline() || font.strikeOut() || font.overline()))
6279 for (int i=0; i<glyphCount; ++i) {
6280 glyph_metrics_t gm = fontEngine->boundingBox(glyphArray[i]);
6281 if (i == 0 || leftMost > positions[i].x)
6282 leftMost = positions[i].x;
6284 // We don't support glyphs that do not share a common baseline. If this turns out to
6285 // be a relevant use case, then we need to find clusters of glyphs that share a baseline
6286 // and do a drawTextItemDecorations call per cluster.
6287 if (i == 0 || baseLine < positions[i].y)
6288 baseLine = positions[i].y;
6290 // We use the advance rather than the actual bounds to match the algorithm in drawText()
6291 if (i == 0 || rightMost < positions[i].x + gm.xoff)
6292 rightMost = positions[i].x + gm.xoff;
6295 QFixed width = rightMost - leftMost;
6296 QTextItem::RenderFlags flags = 0;
6298 if (font.underline())
6299 flags |= QTextItem::Underline;
6300 if (font.overline())
6301 flags |= QTextItem::Overline;
6302 if (font.strikeOut())
6303 flags |= QTextItem::StrikeOut;
6305 drawTextItemDecoration(painter, QPointF(leftMost.toReal(), baseLine.toReal()),
6307 font.underline() ? QTextCharFormat::SingleUnderline
6308 : QTextCharFormat::NoUnderline, flags,
6309 width.toReal(), charFormat);
6312 void QPainter::drawTextItem(const QPointF &p, const QTextItem &_ti)
6314 #ifdef QT_DEBUG_DRAW
6315 if (qt_show_painter_debug_output)
6316 printf("QPainter::drawTextItem(), pos=[%.f,%.f], str='%s'\n",
6317 p.x(), p.y(), qPrintable(_ti.text()));
6326 qt_painter_thread_test(d->device->devType(),
6328 QFontDatabase::supportsThreadedFontRendering());
6331 QTextItemInt &ti = const_cast<QTextItemInt &>(static_cast<const QTextItemInt &>(_ti));
6333 if (!d->extended && d->state->bgMode == Qt::OpaqueMode) {
6334 QRectF rect(p.x(), p.y() - ti.ascent.toReal(), ti.width.toReal(), (ti.ascent + ti.descent + 1).toReal());
6335 fillRect(rect, d->state->bgBrush);
6338 if (pen().style() == Qt::NoPen)
6341 const RenderHints oldRenderHints = d->state->renderHints;
6342 if (!d->state->renderHints & QPainter::Antialiasing && d->state->matrix.type() >= QTransform::TxScale) {
6343 // draw antialias decoration (underline/overline/strikeout) with
6347 const QTransform &m = d->state->matrix;
6348 if (d->state->matrix.type() < QTransform::TxShear) {
6349 bool isPlain90DegreeRotation =
6350 (qFuzzyIsNull(m.m11())
6351 && qFuzzyIsNull(m.m12() - qreal(1))
6352 && qFuzzyIsNull(m.m21() + qreal(1))
6353 && qFuzzyIsNull(m.m22())
6356 (qFuzzyIsNull(m.m11() + qreal(1))
6357 && qFuzzyIsNull(m.m12())
6358 && qFuzzyIsNull(m.m21())
6359 && qFuzzyIsNull(m.m22() + qreal(1))
6362 (qFuzzyIsNull(m.m11())
6363 && qFuzzyIsNull(m.m12() + qreal(1))
6364 && qFuzzyIsNull(m.m21() - qreal(1))
6365 && qFuzzyIsNull(m.m22())
6368 aa = !isPlain90DegreeRotation;
6371 setRenderHint(QPainter::Antialiasing, true);
6375 d->updateState(d->state);
6377 if (!ti.glyphs.numGlyphs) {
6379 } else if (ti.fontEngine->type() == QFontEngine::Multi) {
6380 QFontEngineMulti *multi = static_cast<QFontEngineMulti *>(ti.fontEngine);
6382 const QGlyphLayout &glyphs = ti.glyphs;
6383 int which = glyphs.glyphs[0] >> 24;
6388 bool rtl = ti.flags & QTextItem::RightToLeft;
6390 x += ti.width.toReal();
6394 for (end = 0; end < ti.glyphs.numGlyphs; ++end) {
6395 const int e = glyphs.glyphs[end] >> 24;
6400 QTextItemInt ti2 = ti.midItem(multi->engine(which), start, end - start);
6402 // set the high byte to zero and calc the width
6403 for (i = start; i < end; ++i) {
6404 glyphs.glyphs[i] = glyphs.glyphs[i] & 0xffffff;
6405 ti2.width += ti.glyphs.effectiveAdvance(i);
6409 x -= ti2.width.toReal();
6411 d->engine->drawTextItem(QPointF(x, y), ti2);
6414 x += ti2.width.toReal();
6416 // reset the high byte for all glyphs and advance to the next sub-string
6417 const int hi = which << 24;
6418 for (i = start; i < end; ++i) {
6419 glyphs.glyphs[i] = hi | glyphs.glyphs[i];
6427 QTextItemInt ti2 = ti.midItem(multi->engine(which), start, end - start);
6429 // set the high byte to zero and calc the width
6430 for (i = start; i < end; ++i) {
6431 glyphs.glyphs[i] = glyphs.glyphs[i] & 0xffffff;
6432 ti2.width += ti.glyphs.effectiveAdvance(i);
6436 x -= ti2.width.toReal();
6439 d->extended->drawTextItem(QPointF(x, y), ti2);
6441 d->engine->drawTextItem(QPointF(x,y), ti2);
6443 // reset the high byte for all glyphs
6444 const int hi = which << 24;
6445 for (i = start; i < end; ++i)
6446 glyphs.glyphs[i] = hi | glyphs.glyphs[i];
6450 d->extended->drawTextItem(p, ti);
6452 d->engine->drawTextItem(p, ti);
6454 drawTextItemDecoration(this, p, ti.fontEngine, ti.underlineStyle, ti.flags, ti.width.toReal(),
6457 if (d->state->renderHints != oldRenderHints) {
6458 d->state->renderHints = oldRenderHints;
6460 d->extended->renderHintsChanged();
6462 d->state->dirtyFlags |= QPaintEngine::DirtyHints;
6467 \fn QRectF QPainter::boundingRect(const QRectF &rectangle, int flags, const QString &text)
6469 Returns the bounding rectangle of the \a text as it will appear
6470 when drawn inside the given \a rectangle with the specified \a
6471 flags using the currently set font(); i.e the function tells you
6472 where the drawText() function will draw when given the same
6475 If the \a text does not fit within the given \a rectangle using
6476 the specified \a flags, the function returns the required
6479 The \a flags argument is a bitwise OR of the following flags:
6488 \o Qt::TextSingleLine
6489 \o Qt::TextExpandTabs
6490 \o Qt::TextShowMnemonic
6492 \o Qt::TextIncludeTrailingSpaces
6494 If several of the horizontal or several of the vertical alignment
6495 flags are set, the resulting alignment is undefined.
6497 \sa drawText(), Qt::Alignment, Qt::TextFlag
6501 \fn QRect QPainter::boundingRect(const QRect &rectangle, int flags,
6502 const QString &text)
6506 Returns the bounding rectangle of the \a text as it will appear
6507 when drawn inside the given \a rectangle with the specified \a
6508 flags using the currently set font().
6512 \fn QRect QPainter::boundingRect(int x, int y, int w, int h, int flags,
6513 const QString &text);
6517 Returns the bounding rectangle of the given \a text as it will
6518 appear when drawn inside the rectangle beginning at the point
6519 (\a{x}, \a{y}) with width \a w and height \a h.
6521 QRect QPainter::boundingRect(const QRect &rect, int flags, const QString &str)
6524 return QRect(rect.x(),rect.y(), 0,0);
6526 drawText(rect, flags | Qt::TextDontPrint, str, &brect);
6532 QRectF QPainter::boundingRect(const QRectF &rect, int flags, const QString &str)
6535 return QRectF(rect.x(),rect.y(), 0,0);
6537 drawText(rect, flags | Qt::TextDontPrint, str, &brect);
6542 \fn QRectF QPainter::boundingRect(const QRectF &rectangle,
6543 const QString &text, const QTextOption &option)
6547 Instead of specifying flags as a bitwise OR of the
6548 Qt::AlignmentFlag and Qt::TextFlag, this overloaded function takes
6549 an \a option argument. The QTextOption class provides a
6550 description of general rich text properties.
6554 QRectF QPainter::boundingRect(const QRectF &r, const QString &text, const QTextOption &o)
6558 if (!d->engine || text.length() == 0)
6559 return QRectF(r.x(),r.y(), 0,0);
6562 qt_format_text(d->state->font, r, Qt::TextDontPrint, &o, text, &br, 0, 0, 0, this);
6567 \fn void QPainter::drawTiledPixmap(const QRectF &rectangle, const QPixmap &pixmap, const QPointF &position)
6569 Draws a tiled \a pixmap, inside the given \a rectangle with its
6570 origin at the given \a position.
6572 Calling drawTiledPixmap() is similar to calling drawPixmap()
6573 several times to fill (tile) an area with a pixmap, but is
6574 potentially much more efficient depending on the underlying window
6579 void QPainter::drawTiledPixmap(const QRectF &r, const QPixmap &pixmap, const QPointF &sp)
6581 #ifdef QT_DEBUG_DRAW
6582 if (qt_show_painter_debug_output)
6583 printf("QPainter::drawTiledPixmap(), target=[%.2f,%.2f,%.2f,%.2f], pix=[%d,%d], offset=[%.2f,%.2f]\n",
6584 r.x(), r.y(), r.width(), r.height(),
6585 pixmap.width(), pixmap.height(),
6590 if (!d->engine || pixmap.isNull() || r.isEmpty())
6594 qt_painter_thread_test(d->device->devType(), "drawTiledPixmap()", true);
6597 qreal sw = pixmap.width();
6598 qreal sh = pixmap.height();
6602 sx = qRound(sw) - qRound(-sx) % qRound(sw);
6604 sx = qRound(sx) % qRound(sw);
6606 sy = qRound(sh) - -qRound(sy) % qRound(sh);
6608 sy = qRound(sy) % qRound(sh);
6612 d->extended->drawTiledPixmap(r, pixmap, QPointF(sx, sy));
6616 if (d->state->bgMode == Qt::OpaqueMode && pixmap.isQBitmap())
6617 fillRect(r, d->state->bgBrush);
6619 d->updateState(d->state);
6620 if ((d->state->matrix.type() > QTransform::TxTranslate
6621 && !d->engine->hasFeature(QPaintEngine::PixmapTransform))
6622 || (d->state->opacity != 1.0 && !d->engine->hasFeature(QPaintEngine::ConstantOpacity)))
6625 setBackgroundMode(Qt::TransparentMode);
6626 setRenderHint(Antialiasing, renderHints() & SmoothPixmapTransform);
6627 setBrush(QBrush(d->state->pen.color(), pixmap));
6630 // If there is no rotation involved we have to make sure we use the
6631 // antialiased and not the aliased coordinate system by rounding the coordinates.
6632 if (d->state->matrix.type() <= QTransform::TxScale) {
6633 const QPointF p = roundInDeviceCoordinates(r.topLeft(), d->state->matrix);
6635 if (d->state->matrix.type() <= QTransform::TxTranslate) {
6640 setBrushOrigin(QPointF(r.x()-sx, r.y()-sy));
6641 drawRect(QRectF(p, r.size()));
6643 setBrushOrigin(QPointF(r.x()-sx, r.y()-sy));
6652 if (d->state->matrix.type() == QTransform::TxTranslate
6653 && !d->engine->hasFeature(QPaintEngine::PixmapTransform)) {
6654 x += d->state->matrix.dx();
6655 y += d->state->matrix.dy();
6658 d->engine->drawTiledPixmap(QRectF(x, y, r.width(), r.height()), pixmap, QPointF(sx, sy));
6662 \fn QPainter::drawTiledPixmap(const QRect &rectangle, const QPixmap &pixmap,
6663 const QPoint &position = QPoint())
6666 Draws a tiled \a pixmap, inside the given \a rectangle with its
6667 origin at the given \a position.
6671 \fn void QPainter::drawTiledPixmap(int x, int y, int width, int height, const
6672 QPixmap &pixmap, int sx, int sy);
6675 Draws a tiled \a pixmap in the specified rectangle.
6677 (\a{x}, \a{y}) specifies the top-left point in the paint device
6678 that is to be drawn onto; with the given \a width and \a
6679 height. (\a{sx}, \a{sy}) specifies the top-left point in the \a
6680 pixmap that is to be drawn; this defaults to (0, 0).
6683 #ifndef QT_NO_PICTURE
6686 \fn void QPainter::drawPicture(const QPointF &point, const QPicture &picture)
6688 Replays the given \a picture at the given \a point.
6690 The QPicture class is a paint device that records and replays
6691 QPainter commands. A picture serializes the painter commands to an
6692 IO device in a platform-independent format. Everything that can be
6693 painted on a widget or pixmap can also be stored in a picture.
6695 This function does exactly the same as QPicture::play() when
6696 called with \a point = QPoint(0, 0).
6701 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 18
6704 \sa QPicture::play()
6707 void QPainter::drawPicture(const QPointF &p, const QPicture &picture)
6715 d->updateState(d->state);
6719 const_cast<QPicture *>(&picture)->play(this);
6724 \fn void QPainter::drawPicture(const QPoint &point, const QPicture &picture)
6727 Replays the given \a picture at the given \a point.
6731 \fn void QPainter::drawPicture(int x, int y, const QPicture &picture)
6734 Draws the given \a picture at point (\a x, \a y).
6737 #endif // QT_NO_PICTURE
6740 \fn void QPainter::eraseRect(const QRectF &rectangle)
6742 Erases the area inside the given \a rectangle. Equivalent to
6744 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 19
6748 void QPainter::eraseRect(const QRectF &r)
6752 fillRect(r, d->state->bgBrush);
6755 static inline bool needsResolving(const QBrush &brush)
6757 Qt::BrushStyle s = brush.style();
6758 return ((s == Qt::LinearGradientPattern || s == Qt::RadialGradientPattern ||
6759 s == Qt::ConicalGradientPattern) &&
6760 brush.gradient()->coordinateMode() == QGradient::ObjectBoundingMode);
6764 \fn void QPainter::eraseRect(const QRect &rectangle)
6767 Erases the area inside the given \a rectangle.
6771 \fn void QPainter::eraseRect(int x, int y, int width, int height)
6774 Erases the area inside the rectangle beginning at (\a x, \a y)
6775 with the given \a width and \a height.
6780 \fn void QPainter::fillRect(int x, int y, int width, int height, Qt::BrushStyle style)
6783 Fills the rectangle beginning at (\a{x}, \a{y}) with the given \a
6784 width and \a height, using the brush \a style specified.
6790 \fn void QPainter::fillRect(const QRect &rectangle, Qt::BrushStyle style)
6793 Fills the given \a rectangle with the brush \a style specified.
6799 \fn void QPainter::fillRect(const QRectF &rectangle, Qt::BrushStyle style)
6802 Fills the given \a rectangle with the brush \a style specified.
6808 \fn void QPainter::fillRect(const QRectF &rectangle, const QBrush &brush)
6810 Fills the given \a rectangle with the \a brush specified.
6812 Alternatively, you can specify a QColor instead of a QBrush; the
6813 QBrush constructor (taking a QColor argument) will automatically
6814 create a solid pattern brush.
6818 void QPainter::fillRect(const QRectF &r, const QBrush &brush)
6826 const QGradient *g = brush.gradient();
6827 if (!g || g->coordinateMode() == QGradient::LogicalMode) {
6828 d->extended->fillRect(r, brush);
6833 QPen oldPen = pen();
6834 QBrush oldBrush = this->brush();
6836 if (brush.style() == Qt::SolidPattern) {
6837 d->colorBrush.setStyle(Qt::SolidPattern);
6838 d->colorBrush.setColor(brush.color());
6839 setBrush(d->colorBrush);
6850 \fn void QPainter::fillRect(const QRect &rectangle, const QBrush &brush)
6853 Fills the given \a rectangle with the specified \a brush.
6856 void QPainter::fillRect(const QRect &r, const QBrush &brush)
6864 const QGradient *g = brush.gradient();
6865 if (!g || g->coordinateMode() == QGradient::LogicalMode) {
6866 d->extended->fillRect(r, brush);
6871 QPen oldPen = pen();
6872 QBrush oldBrush = this->brush();
6874 if (brush.style() == Qt::SolidPattern) {
6875 d->colorBrush.setStyle(Qt::SolidPattern);
6876 d->colorBrush.setColor(brush.color());
6877 setBrush(d->colorBrush);
6890 \fn void QPainter::fillRect(const QRect &rectangle, const QColor &color)
6893 Fills the given \a rectangle with the \a color specified.
6897 void QPainter::fillRect(const QRect &r, const QColor &color)
6905 d->extended->fillRect(r, color);
6909 fillRect(r, QBrush(color));
6914 \fn void QPainter::fillRect(const QRectF &rectangle, const QColor &color)
6917 Fills the given \a rectangle with the \a color specified.
6921 void QPainter::fillRect(const QRectF &r, const QColor &color)
6929 d->extended->fillRect(r, color);
6933 fillRect(r, QBrush(color));
6937 \fn void QPainter::fillRect(int x, int y, int width, int height, const QBrush &brush)
6941 Fills the rectangle beginning at (\a{x}, \a{y}) with the given \a
6942 width and \a height, using the given \a brush.
6946 \fn void QPainter::fillRect(int x, int y, int width, int height, const QColor &color)
6950 Fills the rectangle beginning at (\a{x}, \a{y}) with the given \a
6951 width and \a height, using the given \a color.
6957 \fn void QPainter::fillRect(int x, int y, int width, int height, Qt::GlobalColor color)
6961 Fills the rectangle beginning at (\a{x}, \a{y}) with the given \a
6962 width and \a height, using the given \a color.
6968 \fn void QPainter::fillRect(const QRect &rectangle, Qt::GlobalColor color);
6972 Fills the given \a rectangle with the specified \a color.
6978 \fn void QPainter::fillRect(const QRectF &rectangle, Qt::GlobalColor color);
6982 Fills the given \a rectangle with the specified \a color.
6988 Sets the given render \a hint on the painter if \a on is true;
6989 otherwise clears the render hint.
6991 \sa setRenderHints(), renderHints(), {QPainter#Rendering
6992 Quality}{Rendering Quality}
6994 void QPainter::setRenderHint(RenderHint hint, bool on)
6996 #ifdef QT_DEBUG_DRAW
6997 if (qt_show_painter_debug_output)
6998 printf("QPainter::setRenderHint: hint=%x, %s\n", hint, on ? "on" : "off");
7002 static const bool antialiasingDisabled = qgetenv("QT_NO_ANTIALIASING").toInt();
7003 if (hint == QPainter::Antialiasing && antialiasingDisabled)
7007 setRenderHints(hint, on);
7013 Sets the given render \a hints on the painter if \a on is true;
7014 otherwise clears the render hints.
7016 \sa setRenderHint(), renderHints(), {QPainter#Rendering
7017 Quality}{Rendering Quality}
7020 void QPainter::setRenderHints(RenderHints hints, bool on)
7025 qWarning("QPainter::setRenderHint: Painter must be active to set rendering hints");
7030 d->state->renderHints |= hints;
7032 d->state->renderHints &= ~hints;
7035 d->extended->renderHintsChanged();
7037 d->state->dirtyFlags |= QPaintEngine::DirtyHints;
7041 Returns a flag that specifies the rendering hints that are set for
7044 \sa testRenderHint(), {QPainter#Rendering Quality}{Rendering Quality}
7046 QPainter::RenderHints QPainter::renderHints() const
7048 Q_D(const QPainter);
7053 return d->state->renderHints;
7057 \fn bool QPainter::testRenderHint(RenderHint hint) const
7060 Returns true if \a hint is set; otherwise returns false.
7062 \sa renderHints(), setRenderHint()
7066 Returns true if view transformation is enabled; otherwise returns
7069 \sa setViewTransformEnabled(), worldTransform()
7072 bool QPainter::viewTransformEnabled() const
7074 Q_D(const QPainter);
7076 qWarning("QPainter::viewTransformEnabled: Painter not active");
7079 return d->state->VxF;
7083 \fn void QPainter::setWindow(const QRect &rectangle)
7085 Sets the painter's window to the given \a rectangle, and enables
7086 view transformations.
7088 The window rectangle is part of the view transformation. The
7089 window specifies the logical coordinate system. Its sister, the
7090 viewport(), specifies the device coordinate system.
7092 The default window rectangle is the same as the device's
7095 \sa window(), viewTransformEnabled(), {Coordinate
7096 System#Window-Viewport Conversion}{Window-Viewport Conversion}
7100 \fn void QPainter::setWindow(int x, int y, int width, int height)
7103 Sets the painter's window to the rectangle beginning at (\a x, \a
7104 y) and the given \a width and \a height.
7107 void QPainter::setWindow(const QRect &r)
7109 #ifdef QT_DEBUG_DRAW
7110 if (qt_show_painter_debug_output)
7111 printf("QPainter::setWindow(), [%d,%d,%d,%d]\n", r.x(), r.y(), r.width(), r.height());
7117 qWarning("QPainter::setWindow: Painter not active");
7121 d->state->wx = r.x();
7122 d->state->wy = r.y();
7123 d->state->ww = r.width();
7124 d->state->wh = r.height();
7126 d->state->VxF = true;
7131 Returns the window rectangle.
7133 \sa setWindow(), setViewTransformEnabled()
7136 QRect QPainter::window() const
7138 Q_D(const QPainter);
7140 qWarning("QPainter::window: Painter not active");
7143 return QRect(d->state->wx, d->state->wy, d->state->ww, d->state->wh);
7147 \fn void QPainter::setViewport(const QRect &rectangle)
7149 Sets the painter's viewport rectangle to the given \a rectangle,
7150 and enables view transformations.
7152 The viewport rectangle is part of the view transformation. The
7153 viewport specifies the device coordinate system. Its sister, the
7154 window(), specifies the logical coordinate system.
7156 The default viewport rectangle is the same as the device's
7159 \sa viewport(), viewTransformEnabled() {Coordinate
7160 System#Window-Viewport Conversion}{Window-Viewport Conversion}
7164 \fn void QPainter::setViewport(int x, int y, int width, int height)
7167 Sets the painter's viewport rectangle to be the rectangle
7168 beginning at (\a x, \a y) with the given \a width and \a height.
7171 void QPainter::setViewport(const QRect &r)
7173 #ifdef QT_DEBUG_DRAW
7174 if (qt_show_painter_debug_output)
7175 printf("QPainter::setViewport(), [%d,%d,%d,%d]\n", r.x(), r.y(), r.width(), r.height());
7181 qWarning("QPainter::setViewport: Painter not active");
7185 d->state->vx = r.x();
7186 d->state->vy = r.y();
7187 d->state->vw = r.width();
7188 d->state->vh = r.height();
7190 d->state->VxF = true;
7195 Returns the viewport rectangle.
7197 \sa setViewport(), setViewTransformEnabled()
7200 QRect QPainter::viewport() const
7202 Q_D(const QPainter);
7204 qWarning("QPainter::viewport: Painter not active");
7207 return QRect(d->state->vx, d->state->vy, d->state->vw, d->state->vh);
7211 Enables view transformations if \a enable is true, or disables
7212 view transformations if \a enable is false.
7214 \sa viewTransformEnabled(), {Coordinate System#Window-Viewport
7215 Conversion}{Window-Viewport Conversion}
7218 void QPainter::setViewTransformEnabled(bool enable)
7220 #ifdef QT_DEBUG_DRAW
7221 if (qt_show_painter_debug_output)
7222 printf("QPainter::setViewTransformEnabled(), enable=%d\n", enable);
7228 qWarning("QPainter::setViewTransformEnabled: Painter not active");
7232 if (enable == d->state->VxF)
7235 d->state->VxF = enable;
7244 Please use QWidget::render() instead.
7246 Redirects all paint commands for the given paint \a device, to the
7247 \a replacement device. The optional point \a offset defines an
7248 offset within the source device.
7250 The redirection will not be effective until the begin() function
7251 has been called; make sure to call end() for the given \a
7252 device's painter (if any) before redirecting. Call
7253 restoreRedirected() to restore the previous redirection.
7255 \warning Making use of redirections in the QPainter API implies
7256 that QPainter::begin() and QPaintDevice destructors need to hold
7257 a mutex for a short period. This can impact performance. Use of
7258 QWidget::render is strongly encouraged.
7260 \sa redirected(), restoreRedirected()
7262 void QPainter::setRedirected(const QPaintDevice *device,
7263 QPaintDevice *replacement,
7264 const QPoint &offset)
7266 Q_ASSERT(device != 0);
7267 Q_UNUSED(replacement)
7269 qWarning("QPainter::setRedirected(): ignoring call to deprecated function, use QWidget::render() instead");
7277 Using QWidget::render() obsoletes the use of this function.
7279 Restores the previous redirection for the given \a device after a
7280 call to setRedirected().
7282 \warning Making use of redirections in the QPainter API implies
7283 that QPainter::begin() and QPaintDevice destructors need to hold
7284 a mutex for a short period. This can impact performance. Use of
7285 QWidget::render is strongly encouraged.
7289 void QPainter::restoreRedirected(const QPaintDevice *device)
7292 qWarning("QPainter::restoreRedirected(): ignoring call to deprecated function, use QWidget::render() instead");
7300 Using QWidget::render() obsoletes the use of this function.
7302 Returns the replacement for given \a device. The optional out
7303 parameter \a offset returns the offset within the replaced device.
7305 \warning Making use of redirections in the QPainter API implies
7306 that QPainter::begin() and QPaintDevice destructors need to hold
7307 a mutex for a short period. This can impact performance. Use of
7308 QWidget::render is strongly encouraged.
7310 \sa setRedirected(), restoreRedirected()
7312 QPaintDevice *QPainter::redirected(const QPaintDevice *device, QPoint *offset)
7319 void qt_format_text(const QFont &fnt, const QRectF &_r,
7320 int tf, const QString& str, QRectF *brect,
7321 int tabstops, int *ta, int tabarraylen,
7324 qt_format_text(fnt, _r,
7326 tabstops, ta, tabarraylen,
7329 void qt_format_text(const QFont &fnt, const QRectF &_r,
7330 int tf, const QTextOption *option, const QString& str, QRectF *brect,
7331 int tabstops, int *ta, int tabarraylen,
7335 Q_ASSERT( !((tf & ~Qt::TextDontPrint)!=0 && option!=0) ); // we either have an option or flags
7338 tf |= option->alignment();
7339 if (option->wrapMode() != QTextOption::NoWrap)
7340 tf |= Qt::TextWordWrap;
7342 if (option->flags() & QTextOption::IncludeTrailingSpaces)
7343 tf |= Qt::TextIncludeTrailingSpaces;
7345 if (option->tabStop() >= 0 || !option->tabArray().isEmpty())
7346 tf |= Qt::TextExpandTabs;
7349 // we need to copy r here to protect against the case (&r == brect).
7352 bool dontclip = (tf & Qt::TextDontClip);
7353 bool wordwrap = (tf & Qt::TextWordWrap) || (tf & Qt::TextWrapAnywhere);
7354 bool singleline = (tf & Qt::TextSingleLine);
7355 bool showmnemonic = (tf & Qt::TextShowMnemonic);
7356 bool hidemnmemonic = (tf & Qt::TextHideMnemonic);
7358 Qt::LayoutDirection layout_direction;
7359 if (tf & Qt::TextForceLeftToRight)
7360 layout_direction = Qt::LeftToRight;
7361 else if (tf & Qt::TextForceRightToLeft)
7362 layout_direction = Qt::RightToLeft;
7364 layout_direction = option->textDirection();
7366 layout_direction = painter->layoutDirection();
7368 layout_direction = Qt::LeftToRight;
7370 tf = QGuiApplicationPrivate::visualAlignment(layout_direction, QFlag(tf));
7372 bool isRightToLeft = layout_direction == Qt::RightToLeft;
7373 bool expandtabs = ((tf & Qt::TextExpandTabs) &&
7374 (((tf & Qt::AlignLeft) && !isRightToLeft) ||
7375 ((tf & Qt::AlignRight) && isRightToLeft)));
7378 tf |= Qt::TextDontPrint;
7380 uint maxUnderlines = 0;
7381 int numUnderlines = 0;
7382 QVarLengthArray<int, 32> underlinePositions(1);
7384 QFontMetricsF fm(fnt);
7387 start_lengthVariant:
7388 bool hasMoreLengthVariants = false;
7389 // compatible behaviour to the old implementation. Replace
7391 int old_offset = offset;
7392 for (; offset < text.length(); offset++) {
7393 QChar chr = text.at(offset);
7394 if (chr == QLatin1Char('\r') || (singleline && chr == QLatin1Char('\n'))) {
7395 text[offset] = QLatin1Char(' ');
7396 } else if (chr == QLatin1Char('\n')) {
7397 text[offset] = QChar::LineSeparator;
7398 } else if (chr == QLatin1Char('&')) {
7400 } else if (chr == QLatin1Char('\t')) {
7402 text[offset] = QLatin1Char(' ');
7403 } else if (!tabarraylen && !tabstops) {
7404 tabstops = qRound(fm.width(QLatin1Char('x'))*8);
7406 } else if (chr == QChar(ushort(0x9c))) {
7407 // string with multiple length variants
7408 hasMoreLengthVariants = true;
7413 int length = offset - old_offset;
7414 if ((hidemnmemonic || showmnemonic) && maxUnderlines > 0) {
7415 underlinePositions.resize(maxUnderlines + 1);
7417 QChar *cout = text.data() + old_offset;
7421 if (*cin == QLatin1Char('&')) {
7427 if (*cin != QLatin1Char('&') && !hidemnmemonic)
7428 underlinePositions[numUnderlines++] = cout - text.data() - old_offset;
7437 // no need to do extra work for underlines if we don't paint
7438 if (tf & Qt::TextDontPrint)
7441 underlinePositions[numUnderlines] = -1;
7445 QString finalText = text.mid(old_offset, length);
7446 QStackTextEngine engine(finalText, fnt);
7448 engine.option = *option;
7451 if (engine.option.tabStop() < 0 && tabstops > 0)
7452 engine.option.setTabStop(tabstops);
7454 if (engine.option.tabs().isEmpty() && ta) {
7456 for (int i = 0; i < tabarraylen; i++)
7457 tabs.append(qreal(ta[i]));
7458 engine.option.setTabArray(tabs);
7461 engine.option.setTextDirection(layout_direction);
7462 if (tf & Qt::AlignJustify)
7463 engine.option.setAlignment(Qt::AlignJustify);
7465 engine.option.setAlignment(Qt::AlignLeft); // do not do alignment twice
7467 if (!option && (tf & Qt::TextWrapAnywhere))
7468 engine.option.setWrapMode(QTextOption::WrapAnywhere);
7470 if (tf & Qt::TextJustificationForced)
7471 engine.forceJustification = true;
7472 QTextLayout textLayout(&engine);
7473 textLayout.setCacheEnabled(true);
7474 textLayout.engine()->underlinePositions = underlinePositions.data();
7476 if (finalText.isEmpty()) {
7477 height = fm.height();
7479 tf |= Qt::TextDontPrint;
7481 qreal lineWidth = 0x01000000;
7482 if (wordwrap || (tf & Qt::TextJustificationForced))
7483 lineWidth = qMax<qreal>(0, r.width());
7485 tf |= Qt::TextIncludeTrailingSpaces;
7486 textLayout.engine()->ignoreBidi = bool(tf & Qt::TextDontPrint);
7487 textLayout.beginLayout();
7489 qreal leading = fm.leading();
7493 QTextLine l = textLayout.createLine();
7497 l.setLineWidth(lineWidth);
7499 l.setPosition(QPointF(0., height));
7500 height += l.height();
7501 width = qMax(width, l.naturalTextWidth());
7502 if (!dontclip && !brect && height >= r.height())
7505 textLayout.endLayout();
7510 if (tf & Qt::AlignBottom) {
7511 yoff = r.height() - height;
7512 } else if (tf & Qt::AlignVCenter) {
7513 yoff = (r.height() - height)/2;
7515 QTransform::TransformationType type = painter->transform().type();
7516 if (type <= QTransform::TxScale) {
7517 // do the rounding manually to work around inconsistencies
7518 // in the paint engines when drawing on floating point offsets
7519 const qreal scale = painter->transform().m22();
7521 yoff = -qRound(-yoff * scale) / scale;
7525 if (tf & Qt::AlignRight) {
7526 xoff = r.width() - width;
7527 } else if (tf & Qt::AlignHCenter) {
7528 xoff = (r.width() - width)/2;
7530 QTransform::TransformationType type = painter->transform().type();
7531 if (type <= QTransform::TxScale) {
7532 // do the rounding manually to work around inconsistencies
7533 // in the paint engines when drawing on floating point offsets
7534 const qreal scale = painter->transform().m11();
7536 xoff = qRound(xoff * scale) / scale;
7540 QRectF bounds = QRectF(r.x() + xoff, r.y() + yoff, width, height);
7542 if (hasMoreLengthVariants && !(tf & Qt::TextLongestVariant) && !r.contains(bounds)) {
7544 goto start_lengthVariant;
7549 if (!(tf & Qt::TextDontPrint)) {
7550 bool restore = false;
7551 if (!dontclip && !r.contains(bounds)) {
7554 painter->setClipRect(r, Qt::IntersectClip);
7557 for (int i = 0; i < textLayout.lineCount(); i++) {
7558 QTextLine line = textLayout.lineAt(i);
7560 qreal advance = line.horizontalAdvance();
7562 if (tf & Qt::AlignRight) {
7563 QTextEngine *eng = textLayout.engine();
7564 xoff = r.width() - advance -
7565 eng->leadingSpaceWidth(eng->lines[line.lineNumber()]).toReal();
7567 else if (tf & Qt::AlignHCenter)
7568 xoff = (r.width() - advance) / 2;
7570 line.draw(painter, QPointF(r.x() + xoff, r.y() + yoff));
7580 Sets the layout direction used by the painter when drawing text,
7581 to the specified \a direction.
7583 The default is Qt::LayoutDirectionAuto, which will implicitly determine the
7584 direction from the text drawn.
7586 \sa QTextOption::setTextDirection(), layoutDirection(), drawText(), {QPainter#Settings}{Settings}
7588 void QPainter::setLayoutDirection(Qt::LayoutDirection direction)
7592 d->state->layoutDirection = direction;
7596 Returns the layout direction used by the painter when drawing text.
7598 \sa QTextOption::textDirection(), setLayoutDirection(), drawText(), {QPainter#Settings}{Settings}
7600 Qt::LayoutDirection QPainter::layoutDirection() const
7602 Q_D(const QPainter);
7603 return d->state ? d->state->layoutDirection : Qt::LayoutDirectionAuto;
7606 QPainterState::QPainterState(const QPainterState *s)
7607 : brushOrigin(s->brushOrigin), font(s->font), deviceFont(s->deviceFont),
7608 pen(s->pen), brush(s->brush), bgBrush(s->bgBrush),
7609 clipRegion(s->clipRegion), clipPath(s->clipPath),
7610 clipOperation(s->clipOperation),
7611 renderHints(s->renderHints), clipInfo(s->clipInfo),
7612 worldMatrix(s->worldMatrix), matrix(s->matrix), redirectionMatrix(s->redirectionMatrix),
7613 wx(s->wx), wy(s->wy), ww(s->ww), wh(s->wh),
7614 vx(s->vx), vy(s->vy), vw(s->vw), vh(s->vh),
7615 opacity(s->opacity), WxF(s->WxF), VxF(s->VxF),
7616 clipEnabled(s->clipEnabled), bgMode(s->bgMode), painter(s->painter),
7617 layoutDirection(s->layoutDirection),
7618 composition_mode(s->composition_mode),
7619 emulationSpecifier(s->emulationSpecifier), changeFlags(0)
7621 dirtyFlags = s->dirtyFlags;
7624 QPainterState::QPainterState()
7625 : brushOrigin(0, 0), bgBrush(Qt::white), clipOperation(Qt::NoClip),
7627 wx(0), wy(0), ww(0), wh(0), vx(0), vy(0), vw(0), vh(0),
7628 opacity(1), WxF(false), VxF(false), clipEnabled(true),
7629 bgMode(Qt::TransparentMode), painter(0),
7630 layoutDirection(QGuiApplication::layoutDirection()),
7631 composition_mode(QPainter::CompositionMode_SourceOver),
7632 emulationSpecifier(0), changeFlags(0)
7637 QPainterState::~QPainterState()
7641 void QPainterState::init(QPainter *p) {
7642 bgBrush = Qt::white;
7643 bgMode = Qt::TransparentMode;
7647 wx = wy = ww = wh = 0;
7648 vx = vy = vw = vh = 0;
7651 brushOrigin = QPointF(0, 0);
7653 font = deviceFont = QFont();
7654 clipRegion = QRegion();
7655 clipPath = QPainterPath();
7656 clipOperation = Qt::NoClip;
7658 worldMatrix.reset();
7660 layoutDirection = QGuiApplication::layoutDirection();
7661 composition_mode = QPainter::CompositionMode_SourceOver;
7662 emulationSpecifier = 0;
7670 \fn void QPainter::drawImage(const QRectF &target, const QImage &image, const QRectF &source,
7671 Qt::ImageConversionFlags flags)
7673 Draws the rectangular portion \a source of the given \a image
7674 into the \a target rectangle in the paint device.
7676 \note The image is scaled to fit the rectangle, if both the image and rectangle size disagree.
7678 If the image needs to be modified to fit in a lower-resolution
7679 result (e.g. converting from 32-bit to 8-bit), use the \a flags to
7680 specify how you would prefer this to happen.
7685 \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 20
7692 \fn void QPainter::drawImage(const QRect &target, const QImage &image, const QRect &source,
7693 Qt::ImageConversionFlags flags)
7696 Draws the rectangular portion \a source of the given \a image
7697 into the \a target rectangle in the paint device.
7699 \note The image is scaled to fit the rectangle, if both the image and rectangle size disagree.
7703 \fn void QPainter::drawImage(const QPointF &point, const QImage &image)
7707 Draws the given \a image at the given \a point.
7711 \fn void QPainter::drawImage(const QPoint &point, const QImage &image)
7715 Draws the given \a image at the given \a point.
7719 \fn void QPainter::drawImage(const QPointF &point, const QImage &image, const QRectF &source,
7720 Qt::ImageConversionFlags flags = 0)
7724 Draws the rectangular portion \a source of the given \a image with
7725 its origin at the given \a point.
7729 \fn void QPainter::drawImage(const QPoint &point, const QImage &image, const QRect &source,
7730 Qt::ImageConversionFlags flags = 0)
7733 Draws the rectangular portion \a source of the given \a image with
7734 its origin at the given \a point.
7738 \fn void QPainter::drawImage(const QRectF &rectangle, const QImage &image)
7742 Draws the given \a image into the given \a rectangle.
7744 \note The image is scaled to fit the rectangle, if both the image and rectangle size disagree.
7748 \fn void QPainter::drawImage(const QRect &rectangle, const QImage &image)
7752 Draws the given \a image into the given \a rectangle.
7754 \note The image is scaled to fit the rectangle, if both the image and rectangle size disagree.
7758 \fn void QPainter::drawImage(int x, int y, const QImage &image,
7759 int sx, int sy, int sw, int sh,
7760 Qt::ImageConversionFlags flags)
7763 Draws an image at (\a{x}, \a{y}) by copying a part of \a image into
7766 (\a{x}, \a{y}) specifies the top-left point in the paint device that is
7767 to be drawn onto. (\a{sx}, \a{sy}) specifies the top-left point in \a
7768 image that is to be drawn. The default is (0, 0).
7770 (\a{sw}, \a{sh}) specifies the size of the image that is to be drawn.
7771 The default, (0, 0) (and negative) means all the way to the
7772 bottom-right of the image.
7776 \class QPaintEngineState
7779 \brief The QPaintEngineState class provides information about the
7780 active paint engine's current state.
7783 QPaintEngineState records which properties that have changed since
7784 the last time the paint engine was updated, as well as their
7787 Which properties that have changed can at any time be retrieved
7788 using the state() function. This function returns an instance of
7789 the QPaintEngine::DirtyFlags type which stores an OR combination
7790 of QPaintEngine::DirtyFlag values. The QPaintEngine::DirtyFlag
7791 enum defines whether a property has changed since the last update
7794 If a property is marked with a dirty flag, its current value can
7795 be retrieved using the corresponding get function:
7800 \header \o Property Flag \o Current Property Value
7801 \row \o QPaintEngine::DirtyBackground \o backgroundBrush()
7802 \row \o QPaintEngine::DirtyBackgroundMode \o backgroundMode()
7803 \row \o QPaintEngine::DirtyBrush \o brush()
7804 \row \o QPaintEngine::DirtyBrushOrigin \o brushOrigin()
7805 \row \o QPaintEngine::DirtyClipRegion \e or QPaintEngine::DirtyClipPath
7807 \row \o QPaintEngine::DirtyClipPath \o clipPath()
7808 \row \o QPaintEngine::DirtyClipRegion \o clipRegion()
7809 \row \o QPaintEngine::DirtyCompositionMode \o compositionMode()
7810 \row \o QPaintEngine::DirtyFont \o font()
7811 \row \o QPaintEngine::DirtyTransform \o transform()
7812 \row \o QPaintEngine::DirtyClipEnabled \o isClipEnabled()
7813 \row \o QPaintEngine::DirtyPen \o pen()
7814 \row \o QPaintEngine::DirtyHints \o renderHints()
7817 The QPaintEngineState class also provide the painter() function
7818 which returns a pointer to the painter that is currently updating
7821 An instance of this class, representing the current state of the
7822 active paint engine, is passed as argument to the
7823 QPaintEngine::updateState() function. The only situation in which
7824 you will have to use this class directly is when implementing your
7832 \fn QPaintEngine::DirtyFlags QPaintEngineState::state() const
7834 Returns a combination of flags identifying the set of properties
7835 that need to be updated when updating the paint engine's state
7836 (i.e. during a call to the QPaintEngine::updateState() function).
7838 \sa QPaintEngine::updateState()
7843 Returns the pen in the current paint engine state.
7845 This variable should only be used when the state() returns a
7846 combination which includes the QPaintEngine::DirtyPen flag.
7848 \sa state(), QPaintEngine::updateState()
7851 QPen QPaintEngineState::pen() const
7853 return static_cast<const QPainterState *>(this)->pen;
7857 Returns the brush in the current paint engine state.
7859 This variable should only be used when the state() returns a
7860 combination which includes the QPaintEngine::DirtyBrush flag.
7862 \sa state(), QPaintEngine::updateState()
7865 QBrush QPaintEngineState::brush() const
7867 return static_cast<const QPainterState *>(this)->brush;
7871 Returns the brush origin in the current paint engine state.
7873 This variable should only be used when the state() returns a
7874 combination which includes the QPaintEngine::DirtyBrushOrigin flag.
7876 \sa state(), QPaintEngine::updateState()
7879 QPointF QPaintEngineState::brushOrigin() const
7881 return static_cast<const QPainterState *>(this)->brushOrigin;
7885 Returns the background brush in the current paint engine state.
7887 This variable should only be used when the state() returns a
7888 combination which includes the QPaintEngine::DirtyBackground flag.
7890 \sa state(), QPaintEngine::updateState()
7893 QBrush QPaintEngineState::backgroundBrush() const
7895 return static_cast<const QPainterState *>(this)->bgBrush;
7899 Returns the background mode in the current paint engine
7902 This variable should only be used when the state() returns a
7903 combination which includes the QPaintEngine::DirtyBackgroundMode flag.
7905 \sa state(), QPaintEngine::updateState()
7908 Qt::BGMode QPaintEngineState::backgroundMode() const
7910 return static_cast<const QPainterState *>(this)->bgMode;
7914 Returns the font in the current paint engine
7917 This variable should only be used when the state() returns a
7918 combination which includes the QPaintEngine::DirtyFont flag.
7920 \sa state(), QPaintEngine::updateState()
7923 QFont QPaintEngineState::font() const
7925 return static_cast<const QPainterState *>(this)->font;
7932 Returns the matrix in the current paint engine
7935 \note It is advisable to use transform() instead of this function to
7936 preserve the properties of perspective transformations.
7938 This variable should only be used when the state() returns a
7939 combination which includes the QPaintEngine::DirtyTransform flag.
7941 \sa state(), QPaintEngine::updateState()
7944 QMatrix QPaintEngineState::matrix() const
7946 const QPainterState *st = static_cast<const QPainterState *>(this);
7948 return st->matrix.toAffine();
7954 Returns the matrix in the current paint engine state.
7956 This variable should only be used when the state() returns a
7957 combination which includes the QPaintEngine::DirtyTransform flag.
7959 \sa state(), QPaintEngine::updateState()
7963 QTransform QPaintEngineState::transform() const
7965 const QPainterState *st = static_cast<const QPainterState *>(this);
7972 Returns the clip operation in the current paint engine
7975 This variable should only be used when the state() returns a
7976 combination which includes either the QPaintEngine::DirtyClipPath
7977 or the QPaintEngine::DirtyClipRegion flag.
7979 \sa state(), QPaintEngine::updateState()
7982 Qt::ClipOperation QPaintEngineState::clipOperation() const
7984 return static_cast<const QPainterState *>(this)->clipOperation;
7990 Returns whether the coordinate of the fill have been specified
7991 as bounded by the current rendering operation and have to be
7992 resolved (about the currently rendered primitive).
7994 bool QPaintEngineState::brushNeedsResolving() const
7996 const QBrush &brush = static_cast<const QPainterState *>(this)->brush;
7997 return needsResolving(brush);
8004 Returns whether the coordinate of the stroke have been specified
8005 as bounded by the current rendering operation and have to be
8006 resolved (about the currently rendered primitive).
8008 bool QPaintEngineState::penNeedsResolving() const
8010 const QPen &pen = static_cast<const QPainterState *>(this)->pen;
8011 return needsResolving(pen.brush());
8015 Returns the clip region in the current paint engine state.
8017 This variable should only be used when the state() returns a
8018 combination which includes the QPaintEngine::DirtyClipRegion flag.
8020 \sa state(), QPaintEngine::updateState()
8023 QRegion QPaintEngineState::clipRegion() const
8025 return static_cast<const QPainterState *>(this)->clipRegion;
8029 Returns the clip path in the current paint engine state.
8031 This variable should only be used when the state() returns a
8032 combination which includes the QPaintEngine::DirtyClipPath flag.
8034 \sa state(), QPaintEngine::updateState()
8037 QPainterPath QPaintEngineState::clipPath() const
8039 return static_cast<const QPainterState *>(this)->clipPath;
8043 Returns whether clipping is enabled or not in the current paint
8046 This variable should only be used when the state() returns a
8047 combination which includes the QPaintEngine::DirtyClipEnabled
8050 \sa state(), QPaintEngine::updateState()
8053 bool QPaintEngineState::isClipEnabled() const
8055 return static_cast<const QPainterState *>(this)->clipEnabled;
8059 Returns the render hints in the current paint engine state.
8061 This variable should only be used when the state() returns a
8062 combination which includes the QPaintEngine::DirtyHints
8065 \sa state(), QPaintEngine::updateState()
8068 QPainter::RenderHints QPaintEngineState::renderHints() const
8070 return static_cast<const QPainterState *>(this)->renderHints;
8074 Returns the composition mode in the current paint engine state.
8076 This variable should only be used when the state() returns a
8077 combination which includes the QPaintEngine::DirtyCompositionMode
8080 \sa state(), QPaintEngine::updateState()
8083 QPainter::CompositionMode QPaintEngineState::compositionMode() const
8085 return static_cast<const QPainterState *>(this)->composition_mode;
8090 Returns a pointer to the painter currently updating the paint
8094 QPainter *QPaintEngineState::painter() const
8096 return static_cast<const QPainterState *>(this)->painter;
8103 Returns the opacity in the current paint engine state.
8106 qreal QPaintEngineState::opacity() const
8108 return static_cast<const QPainterState *>(this)->opacity;
8114 Sets the world transformation matrix.
8115 If \a combine is true, the specified \a transform is combined with
8116 the current matrix; otherwise it replaces the current matrix.
8118 \sa transform() setWorldTransform()
8121 void QPainter::setTransform(const QTransform &transform, bool combine )
8123 setWorldTransform(transform, combine);
8127 Returns the world transformation matrix.
8129 \sa worldTransform()
8132 const QTransform & QPainter::transform() const
8134 return worldTransform();
8139 Returns the matrix that transforms from logical coordinates to
8140 device coordinates of the platform dependent paint device.
8142 This function is \e only needed when using platform painting
8143 commands on the platform dependent handle (Qt::HANDLE), and the
8144 platform does not do transformations nativly.
8146 The QPaintEngine::PaintEngineFeature enum can be queried to
8147 determine whether the platform performs the transformations or
8150 \sa worldTransform(), QPaintEngine::hasFeature(),
8153 const QTransform & QPainter::deviceTransform() const
8155 Q_D(const QPainter);
8157 qWarning("QPainter::deviceTransform: Painter not active");
8158 return d->fakeState()->transform;
8160 return d->state->matrix;
8165 Resets any transformations that were made using translate(),
8166 scale(), shear(), rotate(), setWorldTransform(), setViewport()
8169 \sa {Coordinate Transformations}
8172 void QPainter::resetTransform()
8175 #ifdef QT_DEBUG_DRAW
8176 if (qt_show_painter_debug_output)
8177 printf("QPainter::resetMatrix()\n");
8180 qWarning("QPainter::resetMatrix: Painter not active");
8184 d->state->wx = d->state->wy = d->state->vx = d->state->vy = 0; // default view origins
8185 d->state->ww = d->state->vw = d->device->metric(QPaintDevice::PdmWidth);
8186 d->state->wh = d->state->vh = d->device->metric(QPaintDevice::PdmHeight);
8187 d->state->worldMatrix = QTransform();
8188 setMatrixEnabled(false);
8189 setViewTransformEnabled(false);
8191 d->extended->transformChanged();
8193 d->state->dirtyFlags |= QPaintEngine::DirtyTransform;
8197 Sets the world transformation matrix.
8198 If \a combine is true, the specified \a matrix is combined with the current matrix;
8199 otherwise it replaces the current matrix.
8201 \sa transform(), setTransform()
8204 void QPainter::setWorldTransform(const QTransform &matrix, bool combine )
8209 qWarning("QPainter::setWorldTransform: Painter not active");
8214 d->state->worldMatrix = matrix * d->state->worldMatrix; // combines
8216 d->state->worldMatrix = matrix; // set new matrix
8218 d->state->WxF = true;
8223 Returns the world transformation matrix.
8226 const QTransform & QPainter::worldTransform() const
8228 Q_D(const QPainter);
8230 qWarning("QPainter::worldTransform: Painter not active");
8231 return d->fakeState()->transform;
8233 return d->state->worldMatrix;
8237 Returns the transformation matrix combining the current
8238 window/viewport and world transformation.
8240 \sa setWorldTransform(), setWindow(), setViewport()
8243 QTransform QPainter::combinedTransform() const
8245 Q_D(const QPainter);
8247 qWarning("QPainter::combinedTransform: Painter not active");
8248 return QTransform();
8250 return d->state->worldMatrix * d->viewTransform();
8256 This function is used to draw \a pixmap, or a sub-rectangle of \a pixmap,
8257 at multiple positions with different scale, rotation and opacity. \a
8258 fragments is an array of \a fragmentCount elements specifying the
8259 parameters used to draw each pixmap fragment. The \a hints
8260 parameter can be used to pass in drawing hints.
8262 This function is potentially faster than multiple calls to drawPixmap(),
8263 since the backend can optimize state changes.
8265 \sa QPainter::PixmapFragment, QPainter::PixmapFragmentHint
8268 void QPainter::drawPixmapFragments(const PixmapFragment *fragments, int fragmentCount,
8269 const QPixmap &pixmap, PixmapFragmentHints hints)
8273 if (!d->engine || pixmap.isNull())
8277 for (int i = 0; i < fragmentCount; ++i) {
8278 QRectF sourceRect(fragments[i].sourceLeft, fragments[i].sourceTop,
8279 fragments[i].width, fragments[i].height);
8280 if (!(QRectF(pixmap.rect()).contains(sourceRect)))
8281 qWarning("QPainter::drawPixmapFragments - the source rect is not contained by the pixmap's rectangle");
8285 if (d->engine->isExtended()) {
8286 d->extended->drawPixmapFragments(fragments, fragmentCount, pixmap, hints);
8288 qreal oldOpacity = opacity();
8289 QTransform oldTransform = transform();
8291 for (int i = 0; i < fragmentCount; ++i) {
8292 QTransform transform = oldTransform;
8295 if (fragments[i].rotation == 0) {
8296 xOffset = fragments[i].x;
8297 yOffset = fragments[i].y;
8299 transform.translate(fragments[i].x, fragments[i].y);
8300 transform.rotate(fragments[i].rotation);
8302 setOpacity(oldOpacity * fragments[i].opacity);
8303 setTransform(transform);
8305 qreal w = fragments[i].scaleX * fragments[i].width;
8306 qreal h = fragments[i].scaleY * fragments[i].height;
8307 QRectF sourceRect(fragments[i].sourceLeft, fragments[i].sourceTop,
8308 fragments[i].width, fragments[i].height);
8309 drawPixmap(QRectF(-0.5 * w + xOffset, -0.5 * h + yOffset, w, h), pixmap, sourceRect);
8312 setOpacity(oldOpacity);
8313 setTransform(oldTransform);
8319 \class QPainter::PixmapFragment
8321 \brief This class is used in conjunction with the
8322 QPainter::drawPixmapFragments() function to specify how a pixmap, or
8323 sub-rect of a pixmap, is drawn.
8325 The \a sourceLeft, \a sourceTop, \a width and \a height variables are used
8326 as a source rectangle within the pixmap passed into the
8327 QPainter::drawPixmapFragments() function. The variables \a x, \a y, \a
8328 width and \a height are used to calculate the target rectangle that is
8329 drawn. \a x and \a y denotes the center of the target rectangle. The \a
8330 width and \a height in the target rectangle is scaled by the \a scaleX and
8331 \a scaleY values. The resulting target rectangle is then rotated \a
8332 rotation degrees around the \a x, \a y center point.
8334 \sa QPainter::drawPixmapFragments()
8340 This is a convenience function that returns a QPainter::PixmapFragment that is
8341 initialized with the \a pos, \a sourceRect, \a scaleX, \a scaleY, \a
8342 rotation, \a opacity parameters.
8345 QPainter::PixmapFragment QPainter::PixmapFragment::create(const QPointF &pos, const QRectF &sourceRect,
8346 qreal scaleX, qreal scaleY, qreal rotation,
8349 PixmapFragment fragment = {pos.x(), pos.y(), sourceRect.x(), sourceRect.y(), sourceRect.width(),
8350 sourceRect.height(), scaleX, scaleY, rotation, opacity};
8355 \variable QPainter::PixmapFragment::x
8356 \brief the x coordinate of center point in the target rectangle.
8360 \variable QPainter::PixmapFragment::y
8361 \brief the y coordinate of the center point in the target rectangle.
8365 \variable QPainter::PixmapFragment::sourceLeft
8366 \brief the left coordinate of the source rectangle.
8370 \variable QPainter::PixmapFragment::sourceTop
8371 \brief the top coordinate of the source rectangle.
8375 \variable QPainter::PixmapFragment::width
8377 \brief the width of the source rectangle and is used to calculate the width
8378 of the target rectangle.
8382 \variable QPainter::PixmapFragment::height
8384 \brief the height of the source rectangle and is used to calculate the
8385 height of the target rectangle.
8389 \variable QPainter::PixmapFragment::scaleX
8390 \brief the horizontal scale of the target rectangle.
8394 \variable QPainter::PixmapFragment::scaleY
8395 \brief the vertical scale of the target rectangle.
8399 \variable QPainter::PixmapFragment::rotation
8401 \brief the rotation of the target rectangle in degrees. The target
8402 rectangle is rotated after it has been scaled.
8406 \variable QPainter::PixmapFragment::opacity
8408 \brief the opacity of the target rectangle, where 0.0 is fully transparent
8409 and 1.0 is fully opaque.
8415 \enum QPainter::PixmapFragmentHint
8417 \value OpaqueHint Indicates that the pixmap fragments to be drawn are
8418 opaque. Opaque fragments are potentially faster to draw.
8420 \sa QPainter::drawPixmapFragments(), QPainter::PixmapFragment
8423 void qt_draw_helper(QPainterPrivate *p, const QPainterPath &path, QPainterPrivate::DrawOperation operation)
8425 p->draw_helper(path, operation);