RenderPassMetadata Interface Reference

Metadata definitions for RenderPass. More...

Inheritance diagram for RenderPassMetadata:

Public Attributes
DynamicPropertyType< Boolean >	EnabledProperty
	Whether Kanzi executes this render pass and its child render pass tree.
DynamicPropertyType< Vector4 >	InputViewportAreaProperty
	Reports the viewport area relative to the composition space as passed from the parent render pass.
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.RenderPass")
	Metaclass for RenderPass.
DynamicPropertyType< Integer >	UpdateOffsetProperty
	Sets a frame offset to the rendering rate that you set with the Update Rate property.
DynamicPropertyType< Integer >	UpdateRateProperty
	Sets the rate at which to render the Render Pass.
Public Attributes inherited from ResourceMetadata
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.Resource")
	Metaclass for Resource.

Detailed Description

Metadata definitions for RenderPass.

Member Data Documentation

EnabledProperty

DynamicPropertyType<Boolean> EnabledProperty

Initial value:

=
        new DynamicPropertyType<>("RenderPass.Enabled", Boolean.class)

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

InputViewportAreaProperty

DynamicPropertyType<Vector4> InputViewportAreaProperty

Initial value:

=
        new DynamicPropertyType<>("RenderPass.InputViewportArea", Vector4.class)

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

UpdateOffsetProperty

DynamicPropertyType<Integer> UpdateOffsetProperty

Initial value:

=
        new DynamicPropertyType<>("RenderPass.UpdateOffset", Integer.class)

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.

UpdateRateProperty

DynamicPropertyType<Integer> UpdateRateProperty

Initial value:

=
        new DynamicPropertyType<>("RenderPass.UpdateRate", Integer.class)

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.