Class PipelineStateRenderPass

Class Hierarchy

Use the Pipeline State Render Pass to set for its child render passes the depth and stencil testing, transparency, and culling. This render pass sets the rendering state before passing the control to its descendants. After the descendant render passes of a Pipeline State Render Pass execute, Kanzi restores the rendering state. If a Pipeline State Render Pass does not have any descendants, Kanzi does not apply the rendering state you set in that render pass.

You change the rendering state by setting the properties in a Pipeline State Render Pass. The default settings in a Pipeline State Render Pass that you can set are:

  • BlendModeProperty property is set to Premultiplied alpha
  • ColorWriteModeProperty property is set to RGBA
  • Depth test is enabled and DepthTestFunctionProperty is set to Less
  • DepthWriteEnabledProperty property is enabled
  • CullModeProperty property is enabled and set to Back
  • StencilTestFunctionProperty property is disabled
  • ViewportProperty property is set to the complete size of Viewport2D node or of the current composition target set by a CompositionTargetRenderPass
  • ScissorProperty property is disabled, unless the current Viewport2D node does not fill the whole composition target area
  • PolygonDepthOffsetProperty property is not set.

Kanzi groups the rendering state combinations that a Pipeline State Render Pass applies into these state stacks:

  • Color and blend state
  • Depth and stencil state
  • Composition (viewport and scissor) state
  • Rasterization state

If you do not set a property, Kanzi uses the default or previously set value. See CompositionStack.

Use a Pipeline State render pass to set for its child render passes the depth and stencil testing, transparency, and culling.

Inherits properties and message types from PipelineStateRenderPassMetadata.

Synopsis

Methods
create()

Create a Pipeline State Render Pass

PipelineStateRenderPass.PipelineStateRenderPass:create(name)

Create a Pipeline State Render Pass.

Parameters
name (string)

The name of the Pipeline State Render Pass.

Return Values
(PipelineStateRenderPass)

The created Pipeline State Render Pass.