Qt Documentation

Qt 5.12
Qt 3D
C++ Classes
QRenderCapture

QRenderCapture Class

(Qt3DRender::QRenderCapture)

Frame graph node for render capture. More...

Header:	#include <Qt3DRender/QRenderCapture>
qmake:	QT += 3drender
Since:	Qt 5.8
Instantiated By:	RenderCapture
Inherits:	Qt3DRender::QFrameGraphNode

Public Functions

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

1 public function inherited from Qt3DRender::QFrameGraphNode
13 public functions inherited from Qt3DCore::QNode
31 public functions inherited from QObject

Static Public Members

const QMetaObject staticMetaObject

9 static public members inherited from QObject

Additional Inherited Members

3 properties inherited from Qt3DCore::QNode
1 property inherited from QObject
3 public slots inherited from Qt3DCore::QNode
1 public slot inherited from QObject
4 signals inherited from Qt3DCore::QNode
2 signals inherited from QObject
1 protected function inherited from Qt3DRender::QFrameGraphNode
2 protected functions inherited from Qt3DCore::QNode
9 protected functions inherited from QObject

Detailed Description

Frame graph node for render capture.

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

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.

Note: This function can be invoked via the meta-object system and from QML. See Q_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.