QRenderTargetOutput Class
class Qt3DRender::QRenderTargetOutputThe QRenderTargetOutput class allows the specification of an attachment of a render target (whether it is a color texture, a depth texture, etc... ). More...
| Header: | #include <QRenderTargetOutput> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS 3drender) target_link_libraries(mytarget PRIVATE Qt6::3drender) |
| qmake: | QT += 3drender |
| Instantiated By: | RenderTargetOutput |
| Inherits: | Qt3DCore::QNode |
Public Types
| enum | AttachmentPoint { Color0, Color1, Color2, Color3, Color4, …, Right } |
Properties
|
Public Functions
| QRenderTargetOutput(Qt3DCore::QNode *parent = nullptr) | |
| Qt3DRender::QRenderTargetOutput::AttachmentPoint | attachmentPoint() const |
| Qt3DRender::QAbstractTexture::CubeMapFace | face() const |
| int | layer() const |
| int | mipLevel() const |
| Qt3DRender::QAbstractTexture * | texture() const |
Public Slots
| void | setAttachmentPoint(Qt3DRender::QRenderTargetOutput::AttachmentPoint attachmentPoint) |
| void | setFace(Qt3DRender::QAbstractTexture::CubeMapFace face) |
| void | setLayer(int layer) |
| void | setMipLevel(int level) |
| void | setTexture(Qt3DRender::QAbstractTexture *texture) |
Signals
| void | attachmentPointChanged(Qt3DRender::QRenderTargetOutput::AttachmentPoint attachmentPoint) |
| void | faceChanged(Qt3DRender::QAbstractTexture::CubeMapFace face) |
| void | layerChanged(int layer) |
| void | mipLevelChanged(int mipLevel) |
| void | textureChanged(Qt3DRender::QAbstractTexture *texture) |
Detailed Description
A QRenderTargetOutput specifies the attachment point and parameters for texture that is attached to render target. In addition to the attachment point, texture miplevel, layer and cubemap face can be specified. The texture attached to the QRenderTargetOutput must be compatible with the given parameters.
Note: Left and Right attachment points are special values. They do not refer to render target objects to be either of the back buffers used for stereo rendering.
Member Type Documentation
enum QRenderTargetOutput::AttachmentPoint
This enumeration specifies the values for the attachment point.
| Constant | Value | Description |
|---|---|---|
Qt3DRender::QRenderTargetOutput::Color0 | 0 | Color attachment point at index 0 |
Qt3DRender::QRenderTargetOutput::Color1 | 1 | Color attachment point at index 1 |
Qt3DRender::QRenderTargetOutput::Color2 | 2 | Color attachment point at index 2 |
Qt3DRender::QRenderTargetOutput::Color3 | 3 | Color attachment point at index 3 |
Qt3DRender::QRenderTargetOutput::Color4 | 4 | Color attachment point at index 4 |
Qt3DRender::QRenderTargetOutput::Color5 | 5 | Color attachment point at index 5 |
Qt3DRender::QRenderTargetOutput::Color6 | 6 | Color attachment point at index 6 |
Qt3DRender::QRenderTargetOutput::Color7 | 7 | Color attachment point at index 7 |
Qt3DRender::QRenderTargetOutput::Color8 | 8 | Color attachment point at index 8 |
Qt3DRender::QRenderTargetOutput::Color9 | 9 | Color attachment point at index 9 |
Qt3DRender::QRenderTargetOutput::Color10 | 10 | Color attachment point at index 10 |
Qt3DRender::QRenderTargetOutput::Color11 | 11 | Color attachment point at index 11 |
Qt3DRender::QRenderTargetOutput::Color12 | 12 | Color attachment point at index 12 |
Qt3DRender::QRenderTargetOutput::Color13 | 13 | Color attachment point at index 13 |
Qt3DRender::QRenderTargetOutput::Color14 | 14 | Color attachment point at index 14 |
Qt3DRender::QRenderTargetOutput::Color15 | 15 | Color attachment point at index 15 |
Qt3DRender::QRenderTargetOutput::Depth | 16 | Depth attachment point |
Qt3DRender::QRenderTargetOutput::Stencil | 17 | Stencil attachment point |
Qt3DRender::QRenderTargetOutput::DepthStencil | 18 | DepthStencil attachment point |
Qt3DRender::QRenderTargetOutput::Left | 19 | Back Left Draw Buffer |
Qt3DRender::QRenderTargetOutput::Right | 20 | Back Right Draw Buffer |
Property Documentation
attachmentPoint : AttachmentPoint
Holds the attachment point of the QRenderTargetOutput.
Access functions:
| Qt3DRender::QRenderTargetOutput::AttachmentPoint | attachmentPoint() const |
| void | setAttachmentPoint(Qt3DRender::QRenderTargetOutput::AttachmentPoint attachmentPoint) |
Notifier signal:
| void | attachmentPointChanged(Qt3DRender::QRenderTargetOutput::AttachmentPoint attachmentPoint) |
face : Qt3DRender::QAbstractTexture::CubeMapFace
Holds the face of the attached cubemap texture the rendering is directed to.
Access functions:
| Qt3DRender::QAbstractTexture::CubeMapFace | face() const |
| void | setFace(Qt3DRender::QAbstractTexture::CubeMapFace face) |
Notifier signal:
| void | faceChanged(Qt3DRender::QAbstractTexture::CubeMapFace face) |
layer : int
Holds the layer of the attached texture the rendering is directed to.
Access functions:
| int | layer() const |
| void | setLayer(int layer) |
Notifier signal:
| void | layerChanged(int layer) |
mipLevel : int
Holds the miplevel of the attached texture the rendering is directed to.
Access functions:
| int | mipLevel() const |
| void | setMipLevel(int level) |
Notifier signal:
| void | mipLevelChanged(int mipLevel) |
texture : QAbstractTexture*
Holds the texture attached to the attachment point.
Access functions:
| Qt3DRender::QAbstractTexture * | texture() const |
| void | setTexture(Qt3DRender::QAbstractTexture *texture) |
Notifier signal:
| void | textureChanged(Qt3DRender::QAbstractTexture *texture) |
Member Function Documentation
[explicit] QRenderTargetOutput::QRenderTargetOutput(Qt3DCore::QNode *parent = nullptr)
The constructor creates a new QRenderTargetOutput::QRenderTargetOutput instance with the specified parent.
© 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.
