Struct qt_3d_render::QRenderCapture

#[repr(C)]
pub struct QRenderCapture { /* fields omitted */ }

Frame graph node for render capture

C++ class: Qt3DRender::QRenderCapture.

C++ documentation:

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.

Methods

impl QRenderCapture

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* Qt3DRender::QRenderCapture::metaObject() const.

pub unsafe fn new_1a(
    parent: impl CastInto<MutPtr<QNode>>
) -> QBox<QRenderCapture>

The constructor creates an instance with the specified parent.

Calls C++ function: [constructor] void Qt3DRender::QRenderCapture::QRenderCapture(Qt3DCore::QNode* parent = …).

C++ documentation:

The constructor creates an instance with the specified parent.

pub unsafe fn new_0a() -> QBox<QRenderCapture>

Frame graph node for render capture

Calls C++ function: [constructor] void Qt3DRender::QRenderCapture::QRenderCapture().

C++ documentation:

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.

pub unsafe fn qt_metacall(
    &mut self,
    arg1: Call,
    arg2: c_int,
    arg3: impl CastInto<MutPtr<*mut c_void>>
) -> c_int

Calls C++ function: virtual int Qt3DRender::QRenderCapture::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(
    &mut self,
    arg1: impl CastInto<Ptr<c_char>>
) -> MutPtr<c_void>

Calls C++ function: virtual void* Qt3DRender::QRenderCapture::qt_metacast(const char* arg1).

pub unsafe fn request_capture_int(
    &mut self,
    capture_id: c_int
) -> QMutPtr<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.

Calls C++ function: Qt3DRender::QRenderCaptureReply* Qt3DRender::QRenderCapture::requestCapture(int captureId).

Warning: no exact match found in C++ documentation. Below is the C++ documentation for 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.

pub unsafe fn request_capture(&mut self) -> QMutPtr<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.

Calls C++ function: Qt3DRender::QRenderCaptureReply* Qt3DRender::QRenderCapture::requestCapture().

C++ documentation:

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.

pub unsafe fn request_capture_q_rect(
    &mut self,
    rect: impl CastInto<Ref<QRect>>
) -> QMutPtr<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.

Calls C++ function: Qt3DRender::QRenderCaptureReply* Qt3DRender::QRenderCapture::requestCapture(const QRect& rect).

Warning: no exact match found in C++ documentation. Below is the C++ documentation for Qt3DRender::QRenderCaptureReply *QRenderCapture::requestCapture(int captureId):

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.

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

This item is available if any(cpp_lib_version="5.11.3", cpp_lib_version="5.12.2", cpp_lib_version="5.13.0", cpp_lib_version="5.14.0").

pub unsafe fn static_meta_object() -> Ref<QMetaObject>

Returns a reference to the staticMetaObject field.

