PySide6.Qt3DRender.Qt3DRender.QSetFence

class QSetFence

FrameGraphNode used to insert a fence in the graphics command stream. More…

Synopsis

Properties

• handleᅟ

• handleTypeᅟ

Methods

• def __init__()

• def handle()

• def handleType()

Signals

• def handleChanged()

• def handleTypeChanged()

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

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.

class HandleType

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property handleᅟ: object

Holds the underlying fence handle wrapped in a QVariant.

Access functions:

• handle()

• Signal handleChanged()

property handleTypeᅟ: Qt3DRender.QSetFence.HandleType

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

Access functions:

• handleType()

• Signal handleTypeChanged()

__init__([parent=None])

Parameters:

parent – QNode

handle()

Return type:

object

Getter of property handleᅟ .

handleChanged(handle)

Parameters:

handle – object

Notification signal of property handleᅟ .

handleType()

Return type:

HandleType

Getter of property handleTypeᅟ .

handleTypeChanged(handleType)

Parameters:

handleType – HandleType

Notification signal of property handleTypeᅟ .