QQuickRenderTarget Class
The QQuickRenderTarget class provides an opaque container for native graphics resources specifying a render target, and associated metadata. More...
| Header: | #include <QQuickRenderTarget> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Quick) target_link_libraries(mytarget PRIVATE Qt6::Quick) |
| qmake: | QT += quick |
| Since: | Qt 6.0 |
Public Functions
| QQuickRenderTarget() | |
| ~QQuickRenderTarget() | |
| qreal | devicePixelRatio() const |
| bool | isNull() const |
| bool | mirrorVertically() const |
| void | setDevicePixelRatio(qreal ratio) |
| void | setMirrorVertically(bool enable) |
Static Public Members
| QQuickRenderTarget | fromD3D11Texture(void *texture, uint format, const QSize &pixelSize, int sampleCount = 1) |
| QQuickRenderTarget | fromD3D11Texture(void *texture, const QSize &pixelSize, int sampleCount = 1) |
| QQuickRenderTarget | fromMetalTexture(MTLTexture *texture, uint format, const QSize &pixelSize, int sampleCount = 1) |
| QQuickRenderTarget | fromMetalTexture(MTLTexture *texture, const QSize &pixelSize, int sampleCount = 1) |
| QQuickRenderTarget | fromOpenGLRenderBuffer(uint renderbufferId, const QSize &pixelSize, int sampleCount = 1) |
| QQuickRenderTarget | fromOpenGLTexture(uint textureId, uint format, const QSize &pixelSize, int sampleCount = 1) |
| QQuickRenderTarget | fromOpenGLTexture(uint textureId, const QSize &pixelSize, int sampleCount = 1) |
| QQuickRenderTarget | fromPaintDevice(QPaintDevice *device) |
| QQuickRenderTarget | fromVulkanImage(VkImage image, VkImageLayout layout, VkFormat format, const QSize &pixelSize, int sampleCount = 1) |
| QQuickRenderTarget | fromVulkanImage(VkImage image, VkImageLayout layout, const QSize &pixelSize, int sampleCount = 1) |
Related Non-Members
| bool | operator!=(const QQuickRenderTarget &a, const QQuickRenderTarget &b) |
| bool | operator==(const QQuickRenderTarget &a, const QQuickRenderTarget &b) |
See also QQuickWindow::setRenderTarget() and QQuickGraphicsDevice.
Member Function Documentation
QQuickRenderTarget::QQuickRenderTarget()
Constructs a default QQuickRenderTarget that does not reference any native objects.
QQuickRenderTarget::~QQuickRenderTarget()
Destructor.
[since 6.3] 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.
This function was introduced in Qt 6.3.
See also setDevicePixelRatio().
[static, since 6.4] QQuickRenderTarget QQuickRenderTarget::fromD3D11Texture(void *texture, uint format, const QSize &pixelSize, int sampleCount = 1)
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.
This function was introduced in Qt 6.4.
See also QQuickWindow::setRenderTarget() and QQuickRenderControl.
[static] QQuickRenderTarget QQuickRenderTarget::fromD3D11Texture(void *texture, const QSize &pixelSize, int sampleCount = 1)
This is an overloaded function.
Returns a new QQuickRenderTarget referencing a D3D11 texture object specified by texture. The texture is assumed to have a format of DXGI_FORMAT_R8G8B8A8_UNORM.
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.
See also QQuickWindow::setRenderTarget() and QQuickRenderControl.
[static, since 6.4] QQuickRenderTarget QQuickRenderTarget::fromMetalTexture(MTLTexture *texture, uint format, const QSize &pixelSize, int sampleCount = 1)
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.
This function was introduced in Qt 6.4.
See also QQuickWindow::setRenderTarget() and QQuickRenderControl.
[static] QQuickRenderTarget QQuickRenderTarget::fromMetalTexture(MTLTexture *texture, const QSize &pixelSize, int sampleCount = 1)
This is an overloaded function.
Returns a new QQuickRenderTarget referencing a Metal texture object specified by texture. The texture is assumed to have a format of MTLPixelFormatRGBA8Unorm.
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.
See also QQuickWindow::setRenderTarget() and QQuickRenderControl.
[static, since 6.2] QQuickRenderTarget QQuickRenderTarget::fromOpenGLRenderBuffer(uint renderbufferId, const QSize &pixelSize, int sampleCount = 1)
Returns a new QQuickRenderTarget referencing an OpenGL renderbuffer object specified by renderbufferId.
The renderbuffer will be used as the color attachment for the internal framebuffer object. This function is provided to allow targeting renderbuffers that are created by the application with some external buffer underneath, such as an EGLImageKHR. Once the application has called glEGLImageTargetRenderbufferStorageOES, the renderbuffer can be passed to this function.
pixelSize specifies the size of the image, in pixels.
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 renderbuffer.
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.
This function was introduced in Qt 6.2.
See also QQuickWindow::setRenderTarget() and QQuickRenderControl.
[static, since 6.4] QQuickRenderTarget QQuickRenderTarget::fromOpenGLTexture(uint textureId, uint format, const QSize &pixelSize, int sampleCount = 1)
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.
This function was introduced in Qt 6.4.
See also QQuickWindow::setRenderTarget() and QQuickRenderControl.
[static] QQuickRenderTarget QQuickRenderTarget::fromOpenGLTexture(uint textureId, const QSize &pixelSize, int sampleCount = 1)
This is an overloaded function.
Returns a new QQuickRenderTarget referencing an OpenGL texture object specified by textureId. The texture is assumed to have a format of GL_RGBA (GL_RGBA8).
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.
See also QQuickWindow::setRenderTarget() and QQuickRenderControl.
[static, since 6.4] QQuickRenderTarget QQuickRenderTarget::fromPaintDevice(QPaintDevice *device)
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.
This function was introduced in Qt 6.4.
See also QQuickWindow::setRenderTarget() and QQuickRenderControl.
[static, since 6.4] QQuickRenderTarget QQuickRenderTarget::fromVulkanImage(VkImage image, VkImageLayout layout, VkFormat format, const QSize &pixelSize, int sampleCount = 1)
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.
This function was introduced in Qt 6.4.
See also QQuickWindow::setRenderTarget() and QQuickRenderControl.
[static] QQuickRenderTarget QQuickRenderTarget::fromVulkanImage(VkImage image, VkImageLayout layout, const QSize &pixelSize, int sampleCount = 1)
This is an overloaded function.
Returns a new QQuickRenderTarget referencing n Vulkan image object specified by image. The image is assumed to have a format of VK_FORMAT_R8G8B8A8_UNORM.
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.
See also QQuickWindow::setRenderTarget() and QQuickRenderControl.
bool QQuickRenderTarget::isNull() const
Returns true if this QQuickRenderTarget is default constructed, referencing no native objects.
[since 6.4] bool QQuickRenderTarget::mirrorVertically() const
Returns Returns whether the render target is mirrored vertically.
The default value is false.
This function was introduced in Qt 6.4.
See also setMirrorVertically().
[since 6.3] void QQuickRenderTarget::setDevicePixelRatio(qreal ratio)
Sets the device pixel ratio for this render target to ratio. This is the ratio between device pixels and device independent pixels.
Note that the specified device pixel ratio value will be ignored if QQuickRenderControl::renderWindow() is re-implemented to return a valid QWindow.
This function was introduced in Qt 6.3.
See also devicePixelRatio().
[since 6.4] void QQuickRenderTarget::setMirrorVertically(bool enable)
Sets the size of the render target contents should be mirrored vertically to enable when drawing. This allows easy integration of third-party rendering code that does not follow the standard expectations.
Note: This function should not be used when using the software backend.
This function was introduced in Qt 6.4.
See also mirrorVertically().
Related Non-Members
bool operator!=(const QQuickRenderTarget &a, const QQuickRenderTarget &b)
Returns true if a and b refer to a different set of native objects, or the associated data (size, sample count) does not match.
bool operator==(const QQuickRenderTarget &a, const QQuickRenderTarget &b)
Returns true if a and b refer to the same set of native objects and have matching associated data (size, sample count).
© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
