QPaintEngine

The QPaintEngine class provides an abstract definition of how QPainter draws to a given device on a given platform. More

Inheritance diagram of PySide2.QtGui.QPaintEngine

Synopsis

Functions

Virtual functions

Detailed Description

Qt provides several premade implementations of QPaintEngine for the different painter backends we support. The primary paint engine provided is the raster paint engine, which contains a software rasterizer which supports the full feature set on all supported platforms. This is the default for painting on QWidget -based classes in e.g. on Windows, X11 and macOS , it is the backend for painting on QImage and it is used as a fallback for paint engines that do not support a certain capability. In addition we provide QPaintEngine implementations for OpenGL (accessible through QGLWidget ) and printing (which allows using QPainter to draw on a QPrinter object).

If one wants to use QPainter to draw to a different backend, one must subclass QPaintEngine and reimplement all its virtual functions. The QPaintEngine implementation is then made available by subclassing QPaintDevice and reimplementing the virtual function paintEngine() .

QPaintEngine is created and owned by the QPaintDevice that created it.

class QPaintEngine([features=QPaintEngine.PaintEngineFeatures()])
param features

PaintEngineFeatures

Creates a paint engine with the featureset specified by caps .

PySide2.QtGui.QPaintEngine.PaintEngineFeature

This enum is used to describe the features or capabilities that the paint engine has. If a feature is not supported by the engine, QPainter will do a best effort to emulate that feature through other means and pass on an alpha blended QImage to the engine with the emulated results. Some features cannot be emulated: and .

Constant

Description

QPaintEngine.AlphaBlend

The engine can alpha blend primitives.

QPaintEngine.Antialiasing

The engine can use antialising to improve the appearance of rendered primitives.

QPaintEngine.BlendModes

The engine supports blending modes.

QPaintEngine.BrushStroke

The engine supports drawing strokes that contain brushes as fills, not just solid colors (e.g. a dashed gradient line of width 2).

QPaintEngine.ConicalGradientFill

The engine supports conical gradient fills.

QPaintEngine.ConstantOpacity

The engine supports the feature provided by setOpacity() .

QPaintEngine.LinearGradientFill

The engine supports linear gradient fills.

QPaintEngine.MaskedBrush

The engine is capable of rendering brushes that has a texture with an alpha channel or a mask.

QPaintEngine.ObjectBoundingModeGradients

The engine has native support for gradients with coordinate mode ObjectBoundingMode . Otherwise, if is supported, object bounding mode gradients are converted to gradients with coordinate mode LogicalMode and a brush transform for the coordinate mapping.

QPaintEngine.PainterPaths

The engine has path support.

QPaintEngine.PaintOutsidePaintEvent

The engine is capable of painting outside of paint events.

QPaintEngine.PatternBrush

The engine is capable of rendering brushes with the brush patterns specified in BrushStyle .

QPaintEngine.PatternTransform

The engine has support for transforming brush patterns.

QPaintEngine.PerspectiveTransform

The engine has support for performing perspective transformations on primitives.

QPaintEngine.PixmapTransform

The engine can transform pixmaps, including rotation and shearing.

QPaintEngine.PorterDuff

The engine supports Porter-Duff operations

QPaintEngine.PrimitiveTransform

The engine has support for transforming drawing primitives.

QPaintEngine.RadialGradientFill

The engine supports radial gradient fills.

QPaintEngine.RasterOpModes

The engine supports bitwise raster operations.

QPaintEngine.AllFeatures

All of the above features. This enum value is usually used as a bit mask.

PySide2.QtGui.QPaintEngine.DirtyFlag

Constant

Description

QPaintEngine.DirtyPen

The pen is dirty and needs to be updated.

QPaintEngine.DirtyBrush

The brush is dirty and needs to be updated.

QPaintEngine.DirtyBrushOrigin

The brush origin is dirty and needs to updated.

QPaintEngine.DirtyFont

The font is dirty and needs to be updated.

QPaintEngine.DirtyBackground

The background is dirty and needs to be updated.

QPaintEngine.DirtyBackgroundMode

The background mode is dirty and needs to be updated.

QPaintEngine.DirtyTransform

The transform is dirty and needs to be updated.

QPaintEngine.DirtyClipRegion

The clip region is dirty and needs to be updated.

QPaintEngine.DirtyClipPath

The clip path is dirty and needs to be updated.

QPaintEngine.DirtyHints

The render hints is dirty and needs to be updated.

QPaintEngine.DirtyCompositionMode

