Class RenderPassMetadata

Defines properties and message types for RenderPass.

Inherits properties and message types from ResourceMetadata.

Property Types

See also PropertyType
RenderPassMetadata.EnabledProperty

Whether Kanzi executes this render pass and its child render pass tree.

RenderPassMetadata.InputViewportAreaProperty

Reports the viewport area relative to the composition space as passed from the parent render pass.

To access the Input Viewport Area property fields in a binding, use:

  • X for the offset along the x axis relative to the composition space
  • Y for the offset along the y axis relative to the composition space
  • Z for the width of the viewport
  • W for the height of the viewport
RenderPassMetadata.UpdateRateProperty

Sets the rate at which to render the Render Pass. To render every frame, set to 1. To render every second frame, set to 2, and so on. To render only once, set to 0.

RenderPassMetadata.UpdateOffsetProperty

Sets a frame offset to the rendering rate that you set with the Update Rate property. This lets you cascade multiple updating Render Passes to different frames.

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.