PySide6.QtGui.QRhiResource¶

class QRhiResource¶

Base class for classes encapsulating native resource objects.

Details

Note

This is a RHI API with limited compatibility guarantees, see QRhi for details.

Inherited by: QRhiTexture, QRhiShaderResourceBindings, QRhiSampler, QRhiRenderPassDescriptor, QRhiRenderTarget, QRhiTextureRenderTarget, QRhiRenderBuffer, QRhiSwapChain, QRhiSwapChainRenderTarget, QRhiGraphicsPipeline, QRhiComputePipeline, QRhiCommandBuffer, QRhiBuffer

Added in version 6.6.

Synopsis¶

Methods¶

def deleteLater()
def globalResourceId()
def name()
def rhi()
def setName()

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

class Type¶

Specifies type of the resource.

Constant

Description

QRhiResource.Type.Buffer

QRhiResource.Type.Texture

QRhiResource.Type.Sampler

QRhiResource.Type.RenderBuffer

QRhiResource.Type.RenderPassDescriptor

QRhiResource.Type.SwapChainRenderTarget

QRhiResource.Type.TextureRenderTarget

QRhiResource.Type.ShaderResourceBindings

QRhiResource.Type.GraphicsPipeline

QRhiResource.Type.SwapChain

QRhiResource.Type.ComputePipeline

QRhiResource.Type.CommandBuffer

QRhiResource.Type.ShadingRateMap

Constant	Description
QRhiResource.Type.Buffer
QRhiResource.Type.Texture
QRhiResource.Type.Sampler
QRhiResource.Type.RenderBuffer
QRhiResource.Type.RenderPassDescriptor
QRhiResource.Type.SwapChainRenderTarget
QRhiResource.Type.TextureRenderTarget
QRhiResource.Type.ShaderResourceBindings
QRhiResource.Type.GraphicsPipeline
QRhiResource.Type.SwapChain
QRhiResource.Type.ComputePipeline
QRhiResource.Type.CommandBuffer
QRhiResource.Type.ShadingRateMap

PySide6.QtGui.QRhiResource.m_id¶

PySide6.QtGui.QRhiResource.m_objectName¶

deleteLater()¶

When called without a frame being recorded, this function is equivalent to deleting the object. Between a beginFrame() and endFrame() however the behavior is different: the QRhiResource will not be destroyed until the frame is submitted via endFrame() , thus satisfying the QRhi requirement of not altering QRhiResource objects that are referenced by the frame being recorded.

If the QRhi that created this object is already destroyed, the object is deleted immediately.

Using deleteLater() can be a useful convenience in many cases, and it complements the low-level guarantee (that the underlying native graphics objects are never destroyed until it is safe to do so and it is known for sure that they are not used by the GPU in an still in-flight frame), by offering a way to make sure the C++ object instances (of QRhiBuffer , QRhiTexture , etc.) themselves also stay valid until the end of the current frame.

The following example shows a convenient way of creating a throwaway buffer that is only used in one frame and gets automatically released in endFrame(). (when it comes to the underlying native buffer(s), the usual guarantee applies: the QRhi backend defers the releasing of those until it is guaranteed that the frame in which the buffer is accessed by the GPU has completed)

rhi->beginFrame(swapchain);
QRhiBuffer *buf = rhi->newBuffer(QRhiBuffer::Immutable, QRhiBuffer::VertexBuffer, 256);
buf->deleteLater(); // !
u = rhi->nextResourceUpdateBatch();
u->uploadStaticBuffer(buf, data);
// ... draw with buf
rhi->endFrame();