Struct qt_3d_render::QSetFence

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

Fence allow to synchronosize GPU and CPU workloads. GPU commands usually are non-blocking. When issued, commands are inserted in command buffers which will be read at a later time by the GPU. In some cases, you want to continue processing or issue specific command only when you are sure a command has been executed by the hardware. Fences are a way to do so. This is especially important when using 3rd party engines with Qt3D, Qt3D should only access shared resources when we know the other engine command are done modifying the resource.

C++ class: Qt3DRender::QSetFence.

C++ documentation:

Fence allow to synchronosize GPU and CPU workloads. GPU commands usually are non-blocking. When issued, commands are inserted in command buffers which will be read at a later time by the GPU. In some cases, you want to continue processing or issue specific command only when you are sure a command has been executed by the hardware. Fences are a way to do so. This is especially important when using 3rd party engines with Qt3D, Qt3D should only access shared resources when we know the other engine command are done modifying the resource.

QSetFence is a FrameGraph node that inserts a fence into the command stream. It can then be used in conjunction with QWaitFence or by extracting the underlying handle.

The handle property will be updated once the renderer has created the underlying fence resource. The handle will remain valid as long as it remains in the unsignaled state. Once it has reached the signaled state, it will be destroyed and a new handle will be created. That means that depending on how long it takes for the fence to be signaled, the same handle could be used over several frames.

Methods

impl QSetFence

pub fn handle_type_changed(&self) -> Signal<(HandleType,)>

This is supported on cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Specifies the type of handle being used. Currently only OpenGL Fence ids are supported.

Returns a built-in Qt signal Qt3DRender::QSetFence::handleTypeChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Specifies the type of handle being used. Currently only OpenGL Fence ids are supported.

Access functions:

Qt3DRender::QSetFence::HandleType

handleType() const

Notifier signal:

void	handleTypeChanged(Qt3DRender::QSetFence::HandleType handleType)

pub fn handle_changed(&self) -> Signal<(*const QVariant,)>

This is supported on cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Holds the underlying fence handle wrapped in a QVariant.

Returns a built-in Qt signal Qt3DRender::QSetFence::handleChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the underlying fence handle wrapped in a QVariant.

Access functions:

QVariant

handle() const

Notifier signal:

void	handleChanged(QVariant handle)

pub unsafe fn handle(&self) -> CppBox<QVariant>

This is supported on cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Holds the underlying fence handle wrapped in a QVariant.

Calls C++ function: QVariant Qt3DRender::QSetFence::handle() const.

C++ documentation:

Holds the underlying fence handle wrapped in a QVariant.

Access functions:

QVariant

handle() const

Notifier signal:

void	handleChanged(QVariant handle)

pub unsafe fn handle_type(&self) -> HandleType

This is supported on cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Specifies the type of handle being used. Currently only OpenGL Fence ids are supported.

Calls C++ function: Qt3DRender::QSetFence::HandleType Qt3DRender::QSetFence::handleType() const.

C++ documentation:

Specifies the type of handle being used. Currently only OpenGL Fence ids are supported.

Access functions:

Qt3DRender::QSetFence::HandleType

handleType() const

Notifier signal:

void	handleTypeChanged(Qt3DRender::QSetFence::HandleType handleType)

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

This is supported on cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

pub unsafe fn new_1a(parent: impl CastInto<Ptr<QNode>>) -> QBox<QSetFence>

This is supported on cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

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

This is supported on cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Fence allow to synchronosize GPU and CPU workloads. GPU commands usually are non-blocking. When issued, commands are inserted in command buffers which will be read at a later time by the GPU. In some cases, you want to continue processing or issue specific command only when you are sure a command has been executed by the hardware. Fences are a way to do so. This is especially important when using 3rd party engines with Qt3D, Qt3D should only access shared resources when we know the other engine command are done modifying the resource.

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

C++ documentation:

Fence allow to synchronosize GPU and CPU workloads. GPU commands usually are non-blocking. When issued, commands are inserted in command buffers which will be read at a later time by the GPU. In some cases, you want to continue processing or issue specific command only when you are sure a command has been executed by the hardware. Fences are a way to do so. This is especially important when using 3rd party engines with Qt3D, Qt3D should only access shared resources when we know the other engine command are done modifying the resource.

QSetFence is a FrameGraph node that inserts a fence into the command stream. It can then be used in conjunction with QWaitFence or by extracting the underlying handle.

The handle property will be updated once the renderer has created the underlying fence resource. The handle will remain valid as long as it remains in the unsignaled state. Once it has reached the signaled state, it will be destroyed and a new handle will be created. That means that depending on how long it takes for the fence to be signaled, the same handle could be used over several frames.

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

This is supported on cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void

This is supported on cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

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

This is supported on cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Returns a reference to the staticMetaObject field.

pub unsafe fn tr(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

This is supported on cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

pub unsafe fn tr_utf8(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

This is supported on cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Calls C++ function: static QString Qt3DRender::QSetFence::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) -> QPtr<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(
    &self,
    arg1: Call,
    arg2: c_int,
    arg3: *mut *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(&self, arg1: *const c_char) -> *mut c_void

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

Trait Implementations

impl CppDeletable for QSetFence

unsafe fn delete(&self)

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

impl Deref for QSetFence

type Target = QFrameGraphNode

The resulting type after dereferencing.

fn deref(&self) -> &QFrameGraphNode

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

impl DynamicCast<QSetFence> for QFrameGraphNode

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

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

impl DynamicCast<QSetFence> for QNode

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

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

impl DynamicCast<QSetFence> for QObject

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

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

impl StaticDowncast<QSetFence> for QFrameGraphNode

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

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

impl StaticDowncast<QSetFence> for QNode

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

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

impl StaticDowncast<QSetFence> for QObject

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

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

impl StaticUpcast<QFrameGraphNode> for QSetFence

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

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

impl StaticUpcast<QNode> for QSetFence

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

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

impl StaticUpcast<QObject> for QSetFence

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

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