The composition mode is dirty and needs to be updated.

QPaintEngine.DirtyClipEnabled

Whether clipping is enabled or not is dirty and needs to be updated.

QPaintEngine.DirtyOpacity

The constant opacity has changed and needs to be updated as part of the state change in updateState() .

QPaintEngine.AllDirty

Convenience enum used internally.

These types are used by QPainter to trigger lazy updates of the various states in the QPaintEngine using updateState() .

A paint engine must update every dirty state.

PySide2.QtGui.QPaintEngine.PolygonDrawMode

Constant

Description

QPaintEngine.OddEvenMode

The polygon should be drawn using OddEven fill rule.

QPaintEngine.WindingMode

The polygon should be drawn using Winding fill rule.

QPaintEngine.ConvexMode

The polygon is a convex polygon and can be drawn using specialized algorithms where available.

QPaintEngine.PolylineMode

Only the outline of the polygon should be drawn.

PySide2.QtGui.QPaintEngine.Type

Constant

Description

QPaintEngine.X11

QPaintEngine.Windows

QPaintEngine.MacPrinter

QPaintEngine.CoreGraphics

macOS ‘s Quartz2D ()

QPaintEngine.QuickDraw

macOS ‘s

QPaintEngine.QWindowSystem

Qt for Embedded Linux

QPaintEngine.PostScript

(No longer supported)

QPaintEngine.OpenGL

QPaintEngine.Picture

QPicture format

QPaintEngine.SVG

Scalable Vector Graphics XML format

QPaintEngine.Raster

QPaintEngine.Direct3D

Windows only, based engine

QPaintEngine.Pdf

Portable Document Format

QPaintEngine.OpenVG

QPaintEngine.User

First user type ID

QPaintEngine.MaxUser

Last user type ID

QPaintEngine.OpenGL2

QPaintEngine.PaintBuffer

QPaintEngine.Blitter

QPaintEngine.Direct2D

Windows only, based engine

PySide2.QtGui.QPaintEngine.state
PySide2.QtGui.QPaintEngine.gccaps
PySide2.QtGui.QPaintEngine.active
PySide2.QtGui.QPaintEngine.selfDestruct
PySide2.QtGui.QPaintEngine.extended
PySide2.QtGui.QPaintEngine.begin(pdev)
Parameters

pdevQPaintDevice

Return type

bool

Reimplement this function to initialise your paint engine when painting is to start on the paint device pdev . Return true if the initialization was successful; otherwise return false.

See also

end() isActive()

PySide2.QtGui.QPaintEngine.clearDirty(df)
Parameters

dfDirtyFlags

PySide2.QtGui.QPaintEngine.coordinateOffset()
Return type

QPoint

Returns the offset from the painters origo to the engines origo. This value is used by QPainter for engines who have internal double buffering.

This function only makes sense when the engine is active.

PySide2.QtGui.QPaintEngine.drawEllipse(r)
Parameters

rQRect

PySide2.QtGui.QPaintEngine.drawEllipse(r)
Parameters

rQRectF

PySide2.QtGui.QPaintEngine.drawImage(r, pm, sr[, flags=Qt.AutoColor])
Parameters
  • rQRectF

  • pmQImage

  • srQRectF

  • flagsImageConversionFlags

Reimplement this function to draw the part of the image specified by the sr rectangle in the given rectangle using the given conversion flags flags , to convert it to a pixmap.

PySide2.QtGui.QPaintEngine.drawLines(lines, lineCount)
Parameters
  • linesQLine

  • lineCountint

This is an overloaded function.

The default implementation converts the first lineCount lines in lines to a QLineF and calls the floating point version of this function.

PySide2.QtGui.QPaintEngine.drawLines(lines, lineCount)
Parameters
  • linesQLineF

  • lineCountint

The default implementation splits the list of lines in lines into lineCount separate calls to drawPath() or drawPolygon() depending on the feature set of the paint engine.

PySide2.QtGui.QPaintEngine.drawPath(path)
Parameters

pathQPainterPath

The default implementation ignores the path and does nothing.

PySide2.QtGui.QPaintEngine.drawPixmap(r, pm, sr)
Parameters
  • rQRectF

  • pmQPixmap

  • srQRectF

Reimplement this function to draw the part of the pm specified by the sr rectangle in the given r .

PySide2.QtGui.QPaintEngine.drawPoints(points, pointCount)
Parameters
  • pointsQPoint

  • pointCountint

Draws the first pointCount points in the buffer points

