PySide6.Qt3DRender.Qt3DRender.QRenderCapture

class QRenderCapture

Frame graph node for render capture. More…

Inheritance diagram of PySide6.Qt3DRender.Qt3DRender.QRenderCapture

Synopsis

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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.

__init__([parent=None])
Parameters:

parent – QNode

The constructor creates an instance with the specified parent.

requestCapture()
Return type:

QRenderCaptureReply

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().

requestCapture(rect)
Parameters:

rect – QRect

Return type:

QRenderCaptureReply

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().

requestCapture(captureId)
Parameters:

captureId – int

Return type:

QRenderCaptureReply

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().