QRhiGraphicsPipeline Class

 QRhiShaderResourceBindings *srb;
 QRhiRenderPassDescriptor *rpDesc;
 QShader vs, fs;
 // ...

 QRhiVertexInputLayout inputLayout;
 inputLayout.setBindings({ { 3 * sizeof(float) } });
 inputLayout.setAttributes({ { 0, 0, QRhiVertexInputAttribute::Float3, 0 } });

 QRhiGraphicsPipeline *ps = rhi->newGraphicsPipeline();
 ps->setShaderStages({ { QRhiShaderStage::Vertex, vs }, { QRhiShaderStage::Fragment, fs } });
 ps->setVertexInputLayout(inputLayout);
 ps->setShaderResourceBindings(srb);
 ps->setRenderPassDescriptor(rpDesc);
 if (!ps->create()) { error(); }

Member Function Documentation

const QRhiShaderStage *QRhiGraphicsPipeline::cbeginShaderStages() const

Returns a const iterator pointing to the first item in the shader stage list.

const QRhiGraphicsPipeline::TargetBlend *QRhiGraphicsPipeline::cbeginTargetBlends() const

Returns a const iterator pointing to the first item in the render target blend setting list.

const QRhiShaderStage *QRhiGraphicsPipeline::cendShaderStages() const

Returns a const iterator pointing just after the last item in the shader stage list.

const QRhiGraphicsPipeline::TargetBlend *QRhiGraphicsPipeline::cendTargetBlends() const

Returns a const iterator pointing just after the last item in the render target blend setting list.

[pure virtual] bool QRhiGraphicsPipeline::create()

Creates the corresponding native graphics resources. If there are already resources present due to an earlier create() with no corresponding destroy(), then destroy() is called implicitly first.

Returns true when successful, false when a graphics operation failed. Regardless of the return value, calling destroy() is always safe.

QRhiGraphicsPipeline::CullMode QRhiGraphicsPipeline::cullMode() const

Returns the currently set face culling mode.

See also setCullMode().

int QRhiGraphicsPipeline::depthBias() const

Returns the currently set depth bias.

See also setDepthBias().

QRhiGraphicsPipeline::CompareOp QRhiGraphicsPipeline::depthOp() const

Returns the depth comparison function.

See also setDepthOp().

QRhiGraphicsPipeline::Flags QRhiGraphicsPipeline::flags() const

Returns the currently set flags.

See also setFlags().

QRhiGraphicsPipeline::FrontFace QRhiGraphicsPipeline::frontFace() const

Returns the currently set front face mode.

See also setFrontFace().

bool QRhiGraphicsPipeline::hasDepthTest() const

Returns true if depth testing is enabled.

bool QRhiGraphicsPipeline::hasDepthWrite() const

Returns true if depth write is enabled.

bool QRhiGraphicsPipeline::hasStencilTest() const

Returns true if stencil testing is enabled.

float QRhiGraphicsPipeline::lineWidth() const

Returns the currently set line width. The default is 1.0f.

See also setLineWidth().

[since 6.7] int QRhiGraphicsPipeline::multiViewCount() const

Returns the view count. The default is 0, indicating no multiview rendering.

This function was introduced in Qt 6.7.

See also setMultiViewCount().

int QRhiGraphicsPipeline::patchControlPointCount() const

Returns the currently set patch control point count.

See also setPatchControlPointCount().

QRhiGraphicsPipeline::PolygonMode QRhiGraphicsPipeline::polygonMode() const

Returns the polygon mode.

See also setPolygonMode().

QRhiRenderPassDescriptor *QRhiGraphicsPipeline::renderPassDescriptor() const

Returns the currently set QRhiRenderPassDescriptor.

See also setRenderPassDescriptor().

[override virtual] QRhiResource::Type QRhiGraphicsPipeline::resourceType() const

Reimplements: QRhiResource::resourceType() const.

Returns the resource type.

int QRhiGraphicsPipeline::sampleCount() const

Returns the currently set sample count. 1 means no multisample antialiasing.

See also setSampleCount().

void QRhiGraphicsPipeline::setCullMode(QRhiGraphicsPipeline::CullMode mode)

Sets the specified face culling mode.

See also cullMode().

void QRhiGraphicsPipeline::setDepthBias(int bias)

Sets the depth bias. The default value is 0.

See also depthBias().

void QRhiGraphicsPipeline::setDepthOp(QRhiGraphicsPipeline::CompareOp op)

Sets the depth comparison function op.

See also depthOp().

void QRhiGraphicsPipeline::setDepthTest(bool enable)

Enables or disables depth testing based on enable. Both depth test and the writing out of depth data are disabled by default.

See also hasDepthTest() and setDepthWrite().

void QRhiGraphicsPipeline::setDepthWrite(bool enable)

Controls the writing out of depth data into the depth buffer based on enable. By default this is disabled. Depth write is typically enabled together with the depth test.

See also hasDepthWrite() and setDepthTest().

void QRhiGraphicsPipeline::setFlags(QRhiGraphicsPipeline::Flags f)

Sets the flags f.

See also flags().

void QRhiGraphicsPipeline::setFrontFace(QRhiGraphicsPipeline::FrontFace f)

Sets the front face mode f.

See also frontFace().

void QRhiGraphicsPipeline::setLineWidth(float width)

Sets the line width. If the QRhi::WideLines feature is reported as unsupported at runtime, values other than 1.0f are ignored.

See also lineWidth().

[since 6.7] void QRhiGraphicsPipeline::setMultiViewCount(int count)

Sets the view count for multiview rendering. The default is 0, indicating no multiview rendering. count must be 2 or larger to trigger multiview rendering.

Multiview is only available when the MultiView feature is reported as supported. The render target must be a 2D texture array, and the color attachment for the render target must have the same count set.

