QRenderCapture#

Frame graph node for render capture. More

Inheritance diagram of PySide6.Qt3DRender.Qt3DRender.QRenderCapture

Synopsis#

Functions#

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.

class PySide6.Qt3DRender.Qt3DRender.QRenderCapture([parent=None])#
Parameters

parentPySide6.Qt3DCore.Qt3DCore.QNode

The constructor creates an instance with the specified parent.

PySide6.Qt3DRender.Qt3DRender.QRenderCapture.requestCapture()#
Return type

PySide6.Qt3DRender.Qt3DRender.QRenderCaptureReply

Used to request render capture. Only one render capture result is produced per 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().

PySide6.Qt3DRender.Qt3DRender.QRenderCapture.requestCapture(rect)
Parameters

rectPySide6.QtCore.QRect

Return type

PySide6.Qt3DRender.Qt3DRender.QRenderCaptureReply

Used to request render capture from a specified rect. Only one render capture result is produced per 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() .

PySide6.Qt3DRender.Qt3DRender.QRenderCapture.requestCapture(captureId)
Parameters

captureId – int

Return type

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