The QQuickRenderTarget class provides an opaque container for native graphics resources specifying a render target, and associated metadata. More...

#include <qquickrendertarget.h>

Collaboration diagram for QQuickRenderTarget:

Public Member Functions
	QQuickRenderTarget ()
	Constructs a default QQuickRenderTarget that does not reference any native objects.

	~QQuickRenderTarget ()
	Destructor.

	QQuickRenderTarget (const QQuickRenderTarget &other)

QQuickRenderTarget &	operator= (const QQuickRenderTarget &other)

bool	isNull () const

qreal	devicePixelRatio () const

void	setDevicePixelRatio (qreal ratio)
	Sets the device pixel ratio for this render target to ratio.

bool	mirrorVertically () const

void	setMirrorVertically (bool enable)
	Sets the size of the render target contents should be mirrored vertically to enable when drawing.

Static Public Member Functions
static QQuickRenderTarget	fromRhiRenderTarget (QRhiRenderTarget *renderTarget)

static QQuickRenderTarget	fromPaintDevice (QPaintDevice *device)

Friends
class	QQuickRenderTargetPrivate

bool	operator== (const QQuickRenderTarget &lhs, const QQuickRenderTarget &rhs) noexcept

bool	operator!= (const QQuickRenderTarget &lhs, const QQuickRenderTarget &rhs) noexcept

Detailed Description

The QQuickRenderTarget class provides an opaque container for native graphics resources specifying a render target, and associated metadata.

Since: 6.0 \inmodule QtQuick

See also: QQuickWindow::setRenderTarget(), QQuickGraphicsDevice

Definition at line 24 of file qquickrendertarget.h.

Constructor & Destructor Documentation

◆ QQuickRenderTarget() [1/2]

QQuickRenderTarget::QQuickRenderTarget ( )

Constructs a default QQuickRenderTarget that does not reference any native objects.

Definition at line 43 of file qquickrendertarget.cpp.

◆ ~QQuickRenderTarget()

QQuickRenderTarget::~QQuickRenderTarget ( )

Destructor.

Definition at line 77 of file qquickrendertarget.cpp.

References QBasicAtomicInteger< T >::deref(), and QQuickRenderTargetPrivate::ref.

Here is the call graph for this function:

◆ QQuickRenderTarget() [2/2]

QQuickRenderTarget::QQuickRenderTarget ( const QQuickRenderTarget & other )

Definition at line 59 of file qquickrendertarget.cpp.

References QBasicAtomicInteger< T >::ref(), and QQuickRenderTargetPrivate::ref.

Here is the call graph for this function:

Member Function Documentation

◆ devicePixelRatio()

qreal QQuickRenderTarget::devicePixelRatio ( ) const

Returns: the device pixel ratio for the render target. This is the ratio between {device pixels} and {device independent pixels}.

The default device pixel ratio is 1.0.

Since: 6.3

See also: setDevicePixelRatio()

Definition at line 102 of file qquickrendertarget.cpp.

References QQuickRenderTargetPrivate::devicePixelRatio.

◆ fromPaintDevice()

QQuickRenderTarget QQuickRenderTarget::fromPaintDevice ( QPaintDevice * device )

static

Returns: a new QQuickRenderTarget referencing a paint device object specified by device.

This option of redirecting rendering to a QPaintDevice is available only when running with the software backend of Qt Quick.

Note: The QQuickRenderTarget does not take ownship of device, it is the caller's responsibility to ensure the object exists as long as necessary.

Since: 6.4

See also: QQuickWindow::setRenderTarget(), QQuickRenderControl

Definition at line 671 of file qquickrendertarget.cpp.

References d, device, and QQuickRenderTargetPrivate::get().

Here is the call graph for this function:

◆ fromRhiRenderTarget()

QQuickRenderTarget QQuickRenderTarget::fromRhiRenderTarget ( QRhiRenderTarget * renderTarget )

static

