Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qrhi.h File Reference

(73a18c3eba6fe5b4ff80f386028dd892da5944d6)

#include <QtGui/qtguiglobal.h>
#include <QtCore/qsize.h>
#include <QtCore/qlist.h>
#include <QtCore/qvarlengtharray.h>
#include <QtCore/qthread.h>
#include <QtGui/qmatrix4x4.h>
#include <QtGui/qcolor.h>
#include <QtGui/qimage.h>
#include <functional>
#include <array>
#include <rhi/qshader.h>
#include <rhi/qrhi_platform.h>
Include dependency graph for qrhi.h:

Go to the source code of this file.

Classes

class  QRhiDepthStencilClearValue
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiViewport
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiScissor
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiVertexInputBinding
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiVertexInputAttribute
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiVertexInputLayout
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiShaderStage
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiShaderResourceBinding
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
struct  QRhiShaderResourceBinding::TextureAndSampler
struct  QRhiShaderResourceBinding::Data
struct  QRhiShaderResourceBinding::Data::UniformBufferData
struct  QRhiShaderResourceBinding::Data::TextureAndOrSamplerData
struct  QRhiShaderResourceBinding::Data::StorageImageData
struct  QRhiShaderResourceBinding::Data::StorageBufferData
class  QRhiColorAttachment
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiTextureRenderTargetDescription
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiTextureSubresourceUploadDescription
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiTextureUploadEntry
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiTextureUploadDescription
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiTextureCopyDescription
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiReadbackDescription
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiNativeHandles
 \variable QRhiReadbackResult::completed More...
class  QRhiResource
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiBuffer
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiBuffer::NativeBuffer
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiTexture
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
struct  QRhiTexture::NativeTexture
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
struct  QRhiTexture::ViewFormat
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiSampler
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiRenderBuffer
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
struct  QRhiRenderBuffer::NativeRenderBuffer
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiShadingRateMap
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
struct  QRhiShadingRateMap::NativeShadingRateMap
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiRenderPassDescriptor
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiRenderTarget
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiSwapChainRenderTarget
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiTextureRenderTarget
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiShaderResourceBindings
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiGraphicsPipeline
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
struct  QRhiGraphicsPipeline::TargetBlend
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
struct  QRhiGraphicsPipeline::StencilOpState
 \variable QRhiGraphicsPipeline::TargetBlend::colorWrite More...
struct  QRhiSwapChainHdrInfo
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
struct  QRhiSwapChainProxyData
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiSwapChain
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiComputePipeline
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiCommandBuffer
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiReadbackResult
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiResourceUpdateBatch
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
struct  QRhiDriverInfo
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
struct  QRhiStats
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiAdapter
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhiInitParams
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...
class  QRhi
 \inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...

Typedefs

using QRhiGraphicsShaderStage = QRhiShaderStage
using QRhiShaderResourceBindingSet = QRhiShaderResourceBindings

Functions

 Q_DECLARE_TYPEINFO (QRhiDepthStencilClearValue, Q_RELOCATABLE_TYPE)
Q_GUI_EXPORT QDebug operator<< (QDebug, const QRhiDepthStencilClearValue &)
 Q_DECLARE_TYPEINFO (QRhiViewport, Q_RELOCATABLE_TYPE)
Q_GUI_EXPORT QDebug operator<< (QDebug, const QRhiViewport &)
 Q_DECLARE_TYPEINFO (QRhiScissor, Q_RELOCATABLE_TYPE)
Q_GUI_EXPORT QDebug operator<< (QDebug, const QRhiScissor &)
 Q_DECLARE_TYPEINFO (QRhiVertexInputBinding, Q_RELOCATABLE_TYPE)
Q_GUI_EXPORT QDebug operator<< (QDebug, const QRhiVertexInputBinding &)
 Q_DECLARE_TYPEINFO (QRhiVertexInputAttribute, Q_RELOCATABLE_TYPE)
Q_GUI_EXPORT QDebug operator<< (QDebug, const QRhiVertexInputAttribute &)
Q_GUI_EXPORT QDebug operator<< (QDebug, const QRhiVertexInputLayout &)
 Q_DECLARE_TYPEINFO (QRhiShaderStage, Q_RELOCATABLE_TYPE)
Q_GUI_EXPORT QDebug operator<< (QDebug, const QRhiShaderStage &)
 Q_DECLARE_TYPEINFO (QRhiShaderResourceBinding, Q_PRIMITIVE_TYPE)
