QRenderCapture Class▲
-
Header: Qt3DRender/QRenderCapture
-
Since: Qt 5.8
-
CMake:
find_package(Qt6 REQUIRED COMPONENTS 3drender)
target_link_libraries(mytarget PRIVATE Qt6::3drender)
-
qmake: QT += 3drender
-
Inherited By:
-
Instantiated By: qml-qt3d-render-rendercapture.xml
-
Inherits: Qt3DRender::QFrameGraphNode
Detailed Description▲
The QRenderCapture is used to capture rendering into an image at any render stage. Capturing must be initiated by the user and one image is returned per capture request. User can issue multiple render capture requests simultaniously, but only one request is served per QRenderCapture instance per frame.
Member Function Documentation▲
[explicit] QRenderCapture::QRenderCapture(Qt3DCore::QNode *parent = nullptr)▲
The constructor creates an instance with the specified parent.
Qt3DRender::QRenderCaptureReply *QRenderCapture::requestCapture()▲
Used to request render capture. Only one render capture result is produced per requestCapture call even if the frame graph has multiple leaf nodes. The function returns a QRenderCaptureReply object, which receives the captured image when it is done. The user is responsible for deallocating the returned object by calling deleterLater().
Qt3DRender::QRenderCaptureReply *QRenderCapture::requestCapture(const QRect &rect)▲
Used to request render capture from a specified rect. Only one render capture result is produced per requestCapture call even if the frame graph has multiple leaf nodes. The function returns a QRenderCaptureReply object, which receives the captured image when it is done. The user is responsible for deallocating the returned object by calling deleteLater().
Obsolete Members for QRenderCapture▲
The following members of class QRenderCapture are deprecated. We strongly advise against using them in new code.
Obsolete Member Function Documentation▲
Qt3DRender::QRenderCaptureReply *QRenderCapture::requestCapture(int captureId)▲
This function is deprecated. We strongly advise against using it in new code.
Used to request render capture. User can specify a captureId to identify the request. The requestId does not have to be unique. Only one render capture result is produced per requestCapture call even if the frame graph has multiple leaf nodes. The function returns a QRenderCaptureReply object, which receives the captured image when it is done. The user is responsible for deallocating the returned object by calling deleteLater().