pub unsafe fn tr(
    s: impl CastInto<Ptr<c_char>>,
    c: impl CastInto<Ptr<c_char>>,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString Qt3DRender::QRenderCapture::tr(const char* s, const char* c, int n).

pub unsafe fn tr_utf8(
    s: impl CastInto<Ptr<c_char>>,
    c: impl CastInto<Ptr<c_char>>,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString Qt3DRender::QRenderCapture::trUtf8(const char* s, const char* c, int n).

Methods from Deref<Target = QFrameGraphNode>

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* Qt3DRender::QFrameGraphNode::metaObject() const.

pub unsafe fn parent_frame_graph_node(&self) -> QMutPtr<QFrameGraphNode>

Returns a pointer to the parent.

Calls C++ function: Qt3DRender::QFrameGraphNode* Qt3DRender::QFrameGraphNode::parentFrameGraphNode() const.

C++ documentation:

Returns a pointer to the parent.

pub unsafe fn qt_metacall(
    &mut self,
    arg1: Call,
    arg2: c_int,
    arg3: impl CastInto<MutPtr<*mut c_void>>
) -> c_int

Calls C++ function: virtual int Qt3DRender::QFrameGraphNode::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(
    &mut self,
    arg1: impl CastInto<Ptr<c_char>>
) -> MutPtr<c_void>

Calls C++ function: virtual void* Qt3DRender::QFrameGraphNode::qt_metacast(const char* arg1).

Trait Implementations

impl CppDeletable for QRenderCapture

unsafe fn delete(&mut self)

Frame graph node for render capture

Calls C++ function: [destructor] void Qt3DRender::QRenderCapture::~QRenderCapture().

C++ documentation:

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.

impl Deref for QRenderCapture

type Target = QFrameGraphNode

The resulting type after dereferencing.

fn deref(&self) -> &QFrameGraphNode

Calls C++ function: Qt3DRender::QFrameGraphNode* static_cast<Qt3DRender::QFrameGraphNode*>(Qt3DRender::QRenderCapture* ptr).

impl DerefMut for QRenderCapture

fn deref_mut(&mut self) -> &mut QFrameGraphNode

Calls C++ function: Qt3DRender::QFrameGraphNode* static_cast<Qt3DRender::QFrameGraphNode*>(Qt3DRender::QRenderCapture* ptr).

impl DynamicCast<QRenderCapture> for QFrameGraphNode

unsafe fn dynamic_cast(ptr: Ptr<QFrameGraphNode>) -> Ptr<QRenderCapture>

Calls C++ function: Qt3DRender::QRenderCapture* dynamic_cast<Qt3DRender::QRenderCapture*>(Qt3DRender::QFrameGraphNode* ptr).

unsafe fn dynamic_cast_mut(
    ptr: MutPtr<QFrameGraphNode>
) -> MutPtr<QRenderCapture>

Calls C++ function: Qt3DRender::QRenderCapture* dynamic_cast<Qt3DRender::QRenderCapture*>(Qt3DRender::QFrameGraphNode* ptr).

impl DynamicCast<QRenderCapture> for QNode

unsafe fn dynamic_cast(ptr: Ptr<QNode>) -> Ptr<QRenderCapture>

Calls C++ function: Qt3DRender::QRenderCapture* dynamic_cast<Qt3DRender::QRenderCapture*>(Qt3DCore::QNode* ptr).

unsafe fn dynamic_cast_mut(ptr: MutPtr<QNode>) -> MutPtr<QRenderCapture>

Calls C++ function: Qt3DRender::QRenderCapture* dynamic_cast<Qt3DRender::QRenderCapture*>(Qt3DCore::QNode* ptr).

impl DynamicCast<QRenderCapture> for QObject

unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QRenderCapture>

Calls C++ function: Qt3DRender::QRenderCapture* dynamic_cast<Qt3DRender::QRenderCapture*>(QObject* ptr).

unsafe fn dynamic_cast_mut(ptr: MutPtr<QObject>) -> MutPtr<QRenderCapture>

Calls C++ function: Qt3DRender::QRenderCapture* dynamic_cast<Qt3DRender::QRenderCapture*>(QObject* ptr).

impl StaticDowncast<QRenderCapture> for QFrameGraphNode

unsafe fn static_downcast(ptr: Ptr<QFrameGraphNode>) -> Ptr<QRenderCapture>

Calls C++ function: Qt3DRender::QRenderCapture* static_cast<Qt3DRender::QRenderCapture*>(Qt3DRender::QFrameGraphNode* ptr).

unsafe fn static_downcast_mut(
    ptr: MutPtr<QFrameGraphNode>
) -> MutPtr<QRenderCapture>

Calls C++ function: Qt3DRender::QRenderCapture* static_cast<Qt3DRender::QRenderCapture*>(Qt3DRender::QFrameGraphNode* ptr).

impl StaticDowncast<QRenderCapture> for QNode

unsafe fn static_downcast(ptr: Ptr<QNode>) -> Ptr<QRenderCapture>

Calls C++ function: Qt3DRender::QRenderCapture* static_cast<Qt3DRender::QRenderCapture*>(Qt3DCore::QNode* ptr).

unsafe fn static_downcast_mut(ptr: MutPtr<QNode>) -> MutPtr<QRenderCapture>

Calls C++ function: Qt3DRender::QRenderCapture* static_cast<Qt3DRender::QRenderCapture*>(Qt3DCore::QNode* ptr).

impl StaticDowncast<QRenderCapture> for QObject

unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QRenderCapture>

Calls C++ function: Qt3DRender::QRenderCapture* static_cast<Qt3DRender::QRenderCapture*>(QObject* ptr).

unsafe fn static_downcast_mut(ptr: MutPtr<QObject>) -> MutPtr<QRenderCapture>

Calls C++ function: Qt3DRender::QRenderCapture* static_cast<Qt3DRender::QRenderCapture*>(QObject* ptr).

impl StaticUpcast<QFrameGraphNode> for QRenderCapture

unsafe fn static_upcast(ptr: Ptr<QRenderCapture>) -> Ptr<QFrameGraphNode>

Calls C++ function: Qt3DRender::QFrameGraphNode* static_cast<Qt3DRender::QFrameGraphNode*>(Qt3DRender::QRenderCapture* ptr).

unsafe fn static_upcast_mut(
    ptr: MutPtr<QRenderCapture>
) -> MutPtr<QFrameGraphNode>

Calls C++ function: Qt3DRender::QFrameGraphNode* static_cast<Qt3DRender::QFrameGraphNode*>(Qt3DRender::QRenderCapture* ptr).

impl StaticUpcast<QNode> for QRenderCapture

unsafe fn static_upcast(ptr: Ptr<QRenderCapture>) -> Ptr<QNode>

Calls C++ function: Qt3DCore::QNode* static_cast<Qt3DCore::QNode*>(Qt3DRender::QRenderCapture* ptr).

unsafe fn static_upcast_mut(ptr: MutPtr<QRenderCapture>) -> MutPtr<QNode>

Calls C++ function: Qt3DCore::QNode* static_cast<Qt3DCore::QNode*>(Qt3DRender::QRenderCapture* ptr).

impl StaticUpcast<QObject> for QRenderCapture

unsafe fn static_upcast(ptr: Ptr<QRenderCapture>) -> Ptr<QObject>

Calls C++ function: QObject* static_cast<QObject*>(Qt3DRender::QRenderCapture* ptr).

unsafe fn static_upcast_mut(ptr: MutPtr<QRenderCapture>) -> MutPtr<QObject>

Calls C++ function: QObject* static_cast<QObject*>(Qt3DRender::QRenderCapture* ptr).