QRenderCaptureReply#
Receives the result of render capture request. More…
Synopsis#
Properties#
Functions#
def
captureId
()def
image
()def
isComplete
()def
saveImage
(fileName)
Signals#
def
completed
()
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#
An object, which receives the image from QRenderCapture::requestCapture.
- class PySide6.Qt3DRender.Qt3DRender.QRenderCaptureReply#
Note
Properties can be used directly when from __feature__ import true_property
is used or via accessor functions otherwise.
- property PᅟySide6.Qt3DRender.Qt3DRender.QRenderCaptureReply.captureId: int#
Holds the captureId, which was passed to the renderCapture.
- Access functions:
captureId
()
- property PᅟySide6.Qt3DRender.Qt3DRender.QRenderCaptureReply.complete: bool#
Holds the complete state of the render capture.
- Access functions:
isComplete
()Signal
completed
()
- property PᅟySide6.Qt3DRender.Qt3DRender.QRenderCaptureReply.image: PySide6.QtGui.QImage#
Holds the image, which was produced as a result of render capture.
- Access functions:
image
()
- PySide6.Qt3DRender.Qt3DRender.QRenderCaptureReply.captureId()#
- Return type:
int
Note
This function is deprecated.
Getter of property captureId
.
- PySide6.Qt3DRender.Qt3DRender.QRenderCaptureReply.completed()#
Notification signal of property complete
.
- PySide6.Qt3DRender.Qt3DRender.QRenderCaptureReply.image()#
- Return type:
Getter of property image
.
- PySide6.Qt3DRender.Qt3DRender.QRenderCaptureReply.isComplete()#
- Return type:
bool
Getter of property complete
.
- PySide6.Qt3DRender.Qt3DRender.QRenderCaptureReply.saveImage(fileName)#
- Parameters:
fileName – str
- Return type:
bool
Saves the render capture result as an image to fileName
.
Returns true if the image was successfully saved; otherwise returns false.