QSSGRhiGraphicsPipelineState Class

Graphics pipeline state for the spatial scene graph. More...

Header: #include <QSSGRhiGraphicsPipelineState>
Since: Qt 6.7

Public Types

enum class Flag { DepthTestEnabled, DepthWriteEnabled, BlendEnabled, UsesStencilRef, UsesScissor }

Public Variables

Detailed Description

This class is a convenience class used by QtQuick3D to wrap relevant pipeline state from the QRhi classes, like QRhiGraphicsPipeline. Most of the types and value used in QSSGRhiGraphicsPipelineState will therefore map directly to an equivalent QRhi type or class.

Member Type Documentation

enum class QSSGRhiGraphicsPipelineState::Flag

ConstantValue
QSSGRhiGraphicsPipelineState::Flag::DepthTestEnabled0x1
QSSGRhiGraphicsPipelineState::Flag::DepthWriteEnabled0x2
QSSGRhiGraphicsPipelineState::Flag::BlendEnabled0x4
QSSGRhiGraphicsPipelineState::Flag::UsesStencilRef0x8
QSSGRhiGraphicsPipelineState::Flag::UsesScissor0x10

Member Variable Documentation

int QSSGRhiGraphicsPipelineState::colorAttachmentCount

The number of color attachments. The default is 1.

See also QRhiTextureRenderTargetDescription::setColorAttachments() and QRhiTextureRenderTargetDescription::colorAttachmentCount().

int QSSGRhiGraphicsPipelineState::depthBias

The depth bias. The default value is 0.

See also QRhiGraphicsPipeline::depthBias().

float QSSGRhiGraphicsPipelineState::lineWidth

The line width used. The default is 1.0

Note: For values other than 1.0 it's required that feature QRhi::WideLines is reported as supported at runtime.

int QSSGRhiGraphicsPipelineState::samples

The sample count.

Note: A sample count of 1 means no multisample antialiasing.

See also QRhiSwapChain::sampleCount().

int QSSGRhiGraphicsPipelineState::scissor

The scissor rect.

Note: Only used if UsesScissor is set.

See also QRhiCommandBuffer::setScissor().

float QSSGRhiGraphicsPipelineState::slopeScaledDepthBias

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

See also QRhiGraphicsPipeline::slopeScaledDepthBias().

int QSSGRhiGraphicsPipelineState::stencilRef

The active stencil reference value.

Note: Only used when UsesStencilRef is set.

See also QRhiCommandBuffer::setStencilRef().

int QSSGRhiGraphicsPipelineState::stencilWriteMask

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

See also QRhiGraphicsPipeline::stencilWriteMask().

int QSSGRhiGraphicsPipelineState::targetBlend

The blend state for one color attachment.

See also QRhiGraphicsPipeline::TargetBlend.

int QSSGRhiGraphicsPipelineState::viewport

The viewport dimensions used for rendering.