- Qt 6.12
- Qt 3D
- C++ Classes
- Qt3DRender (Deprecated)
- QRenderCapture
- Qt 6.12.0 Reference Documentation

# Qt3DRender::QRenderCapture Class

class Qt3DRender::QRenderCapture

Frame graph node for render capture. More...

Header: | `#include <Qt3DRender/QRenderCapture>`
CMake: | `find_package(Qt6 REQUIRED COMPONENTS 3drender)` `target_link_libraries(mytarget PRIVATE Qt6::3drender)`
qmake: | `QT += 3drender`
In QML: | RenderCapture
Inherits: | Qt3DRender::QFrameGraphNode
Status: | Deprecated

This class is deprecated. We strongly advise against using it in new code.

- List of all members, including inherited members
- Deprecated members

## Public Functions

| QRenderCapture(Qt3DCore::QNode *parent = nullptr)
Qt3DRender::QRenderCaptureReply * | requestCapture()
Qt3DRender::QRenderCaptureReply * | requestCapture(const QRect &rect)

## 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.

### `[invokable]` 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().

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

### `[invokable]` 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().

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.