Class LegacyRenderPassMetadata

Defines properties and message types for LegacyRenderPass.

Inherits properties and message types from RenderPassMetadata.

Property Types

See also PropertyType
LegacyRenderPassMetadata.FlushAfterRenderProperty

This determines if GPU pipeline is flushed after rendering of this composer has occurred, to prevent GPU pipeline stall.

LegacyRenderPassMetadata.RenderPassCameraProperty

The camera that is used for rendering this render pass. When set to "Scene Default Camera" Kanzi uses the default camera node from the active scene.

LegacyRenderPassMetadata.RenderPassObjectSourceProperty

The object source for the render pass

LegacyRenderPassMetadata.RenderPassMaterialProperty

The material that overrides all the materials in the objects that are rendered by this render pass. When set to "No Material" material overriding is not in use.

LegacyRenderPassMetadata.RenderPassRenderTargetColor0Property

Sets where this render pass renders. You can set a render pass to render to screen or to a render target color0 attachment texture.

LegacyRenderPassMetadata.RenderPassRenderTargetColor1Property

Sets where this render pass renders. You can set a render pass to render to screen or to a render target color1 attachment texture.

LegacyRenderPassMetadata.RenderPassRenderTargetColor2Property

Sets where this render pass renders. You can set a render pass to render to screen or to a render target color2 attachment texture.

LegacyRenderPassMetadata.RenderPassRenderTargetColor3Property

Sets where this render pass renders. You can set a render pass to render to screen or to a render target color3 attachment texture.

LegacyRenderPassMetadata.RenderPassRenderTargetDepthStencilProperty

Render Target Depth Stencil

LegacyRenderPassMetadata.FrustumCullingOnProperty

Sets whether to use frustum culling. When frustum culling is enabled Kanzi does not render the objects that do not overlap with the viewing frustum of the camera.

LegacyRenderPassMetadata.CullModeProperty

Sets the culling of the triangle faces in the rendered meshes of legacy render passes:

  • Back does not render the triangles whose normal points away from the camera.
  • Front does not render the triangles whose normal points towards the camera.
LegacyRenderPassMetadata.RenderOnceProperty

Sets whether this render pass is rendered only once. When disabled this render passes renders every frame.

LegacyRenderPassMetadata.Color0IntegerClearValueProperty

Clear color value for integer color buffer 0

LegacyRenderPassMetadata.Color0FloatClearValueProperty

Clear color value for signed integer color buffer 0

LegacyRenderPassMetadata.Color1IntegerClearValueProperty

Clear color value for integer color buffer 1

LegacyRenderPassMetadata.Color1FloatClearValueProperty

Clear color value for signed integer color buffer 1

LegacyRenderPassMetadata.Color2IntegerClearValueProperty

Clear color value for integer color buffer 2

LegacyRenderPassMetadata.Color2FloatClearValueProperty

Clear color value for signed integer color buffer 2

LegacyRenderPassMetadata.Color3IntegerClearValueProperty

Clear color value for integer color buffer 3

LegacyRenderPassMetadata.Color3FloatClearValueProperty

Clear color value for signed integer color buffer 3

LegacyRenderPassMetadata.ColorBufferClearColorProperty

The color used to clear the color buffer 0

LegacyRenderPassMetadata.Color1ColorClearValueProperty

The color used to clear the color buffer 1

LegacyRenderPassMetadata.Color2ColorClearValueProperty

The color used to clear the color buffer 2

LegacyRenderPassMetadata.Color3ColorClearValueProperty

The color used to clear the color buffer 3

LegacyRenderPassMetadata.ColorBufferClearEnabledProperty

Whether to clear the color buffer before writing the new color values.

LegacyRenderPassMetadata.ColorWriteModeProperty

When set to None, writing to color buffer is disabled.

LegacyRenderPassMetadata.DepthBufferClearEnabledProperty

Sets whether to clear the depth buffer.

LegacyRenderPassMetadata.DepthBufferClearValueProperty

The value used for clearing the depth buffer.

LegacyRenderPassMetadata.DepthBufferTestEnabledProperty

Whether to enable the depth test.

LegacyRenderPassMetadata.DepthBufferWriteEnabledProperty

Sets whether to enable the writing of the depth buffer.

LegacyRenderPassMetadata.StencilBufferClearEnabledProperty

Sets whether to clear the stencil buffer.

LegacyRenderPassMetadata.StencilBufferClearValueProperty

The value used for clearing the stencil buffer.

LegacyRenderPassMetadata.StencilFailOperationProperty

Operation that is performed when the stencil test fails.

LegacyRenderPassMetadata.StencilPassDepthFailOperationProperty

Operation that is performed when the stencil test fails and the depth test passes.

LegacyRenderPassMetadata.StencilPassDepthPassOperationProperty

Operation that is performed when both the stencil and depth test pass.

LegacyRenderPassMetadata.StencilFunctionProperty

The function used to control whether a fragment is discarded by the stencil test.

LegacyRenderPassMetadata.StencilFunctionReferenceValueProperty

Specifies the reference value for the stencil test in legacy render passes.

LegacyRenderPassMetadata.StencilFunctionReferenceMaskProperty

Specifies a mask in legacy render passes that is ANDed with both the reference value and the stored stencil value when the test is done

LegacyRenderPassMetadata.StencilBufferTestEnabledProperty

Whether or not the stencil test is enabled

LegacyRenderPassMetadata.RenderPassScissorEnabledProperty

Whether scissor area is enabled in render pass or not. When scissor area is enabled rendering is done only inside the specified scissor area.

LegacyRenderPassMetadata.RenderPassScissorXProperty

X coordinate of the left border of the scissor area

LegacyRenderPassMetadata.RenderPassScissorYProperty

Y coordinate of the top border of the scissor area

LegacyRenderPassMetadata.RenderPassScissorWidthProperty

Width of the scissor area

LegacyRenderPassMetadata.RenderPassScissorHeightProperty

Height of the scissor area

LegacyRenderPassMetadata.RenderPassScissorTypeProperty

Whether the border settings of the scissor area are relative (range 0-1) or absolute (pixel coordinates).

LegacyRenderPassMetadata.RenderPassRenderTargetMipmapLevelProperty

Render Target Mipmap Level

LegacyRenderPassMetadata.RenderPassRenderTargetGenerateMipmapProperty

Sets whether the render target texture generates mipmaps after the render pass.

LegacyRenderPassMetadata.RenderPassRenderTargetResolveProperty

Sets whether the render target is multisample resolved after the render pass. When you want to apply multisampling, enable this property only in the last render pass.

LegacyRenderPassMetadata.RenderPassRenderTargetInvalidateAttachmentsProperty

Which attachments, if any, should be invalidated after the render pass.

LegacyRenderPassMetadata.ComposerEnabledProperty

This determines if composer is rendered (enabled by default).

LegacyRenderPassMetadata.ViewportXProperty

The X coordinate in v to render the render pass on the render target

LegacyRenderPassMetadata.ViewportYProperty

The Y coordinate in which to render the render pass on the render target

LegacyRenderPassMetadata.ViewportWidthProperty

The width of the render area on the render target

LegacyRenderPassMetadata.ViewportHeightProperty

The height of the render area on the render target

LegacyRenderPassMetadata.ViewportTypeProperty

When absolute, the viewport settings are read in pixel coordinates, when relative the settings are read as proportional values from top-left (0,0) corner to bottom-right (1,1) corner.

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.