Q_GUI_EXPORT bool operator== (const QRhiShaderResourceBinding &a, const QRhiShaderResourceBinding &b) noexcept
Q_GUI_EXPORT bool operator!= (const QRhiShaderResourceBinding &a, const QRhiShaderResourceBinding &b) noexcept
Q_GUI_EXPORT size_t qHash (const QRhiShaderResourceBinding &b, size_t seed=0) noexcept
 \qhashold{QRhiShaderResourceBinding}
Q_GUI_EXPORT QDebug operator<< (QDebug, const QRhiShaderResourceBinding &)
 Q_DECLARE_TYPEINFO (QRhiColorAttachment, Q_RELOCATABLE_TYPE)
 Q_DECLARE_TYPEINFO (QRhiTextureSubresourceUploadDescription, Q_RELOCATABLE_TYPE)
 Q_DECLARE_TYPEINFO (QRhiTextureUploadEntry, Q_RELOCATABLE_TYPE)
 Q_DECLARE_TYPEINFO (QRhiTextureCopyDescription, Q_RELOCATABLE_TYPE)
 Q_DECLARE_TYPEINFO (QRhiReadbackDescription, Q_RELOCATABLE_TYPE)
Q_GUI_EXPORT QDebug operator<< (QDebug, const QRhiShaderResourceBindings &)
 Q_DECLARE_TYPEINFO (QRhiGraphicsPipeline::TargetBlend, Q_RELOCATABLE_TYPE)
 Q_DECLARE_TYPEINFO (QRhiSwapChainHdrInfo, Q_RELOCATABLE_TYPE)
Q_GUI_EXPORT QDebug operator<< (QDebug, const QRhiSwapChainHdrInfo &)
 Q_DECLARE_TYPEINFO (QRhiDriverInfo, Q_RELOCATABLE_TYPE)
Q_GUI_EXPORT QDebug operator<< (QDebug, const QRhiDriverInfo &)
 Q_DECLARE_TYPEINFO (QRhiStats, Q_RELOCATABLE_TYPE)
Q_GUI_EXPORT QDebug operator<< (QDebug, const QRhiStats &)
 \variable QRhiStats::totalPipelineCreationTime

Typedef Documentation

◆ QRhiGraphicsShaderStage

Definition at line 437 of file qrhi.h.

◆ QRhiShaderResourceBindingSet

Definition at line 1306 of file qrhi.h.

Function Documentation

◆ operator!=()

Q_GUI_EXPORT bool operator!= ( const QRhiShaderResourceBinding & a,
const QRhiShaderResourceBinding & b )
related

◆ operator<<() [1/12]

QDebug operator<< ( QDebug dbg,
const QRhiDepthStencilClearValue & v )

Definition at line 1311 of file qrhi.cpp.

◆ operator<<() [2/12]

QDebug operator<< ( QDebug dbg,
const QRhiDriverInfo & info )

Definition at line 9294 of file qrhi.cpp.

◆ operator<<() [3/12]

QDebug operator<< ( QDebug dbg,
const QRhiScissor & s )

Definition at line 1524 of file qrhi.cpp.

◆ operator<<() [4/12]

QDebug operator<< ( QDebug dbg,
const QRhiShaderResourceBinding & b )

Definition at line 6592 of file qrhi.cpp.

◆ operator<<() [5/12]

QDebug operator<< ( QDebug dbg,
const QRhiShaderResourceBindings & srb )

Definition at line 6678 of file qrhi.cpp.

◆ operator<<() [6/12]

QDebug operator<< ( QDebug dbg,
const QRhiShaderStage & s )

Definition at line 2302 of file qrhi.cpp.

◆ operator<<() [7/12]

QDebug operator<< ( QDebug dbg,
const QRhiStats & info )

\variable QRhiStats::totalPipelineCreationTime

The total time in milliseconds spent in graphics and compute pipeline creation, which usually involves shader compilation or cache lookups, and potentially expensive processing.

Note
The value should not be compared between different backends since the concept of "pipelines" and what exactly happens under the hood during, for instance, a call to QRhiGraphicsPipeline::create(), differ greatly between graphics APIs and their implementations.
See also
QRhi::statistics()

\variable QRhiStats::blockCount

Statistic reported from the Vulkan or D3D12 memory allocator.

See also
QRhi::statistics()

\variable QRhiStats::allocCount

Statistic reported from the Vulkan or D3D12 memory allocator.

See also
QRhi::statistics()

\variable QRhiStats::usedBytes