The default implementation converts the first pointCount QPoints in points to QPointFs and calls the floating point version of drawPoints .

PySide2.QtGui.QPaintEngine.drawPoints(points, pointCount)
Parameters
  • pointsQPointF

  • pointCountint

Draws the first pointCount points in the buffer points

PySide2.QtGui.QPaintEngine.drawPolygon(points, pointCount, mode)
Parameters

This is an overloaded function.

Reimplement this virtual function to draw the polygon defined by the pointCount first points in points , using mode mode .

Note

At least one of the drawPolygon() functions must be reimplemented.

PySide2.QtGui.QPaintEngine.drawPolygon(points, pointCount, mode)
Parameters

Reimplement this virtual function to draw the polygon defined by the pointCount first points in points , using mode mode .

Note

At least one of the functions must be reimplemented.

PySide2.QtGui.QPaintEngine.drawRects(rects, rectCount)
Parameters
  • rectsQRect

  • rectCountint

This is an overloaded function.

The default implementation converts the first rectCount rectangles in the buffer rects to a QRectF and calls the floating point version of this function.

PySide2.QtGui.QPaintEngine.drawRects(rects, rectCount)
Parameters
  • rectsQRectF

  • rectCountint

Draws the first rectCount rectangles in the buffer rects . The default implementation of this function calls drawPath() or drawPolygon() depending on the feature set of the paint engine.

PySide2.QtGui.QPaintEngine.drawTextItem(p, textItem)
Parameters

This function draws the text item textItem at position p . The default implementation of this function converts the text to a QPainterPath and paints the resulting path.

PySide2.QtGui.QPaintEngine.drawTiledPixmap(r, pixmap, s)
Parameters
  • rQRectF

  • pixmapQPixmap

  • sQPointF

Reimplement this function to draw the pixmap in the given rect , starting at the given p . The pixmap will be drawn repeatedly until the rect is filled.

PySide2.QtGui.QPaintEngine.end()
Return type

bool

Reimplement this function to finish painting on the current paint device. Return true if painting was finished successfully; otherwise return false.

See also

begin() isActive()

PySide2.QtGui.QPaintEngine.hasFeature(feature)
Parameters

featurePaintEngineFeatures

Return type

bool

Returns true if the paint engine supports the specified feature ; otherwise returns false .

PySide2.QtGui.QPaintEngine.isActive()
Return type

bool

Returns true if the paint engine is actively drawing; otherwise returns false .

See also

setActive()

PySide2.QtGui.QPaintEngine.isExtended()
Return type

bool

PySide2.QtGui.QPaintEngine.paintDevice()
Return type

QPaintDevice

Returns the device that this engine is painting on, if painting is active; otherwise returns None .

PySide2.QtGui.QPaintEngine.painter()
Return type

QPainter

Returns the paint engine’s painter.

PySide2.QtGui.QPaintEngine.setActive(newState)
Parameters

newStatebool

Sets the active state of the paint engine to state .

See also

isActive()

PySide2.QtGui.QPaintEngine.setDirty(df)
Parameters

dfDirtyFlags

PySide2.QtGui.QPaintEngine.setSystemClip(baseClip)
Parameters

baseClipQRegion

Sets the system clip for this engine. The system clip defines the basis area that the engine has to draw in. All clips that are set will be an intersection with the system clip.

Reset the systemclip to no clip by setting an empty region.

PySide2.QtGui.QPaintEngine.setSystemRect(rect)
Parameters

rectQRect

Sets the target rect for drawing within the backing store. This function should ONLY be used by the backing store.

PySide2.QtGui.QPaintEngine.syncState()
PySide2.QtGui.QPaintEngine.systemClip()
Return type

QRegion

Returns the system clip. The system clip is read only while the painter is active. An empty region indicates that system clip is not in use.

PySide2.QtGui.QPaintEngine.systemRect()
Return type

QRect

Retrieves the rect for drawing within the backing store. This function should ONLY be used by the backing store.

PySide2.QtGui.QPaintEngine.testDirty(df)
Parameters

dfDirtyFlags

Return type

bool

PySide2.QtGui.QPaintEngine.type()
Return type

Type

Reimplement this function to return the paint engine Type .

PySide2.QtGui.QPaintEngine.updateState(state)
Parameters

stateQPaintEngineState

Reimplement this function to update the state of a paint engine.

When implemented, this function is responsible for checking the paint engine’s current state and update the properties that are changed. Use the state() function to find out which properties that must be updated, then use the corresponding get function to retrieve the current values for the given properties.