QQuickPaintedItem Class

The QQuickPaintedItem class provides a way to use the QPainter API in the QML Scene Graph. More...

Header: #include <QQuickPaintedItem>
qmake: QT += quick
Inherits: QQuickItem

Public Types

enum PerformanceHint { FastFBOResizing }
flags PerformanceHints
enum RenderTarget { Image, FramebufferObject, InvertedYFramebufferObject }

Properties

Public Functions

QQuickPaintedItem(QQuickItem *parent = nullptr)
virtual ~QQuickPaintedItem() override
bool antialiasing() const
QColor fillColor() const
bool mipmap() const
bool opaquePainting() const
virtual void paint(QPainter *painter) = 0
QQuickPaintedItem::PerformanceHints performanceHints() const
QQuickPaintedItem::RenderTarget renderTarget() const
void setAntialiasing(bool enable)
void setFillColor(const QColor &)
void setMipmap(bool enable)
void setOpaquePainting(bool opaque)
void setPerformanceHint(QQuickPaintedItem::PerformanceHint hint, bool enabled = true)
void setPerformanceHints(QQuickPaintedItem::PerformanceHints hints)
void setRenderTarget(QQuickPaintedItem::RenderTarget target)
void setTextureSize(const QSize &size)
QSize textureSize() const
void update(const QRect &rect = QRect())

Reimplemented Public Functions

virtual bool isTextureProvider() const override
virtual QSGTextureProvider * textureProvider() const override

Signals

void fillColorChanged()
void renderTargetChanged()
void textureSizeChanged()

Static Public Members

const QMetaObject staticMetaObject
  • 9 static public members inherited from QObject

Reimplemented Protected Functions

virtual void itemChange(QQuickItem::ItemChange change, const QQuickItem::ItemChangeData &value) override
virtual void releaseResources() override
virtual QSGNode * updatePaintNode(QSGNode *oldNode, QQuickItem::UpdatePaintNodeData *data) override
  • 33 protected functions inherited from QQuickItem
  • 9 protected functions inherited from QObject

Additional Inherited Members

  • 1 public slot inherited from QQuickItem
  • 1 public slot inherited from QObject
  • 33 protected functions inherited from QQuickItem
  • 9 protected functions inherited from QObject

Detailed Description

The QQuickPaintedItem class provides a way to use the QPainter API in the QML Scene Graph.

The QQuickPaintedItem makes it possible to use the QPainter API with the QML Scene Graph. It sets up a textured rectangle in the Scene Graph and uses a QPainter to paint onto the texture. The render target can be either a QImage or, when OpenGL is in use, a QOpenGLFramebufferObject. When the render target is a QImage, QPainter first renders into the image then the content is uploaded to the texture. When a QOpenGLFramebufferObject is used, QPainter paints directly onto the texture. Call update() to trigger a repaint.

To enable QPainter to do anti-aliased rendering, use setAntialiasing().

To write your own painted item, you first create a subclass of QQuickPaintedItem, and then start by implementing its only pure virtual public function: paint(), which implements the actual painting. The painting will be inside the rectangle spanning from 0,0 to width(),height().

Note: It important to understand the performance implications such items can incur. See QQuickPaintedItem::RenderTarget and QQuickPaintedItem::renderTarget.

Member Type Documentation

enum QQuickPaintedItem::PerformanceHintflags QQuickPaintedItem::PerformanceHints

This enum describes flags that you can enable to improve rendering performance in QQuickPaintedItem. By default, none of these flags are set.

Constant Value Description
QQuickPaintedItem::FastFBOResizing 0x1 Resizing an FBO can be a costly operation on a few OpenGL driver implementations. To work around this, one can set this flag to let the QQuickPaintedItem allocate one large framebuffer object and instead draw into a subregion of it. This saves the resize at the cost of using more memory. Please note that this is not a common problem.

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

enum QQuickPaintedItem::RenderTarget

This enum describes QQuickPaintedItem's render targets. The render target is the surface QPainter paints onto before the item is rendered on screen.

Constant Value Description
QQuickPaintedItem::Image 0 The default; QPainter paints into a QImage using the raster paint engine. The image's content needs to be uploaded to graphics memory afterward, this operation can potentially be slow if the item is large. This render target allows high quality anti-aliasing and fast item resizing.
QQuickPaintedItem::FramebufferObject 1 QPainter paints into a QOpenGLFramebufferObject using the GL paint engine. Painting can be faster as no texture upload is required, but anti-aliasing quality is not as good as if using an image. This render target allows faster rendering in some cases, but you should avoid using it if the item is resized often.
QQuickPaintedItem::InvertedYFramebufferObject 2 Exactly as for FramebufferObject above, except once the painting is done, prior to rendering the painted image is flipped about the x-axis so that the top-most pixels are now at the bottom. Since this is done with the OpenGL texture coordinates it is a much faster way to achieve this effect than using a painter transform.

See also setRenderTarget().

Property Documentation

fillColor : QColor

This property holds the item's background fill color.

By default, the fill color is set to Qt::transparent.

Access functions:

QColor fillColor() const
void setFillColor(const QColor &)

Notifier signal:

void fillColorChanged()

renderTarget : RenderTarget

This property holds the item's render target.

This property defines which render target the QPainter renders into, it can be either QQuickPaintedItem::Image, QQuickPaintedItem::FramebufferObject or QQuickPaintedItem::InvertedYFramebufferObject.

Each has certain benefits, typically performance versus quality. Using a framebuffer object avoids a costly upload of the image contents to the texture in graphics memory, while using an image enables high quality anti-aliasing.