Statistic reported from the Vulkan or D3D12 memory allocator.

See also
QRhi::statistics()

\variable QRhiStats::unusedBytes

Statistic reported from the Vulkan or D3D12 memory allocator.

See also
QRhi::statistics()

\variable QRhiStats::totalUsageBytes

Valid only with D3D12 currently. Matches IDXGIAdapter3::QueryVideoMemoryInfo().

See also
QRhi::statistics()

Definition at line 11131 of file qrhi.cpp.

◆ operator<<() [8/12]

◆ operator<<() [9/12]

QDebug operator<< ( QDebug dbg,
const QRhiVertexInputAttribute & a )

Definition at line 1914 of file qrhi.cpp.

◆ operator<<() [10/12]

QDebug operator<< ( QDebug dbg,
const QRhiVertexInputBinding & b )

Definition at line 1676 of file qrhi.cpp.

◆ operator<<() [11/12]

QDebug operator<< ( QDebug dbg,
const QRhiVertexInputLayout & v )

Definition at line 2157 of file qrhi.cpp.

◆ operator<<() [12/12]

QDebug operator<< ( QDebug dbg,
const QRhiViewport & v )

Definition at line 1431 of file qrhi.cpp.

◆ operator==()

Q_GUI_EXPORT bool operator== ( const QRhiShaderResourceBinding & a,
const QRhiShaderResourceBinding & b )
related

◆ Q_DECLARE_TYPEINFO() [1/16]

Q_DECLARE_TYPEINFO ( QRhiColorAttachment ,
Q_RELOCATABLE_TYPE  )

◆ Q_DECLARE_TYPEINFO() [2/16]

Q_DECLARE_TYPEINFO ( QRhiDepthStencilClearValue ,
Q_RELOCATABLE_TYPE  )

◆ Q_DECLARE_TYPEINFO() [3/16]

Q_DECLARE_TYPEINFO ( QRhiDriverInfo ,
Q_RELOCATABLE_TYPE  )

◆ Q_DECLARE_TYPEINFO() [4/16]

◆ Q_DECLARE_TYPEINFO() [5/16]

Q_DECLARE_TYPEINFO ( QRhiReadbackDescription ,
Q_RELOCATABLE_TYPE  )

◆ Q_DECLARE_TYPEINFO() [6/16]

Q_DECLARE_TYPEINFO ( QRhiScissor ,
Q_RELOCATABLE_TYPE  )

◆ Q_DECLARE_TYPEINFO() [7/16]

Q_DECLARE_TYPEINFO ( QRhiShaderResourceBinding ,
Q_PRIMITIVE_TYPE  )

◆ Q_DECLARE_TYPEINFO() [8/16]

Q_DECLARE_TYPEINFO ( QRhiShaderStage ,
Q_RELOCATABLE_TYPE  )

◆ Q_DECLARE_TYPEINFO() [9/16]

Q_DECLARE_TYPEINFO ( QRhiStats ,
Q_RELOCATABLE_TYPE  )

◆ Q_DECLARE_TYPEINFO() [10/16]

Q_DECLARE_TYPEINFO ( QRhiSwapChainHdrInfo ,
Q_RELOCATABLE_TYPE  )

◆ Q_DECLARE_TYPEINFO() [11/16]

Q_DECLARE_TYPEINFO ( QRhiTextureCopyDescription ,
Q_RELOCATABLE_TYPE  )

◆ Q_DECLARE_TYPEINFO() [12/16]

◆ Q_DECLARE_TYPEINFO() [13/16]

Q_DECLARE_TYPEINFO ( QRhiTextureUploadEntry ,
Q_RELOCATABLE_TYPE  )

◆ Q_DECLARE_TYPEINFO() [14/16]

Q_DECLARE_TYPEINFO ( QRhiVertexInputAttribute ,
Q_RELOCATABLE_TYPE  )

◆ Q_DECLARE_TYPEINFO() [15/16]

Q_DECLARE_TYPEINFO ( QRhiVertexInputBinding ,
Q_RELOCATABLE_TYPE  )

◆ Q_DECLARE_TYPEINFO() [16/16]

Q_DECLARE_TYPEINFO ( QRhiViewport ,
Q_RELOCATABLE_TYPE  )

◆ qHash()

size_t qHash ( const QRhiShaderResourceBinding & b,
size_t seed = 0 )
noexcept

\qhashold{QRhiShaderResourceBinding}

Definition at line 6556 of file qrhi.cpp.