Class PipelineStateRenderPassMetadata

Defines properties and message types for PipelineStateRenderPass.

Inherits properties and message types from RenderPassMetadata.

Property Types

See also PropertyType
PipelineStateRenderPassMetadata.BlendModeProperty

Overrides the blend mode set in each node that this render pass renders.

PipelineStateRenderPassMetadata.ColorWriteModeProperty

Sets which channels the render pass writes to the color buffer. To disable the color write, set the property to None.

PipelineStateRenderPassMetadata.CullModeProperty

Sets the culling of the triangle faces in the rendered meshes:

  • Back renders the triangles whose normal points towards a Camera node.
  • Front renders the triangles whose normal points away from a Camera node.
PipelineStateRenderPassMetadata.DepthTestFunctionProperty

Controls whether the depth test discards a fragment.

PipelineStateRenderPassMetadata.DepthWriteEnabledProperty

Sets whether the render pass writes to the depth buffer.

PipelineStateRenderPassMetadata.ViewportProperty

Modifies the current rendering Viewport node. You can define the Viewport in either relative or absolute coordinates, the default is relative. Use the Viewport Mode property to set the coordinate type.

PipelineStateRenderPassMetadata.ViewportModeProperty

Sets the coordinate type for the Viewport node.

PipelineStateRenderPassMetadata.ScissorProperty

Sets the scissor test in the current rendering Viewport 2D node. You can define the scissor in either relative or absolute coordinates, the default is relative. Use the Scissor Mode property to set the coordinate type.

PipelineStateRenderPassMetadata.ScissorModeProperty

Sets the scissor test coordinate mode.

PipelineStateRenderPassMetadata.StencilTestFunctionProperty

Controls whether the stencil test discards a fragment.

PipelineStateRenderPassMetadata.StencilReferenceValueProperty

Sets the reference value for the stencil test.

PipelineStateRenderPassMetadata.StencilMaskProperty

Sets a mask on which the AND operation is executed with both the reference value and the stored stencil value when the test is done.

PipelineStateRenderPassMetadata.StencilFailOperationProperty

Sets the operation that the render pass performs when the stencil test fails.

PipelineStateRenderPassMetadata.StencilPassDepthFailOperationProperty

Sets the operation that the render pass performs when the stencil test passes, but the depth test fails.

PipelineStateRenderPassMetadata.StencilPassDepthPassOperationProperty

Sets the operation that the render pass performs when both, the stencil and the depth test, pass.

PipelineStateRenderPassMetadata.StencilWriteEnabledProperty

Sets whether to enable writing to the stencil buffer.

PipelineStateRenderPassMetadata.PolygonDepthOffsetProperty

Sets the polygon depth offset to apply to the element that the Pipeline State Render Pass renders:

  • Derivative multiplier sets the multiplier for the depth change derivative for the fragment.
  • Constant multiplier multiplies the smallest measurable unit of depth, dependent on the target platform.

You can use the offset to render decals on the surfaces of filled polygons. Kanzi typically shows nearer the camera those polygons that have a negative offset.

Message Types

See also MessageType

Message Arguments

Message arguments classes define message arguments used for different message types. Each class defines a number of property types - arguments - together with getter and setter functions for them.