Warning: Resizing a framebuffer object is a costly operation, avoid using the QQuickPaintedItem::FramebufferObject render target if the item gets resized often.

By default, the render target is QQuickPaintedItem::Image.

Note: Some Qt Quick backends may not support all render target options. For example, it is likely that non-OpenGL backends will lack support for QQuickPaintedItem::FramebufferObject and QQuickPaintedItem::InvertedYFramebufferObject. Requesting these will then be ignored.

Access functions:

QQuickPaintedItem::RenderTarget renderTarget() const
void setRenderTarget(QQuickPaintedItem::RenderTarget target)

Notifier signal:

void renderTargetChanged()

textureSize : QSize

Defines the size of the texture.

Changing the texture's size does not affect the coordinate system used in paint(). A scale factor is instead applied so painting should still happen inside 0,0 to width(),height().

By default, the texture size will have the same size as this item.

Note: If the item is on a window with a device pixel ratio different from 1, this scale factor will be implicitly applied to the texture size.

Access functions:

QSize textureSize() const
void setTextureSize(const QSize &size)

Notifier signal:

void textureSizeChanged()

Member Function Documentation

QQuickPaintedItem::QQuickPaintedItem(QQuickItem *parent = nullptr)

Constructs a QQuickPaintedItem with the given parent item.

[override virtual] QQuickPaintedItem::~QQuickPaintedItem()

Destroys the QQuickPaintedItem.

bool QQuickPaintedItem::antialiasing() const

Returns true if antialiased painting is enabled; otherwise, false is returned.

By default, antialiasing is not enabled.

See also setAntialiasing().

[override virtual] bool QQuickPaintedItem::isTextureProvider() const

Reimplemented from QQuickItem::isTextureProvider().

[override virtual protected] void QQuickPaintedItem::itemChange(QQuickItem::ItemChange change, const QQuickItem::ItemChangeData &value)

Reimplemented from QQuickItem::itemChange().

bool QQuickPaintedItem::mipmap() const

Returns true if mipmaps are enabled; otherwise, false is returned.

By default, mipmapping is not enabled.

See also setMipmap().

bool QQuickPaintedItem::opaquePainting() const

Returns true if this item is opaque; otherwise, false is returned.

By default, painted items are not opaque.

See also setOpaquePainting().

[pure virtual] void QQuickPaintedItem::paint(QPainter *painter)

This function, which is usually called by the QML Scene Graph, paints the contents of an item in local coordinates.

The underlying texture will have a size defined by textureSize when set, or the item's size, multiplied by the window's device pixel ratio.

The function is called after the item has been filled with the fillColor.

Reimplement this function in a QQuickPaintedItem subclass to provide the item's painting implementation, using painter.

Note: The QML Scene Graph uses two separate threads, the main thread does things such as processing events or updating animations while a second thread does the actual OpenGL rendering. As a consequence, paint() is not called from the main GUI thread but from the GL enabled renderer thread. At the moment paint() is called, the GUI thread is blocked and this is therefore thread-safe.

Warning: Extreme caution must be used when creating QObjects, emitting signals, starting timers and similar inside this function as these will have affinity to the rendering thread.

See also width(), height(), and textureSize.

QQuickPaintedItem::PerformanceHints QQuickPaintedItem::performanceHints() const

Returns the performance hints.

By default, no performance hint is enabled.

See also setPerformanceHint() and setPerformanceHints().

[override virtual protected] void QQuickPaintedItem::releaseResources()

Reimplemented from QQuickItem::releaseResources().

void QQuickPaintedItem::setAntialiasing(bool enable)

If enable is true, antialiased painting is enabled.

By default, antialiasing is not enabled.

See also antialiasing().

void QQuickPaintedItem::setMipmap(bool enable)

If enable is true, mipmapping is enabled on the associated texture.

Mipmapping increases rendering speed and reduces aliasing artifacts when the item is scaled down.

By default, mipmapping is not enabled.

See also mipmap().

void QQuickPaintedItem::setOpaquePainting(bool opaque)

If opaque is true, the item is opaque; otherwise, it is considered as translucent.

Opaque items are not blended with the rest of the scene, you should set this to true if the content of the item is opaque to speed up rendering.

By default, painted items are not opaque.

See also opaquePainting().

void QQuickPaintedItem::setPerformanceHint(QQuickPaintedItem::PerformanceHint hint, bool enabled = true)

Sets the given performance hint on the item if enabled is true; otherwise clears the performance hint.

By default, no performance hint is enabled/

See also setPerformanceHints() and performanceHints().

void QQuickPaintedItem::setPerformanceHints(QQuickPaintedItem::PerformanceHints hints)

Sets the performance hints to hints

By default, no performance hint is enabled/

See also setPerformanceHint() and performanceHints().

[override virtual] QSGTextureProvider *QQuickPaintedItem::textureProvider() const

Reimplemented from QQuickItem::textureProvider().

void QQuickPaintedItem::update(const QRect &rect = QRect())

Schedules a redraw of the area covered by rect in this item. You can call this function whenever your item needs to be redrawn, such as if it changes appearance or size.

This function does not cause an immediate paint; instead it schedules a paint request that is processed by the QML Scene Graph when the next frame is rendered. The item will only be redrawn if it is visible.

See also paint().

[override virtual protected] QSGNode *QQuickPaintedItem::updatePaintNode(QSGNode *oldNode, QQuickItem::UpdatePaintNodeData *data)

Reimplemented from QQuickItem::updatePaintNode().

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.12/qquickpainteditem.html