QRhiComputePipeline Class Reference

\inmodule QtGui More...

#include <qrhi.h>

Inheritance diagram for QRhiComputePipeline:

Collaboration diagram for QRhiComputePipeline:

Public Types
enum	Flag { CompileShadersWithDebugInfo = 1 << 0 }
	Flag values for describing pipeline options. More...
Public Types inherited from QRhiResource
enum	Type {   Buffer , Texture , Sampler , RenderBuffer ,   RenderPassDescriptor , SwapChainRenderTarget , TextureRenderTarget , ShaderResourceBindings ,   GraphicsPipeline , SwapChain , ComputePipeline , CommandBuffer }
	Specifies type of the resource. More...

Public Member Functions
QRhiResource::Type	resourceType () const override
virtual bool	create ()=0
Flags	flags () const
void	setFlags (Flags f)
	Sets the flags f.
QRhiShaderStage	shaderStage () const
void	setShaderStage (const QRhiShaderStage &stage)
	Sets the shader to use.
QRhiShaderResourceBindings *	shaderResourceBindings () const
void	setShaderResourceBindings (QRhiShaderResourceBindings *srb)
	Associates with srb describing the resource binding layout and the resources (QRhiBuffer, QRhiTexture) themselves.
Public Member Functions inherited from QRhiResource
virtual	~QRhiResource ()
	Destructor.
virtual Type	resourceType () const =0
virtual void	destroy ()=0
	Releases (or requests deferred releasing of) the underlying native graphics resources.
void	deleteLater ()
	When called without a frame being recorded, this function is equivalent to deleting the object.
QByteArray	name () const
void	setName (const QByteArray &name)
	Sets a name for the object.
quint64	globalResourceId () const
QRhi *	rhi () const

Protected Member Functions
	QRhiComputePipeline (QRhiImplementation *rhi)
Protected Member Functions inherited from QRhiResource
	QRhiResource (QRhiImplementation *rhi)

Protected Attributes
Flags	m_flags
QRhiShaderStage	m_shaderStage
QRhiShaderResourceBindings *	m_shaderResourceBindings = nullptr
Protected Attributes inherited from QRhiResource
QRhiImplementation *	m_rhi = nullptr
quint64	m_id
QByteArray	m_objectName

Detailed Description

\inmodule QtGui

Since

6.6

Compute pipeline state resource.

Note

Setting the shader resource bindings is mandatory. The referenced QRhiShaderResourceBindings must already have created() called on it by the time create() is called.

Setting the shader is mandatory.

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

Definition at line 1584 of file qrhi.h.

Member Enumeration Documentation

Flag

enum QRhiComputePipeline::Flag

Flag values for describing pipeline options.

\value CompileShadersWithDebugInfo Requests compiling shaders with debug information enabled, when applicable. See QRhiGraphicsPipeline::CompileShadersWithDebugInfo for more information.

Enumerator
CompileShadersWithDebugInfo

Definition at line 1587 of file qrhi.h.

Constructor & Destructor Documentation

QRhiComputePipeline()

QRhiComputePipeline::QRhiComputePipeline ( QRhiImplementation *  rhi )

protected

Definition at line 7546 of file qrhi.cpp.

Member Function Documentation

create()

virtual bool QRhiComputePipeline::create ( )

pure virtual

Implemented in QD3D11ComputePipeline, QGles2ComputePipeline, QMetalComputePipeline, QNullComputePipeline, and QVkComputePipeline.

Referenced by QSSGRhiContext::computePipeline().

Here is the caller graph for this function:

flags()

QRhiComputePipeline::Flags QRhiComputePipeline::flags ( ) const

inline

Returns

the currently set flags.

Definition at line 1595 of file qrhi.h.

resourceType()

QRhiResource::Type QRhiComputePipeline::resourceType ( ) const

overridevirtual

Returns

the resource type.

Implements QRhiResource.

Definition at line 7538 of file qrhi.cpp.

References QRhiResource::ComputePipeline.

setFlags()

void QRhiComputePipeline::setFlags ( Flags  f )

inline

Sets the flags f.

Definition at line 1596 of file qrhi.h.

setShaderResourceBindings()

void QRhiComputePipeline::setShaderResourceBindings ( QRhiShaderResourceBindings *  srb )

inline

Associates with srb describing the resource binding layout and the resources (QRhiBuffer, QRhiTexture) themselves.

The latter is optional. As with graphics pipelines, the srb passed in here can leave the actual buffer or texture objects unspecified (\nullptr) as long as there is another, \l{QRhiShaderResourceBindings::isLayoutCompatible()}{layout-compatible} QRhiShaderResourceBindings bound via \l{QRhiCommandBuffer::setShaderResources()}{setShaderResources()} before recording the dispatch call.

Definition at line 1602 of file qrhi.h.

Referenced by QSSGRhiContext::computePipeline().

Here is the caller graph for this function:

setShaderStage()

void QRhiComputePipeline::setShaderStage ( const QRhiShaderStage &  stage )

inline

Sets the shader to use.

stage can only refer to the \l{QRhiShaderStage::Compute}{compute stage}.

Definition at line 1599 of file qrhi.h.

Referenced by QSSGRhiContext::computePipeline().

Here is the caller graph for this function:

shaderResourceBindings()

QRhiShaderResourceBindings * QRhiComputePipeline::shaderResourceBindings ( ) const

inline

Returns

the currently associated QRhiShaderResourceBindings object.

Definition at line 1601 of file qrhi.h.

shaderStage()

QRhiShaderStage QRhiComputePipeline::shaderStage ( ) const

inline

Returns

the currently set shader.

Definition at line 1598 of file qrhi.h.

Member Data Documentation

m_flags

Flags QRhiComputePipeline::m_flags

protected

Definition at line 1606 of file qrhi.h.

Referenced by QD3D11ComputePipeline::create().

m_shaderResourceBindings

QRhiShaderResourceBindings* QRhiComputePipeline::m_shaderResourceBindings = nullptr

protected

Definition at line 1608 of file qrhi.h.

Referenced by QVkComputePipeline::create(), QRhiD3D11::setShaderResources(), QRhiGles2::setShaderResources(), QRhiMetal::setShaderResources(), and QRhiVulkan::setShaderResources().

m_shaderStage

QRhiShaderStage QRhiComputePipeline::m_shaderStage

protected

Definition at line 1607 of file qrhi.h.

Referenced by QD3D11ComputePipeline::create(), QGles2ComputePipeline::create(), QMetalComputePipeline::create(), and QVkComputePipeline::create().

---

The documentation for this class was generated from the following files:

• qtbase/src/gui/rhi/qrhi.h
• qtbase/src/gui/rhi/qrhi.cpp