See QRhiColorAttachment::setMultiViewCount() for further details on multiview rendering.

This function was introduced in Qt 6.7.

See also multiViewCount(), QRhi::MultiView, and QRhiColorAttachment::setMultiViewCount().

void QRhiGraphicsPipeline::setPatchControlPointCount(int count)

Sets the number of patch control points to count. The default value is 3. This is used only when the topology is set to Patches.

See also patchControlPointCount().

void QRhiGraphicsPipeline::setPolygonMode(QRhiGraphicsPipeline::PolygonMode mode)

Sets the polygon mode. The default is Fill.

See also polygonMode() and QRhi::NonFillPolygonMode.

void QRhiGraphicsPipeline::setRenderPassDescriptor(QRhiRenderPassDescriptor *desc)

Associates with the specified QRhiRenderPassDescriptor desc.

See also renderPassDescriptor().

void QRhiGraphicsPipeline::setSampleCount(int s)

Sets the sample count. Typical values for s are 1, 4, or 8. The pipeline must always be compatible with the render target, i.e. the sample counts must match.

See also sampleCount() and QRhi::supportedSampleCounts().

void QRhiGraphicsPipeline::setShaderResourceBindings(QRhiShaderResourceBindings *srb)

Associates with srb describing the resource binding layout and the resources (QRhiBuffer, QRhiTexture) themselves. The latter is optional, because only the layout matters during pipeline creation. Therefore, the srb passed in here can leave the actual buffer or texture objects unspecified (nullptr) as long as there is another, layout-compatible QRhiShaderResourceBindings bound via setShaderResources() before recording the draw calls.

See also shaderResourceBindings().

void QRhiGraphicsPipeline::setShaderStages(std::initializer_list<QRhiShaderStage> list)

Sets the list of shader stages.

template <typename InputIterator> void QRhiGraphicsPipeline::setShaderStages(InputIterator first, InputIterator last)

Sets the list of shader stages from the iterators first and last.

void QRhiGraphicsPipeline::setSlopeScaledDepthBias(float bias)

Sets the slope scaled depth bias. The default value is 0.

See also slopeScaledDepthBias().

void QRhiGraphicsPipeline::setStencilBack(const QRhiGraphicsPipeline::StencilOpState &state)

Sets the stencil test state for back faces.

See also stencilBack().

void QRhiGraphicsPipeline::setStencilFront(const QRhiGraphicsPipeline::StencilOpState &state)

Sets the stencil test state for front faces.

See also stencilFront().

void QRhiGraphicsPipeline::setStencilReadMask(quint32 mask)

Sets the stencil read mask. The default value is 0xFF.

See also stencilReadMask().

void QRhiGraphicsPipeline::setStencilTest(bool enable)

Enables or disables stencil tests based on enable. By default this is disabled.

See also hasStencilTest().

void QRhiGraphicsPipeline::setStencilWriteMask(quint32 mask)

Sets the stencil write mask. The default value is 0xFF.

See also stencilWriteMask().

void QRhiGraphicsPipeline::setTargetBlends(std::initializer_list<QRhiGraphicsPipeline::TargetBlend> list)

Sets the list of render target blend settings. This is a list because when multiple render targets are used (i.e., a QRhiTextureRenderTarget with more than one QRhiColorAttachment), there needs to be a TargetBlend structure per render target (color attachment).

By default there is one default-constructed TargetBlend set.

See also QRhi::MaxColorAttachments.

template <typename InputIterator> void QRhiGraphicsPipeline::setTargetBlends(InputIterator first, InputIterator last)

Sets the list of render target blend settings from the iterators first and last.

void QRhiGraphicsPipeline::setTopology(QRhiGraphicsPipeline::Topology t)

Sets the primitive topology t.

See also topology().

void QRhiGraphicsPipeline::setVertexInputLayout(const QRhiVertexInputLayout &layout)

Specifies the vertex input layout.

See also vertexInputLayout().

QRhiShaderResourceBindings *QRhiGraphicsPipeline::shaderResourceBindings() const

Returns the currently associated QRhiShaderResourceBindings object.

See also setShaderResourceBindings().

const QRhiShaderStage *QRhiGraphicsPipeline::shaderStageAt(qsizetype index) const

Returns the shader stage at the specified index.

qsizetype QRhiGraphicsPipeline::shaderStageCount() const

Returns the number of shader stages in this pipeline.

float QRhiGraphicsPipeline::slopeScaledDepthBias() const

Returns the currently set slope scaled depth bias.

See also setSlopeScaledDepthBias().

QRhiGraphicsPipeline::StencilOpState QRhiGraphicsPipeline::stencilBack() const

Returns the current stencil test state for back faces.

See also setStencilBack().

QRhiGraphicsPipeline::StencilOpState QRhiGraphicsPipeline::stencilFront() const

Returns the current stencil test state for front faces.

See also setStencilFront().

quint32 QRhiGraphicsPipeline::stencilReadMask() const

Returns the currrent stencil read mask.

See also setStencilReadMask().

quint32 QRhiGraphicsPipeline::stencilWriteMask() const

Returns the current stencil write mask.

See also setStencilWriteMask().

const QRhiGraphicsPipeline::TargetBlend *QRhiGraphicsPipeline::targetBlendAt(qsizetype index) const

Returns the render target blend setting at the specified index.

qsizetype QRhiGraphicsPipeline::targetBlendCount() const

Returns the number of render target blend settings.

QRhiGraphicsPipeline::Topology QRhiGraphicsPipeline::topology() const

Returns the currently set primitive topology.

See also setTopology().

QRhiVertexInputLayout QRhiGraphicsPipeline::vertexInputLayout() const

Returns the currently set vertex input layout specification.

See also setVertexInputLayout().