PySide6.QtGui.QRhiRenderTarget¶

class QRhiRenderTarget¶

Represents an onscreen (swapchain) or offscreen (texture) render target.

Details

Applications do not create an instance of this class directly. Rather, it is the subclass QRhiTextureRenderTarget that is instantiable by clients of the API via newTextureRenderTarget() . The other subclass is QRhiSwapChainRenderTarget , which is the type QRhiSwapChain returns when calling currentFrameRenderTarget() .

Note

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

Synopsis¶

Virtual methods¶

def devicePixelRatio()
def pixelSize()
def sampleCount()

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

PySide6.QtGui.QRhiRenderTarget.m_renderPassDesc¶

abstract devicePixelRatio()¶

Return type:: float

Returns the device pixel ratio. For QRhiTextureRenderTarget this is always 1. For targets retrieved from a QRhiSwapChain the value reflects the device pixel ratio of the targeted QWindow .

abstract pixelSize()¶

Return type:: QSize

Returns the size in pixels.

Valid only after create() has been called successfully. Until then the result is a default-constructed QSize.

With QRhiTextureRenderTarget the returned size is the size of the associated attachments at the time of create(), in practice the size of the first color attachment, or the depth/stencil buffer if there are no color attachments. If the associated textures or renderbuffers are resized and rebuilt afterwards, then pixelSize() performs an implicit call to create() in order to rebuild the underlying data structures. This implicit check is similar to what beginPass() does, and ensures that the returned size is always up-to-date.

renderPassDescriptor()¶

Return type:: QRhiRenderPassDescriptor

Returns the associated QRhiRenderPassDescriptor .

See also

setRenderPassDescriptor()

abstract sampleCount()¶

Return type:: int

Returns the sample count or 1 if multisample antialiasing is not relevant for this render target.

setRenderPassDescriptor(desc)¶

Parameters:: desc – QRhiRenderPassDescriptor

Sets the QRhiRenderPassDescriptor desc for use with this render target.

See also

renderPassDescriptor()