Returns: a new QQuickRenderTarget referencing an OpenGL texture object specified by textureId.

format specifies the native internal format of the texture. Only texture formats that are supported by Qt's rendering infrastructure should be used.

pixelSize specifies the size of the image, in pixels. Currently only 2D textures are supported.

sampleCount specific the number of samples. 0 or 1 means no multisampling, while a value like 4 or 8 states that the native object is a multisample texture.

The texture is used as the first color attachment of the render target used by the Qt Quick scenegraph. A depth-stencil buffer, if applicable, is created and used automatically.

The OpenGL object name textureId must be a valid name in the rendering context used by the Qt Quick scenegraph.

Note: the resulting QQuickRenderTarget does not own any native resources, it merely contains references and the associated metadata of the size and sample count. It is the caller's responsibility to ensure that the native resource exists as long as necessary.

Since: 6.4

See also: QQuickWindow::setRenderTarget(), QQuickRenderControl

Returns: a new QQuickRenderTarget referencing a D3D11 texture object specified by texture.

format specifies the DXGI_FORMAT of the texture. Only texture formats that are supported by Qt's rendering infrastructure should be used.

pixelSize specifies the size of the image, in pixels. Currently only 2D textures are supported.

sampleCount specific the number of samples. 0 or 1 means no multisampling, while a value like 4 or 8 states that the native object is a multisample texture.

The texture is used as the first color attachment of the render target used by the Qt Quick scenegraph. A depth-stencil buffer, if applicable, is created and used automatically.

Note: the resulting QQuickRenderTarget does not own any native resources, it merely contains references and the associated metadata of the size and sample count. It is the caller's responsibility to ensure that the native resource exists as long as necessary.

Since: 6.4

See also: QQuickWindow::setRenderTarget(), QQuickRenderControl

Returns: a new QQuickRenderTarget referencing a Metal texture object specified by texture.

format specifies the MTLPixelFormat of the texture. Only texture formats that are supported by Qt's rendering infrastructure should be used.

pixelSize specifies the size of the image, in pixels. Currently only 2D textures are supported.

sampleCount specific the number of samples. 0 or 1 means no multisampling, while a value like 4 or 8 states that the native object is a multisample texture.

The texture is used as the first color attachment of the render target used by the Qt Quick scenegraph. A depth-stencil buffer, if applicable, is created and used automatically.

Note: the resulting QQuickRenderTarget does not own any native resources, it merely contains references and the associated metadata of the size and sample count. It is the caller's responsibility to ensure that the native resource exists as long as necessary.

Since: 6.4

See also: QQuickWindow::setRenderTarget(), QQuickRenderControl

Returns: a new QQuickRenderTarget referencing a Vulkan image object specified by image. The current layout of the image must be provided as well.

format specifies the VkFormat of the image. Only image formats that are supported by Qt's rendering infrastructure should be used.

pixelSize specifies the size of the image, in pixels. Currently only 2D textures are supported.

sampleCount specific the number of samples. 0 or 1 means no multisampling, while a value like 4 or 8 states that the native object is a multisample texture.

The image is used as the first color attachment of the render target used by the Qt Quick scenegraph. A depth-stencil buffer, if applicable, is created and used automatically.

Note: the resulting QQuickRenderTarget does not own any native resources, it merely contains references and the associated metadata of the size and sample count. It is the caller's responsibility to ensure that the native resource exists as long as necessary.

Since: 6.4

See also: QQuickWindow::setRenderTarget(), QQuickRenderControl

Returns: a new QQuickRenderTarget referencing an existing renderTarget.

renderTarget will in most cases be a QRhiTextureRenderTarget, which allows directing the Qt Quick scene's rendering into a QRhiTexture.

Note: the resulting QQuickRenderTarget does not own renderTarget and any underlying native resources, it merely contains references and the associated metadata of the size and sample count. It is the caller's responsibility to ensure that the referenced resources exists as long as necessary.