Kanzi 4.1.0
ClearRenderPassMetadata Interface Reference

Metadata definitions for ClearRenderPass. More...

Inheritance diagram for ClearRenderPassMetadata:
[legend]

Public Attributes

DynamicPropertyType< ColorRGBA > ClearColor0Property
 Sets the color that you want the Clear render pass to use to clear the first (default) color buffer.
 
DynamicPropertyType< ColorRGBA > ClearColor1Property
 Sets the color that you want the Clear render pass to use to clear the second color buffer.
 
DynamicPropertyType< ColorRGBA > ClearColor2Property
 Sets the color that you want the Clear render pass to use to clear the third color buffer.
 
DynamicPropertyType< ColorRGBA > ClearColor3Property
 Sets the color that you want the Clear render pass to use to clear the fourth color buffer.
 
DynamicPropertyType< Float > ClearDepthProperty
 Sets the depth that you want the Clear render pass to use to clear the depth buffer.
 
DynamicPropertyType< Integer > ClearStencilProperty
 Sets the clear stencil that you want the Clear render pass to use to clear the stencil buffer.
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ClearRenderPass")
 Metaclass for ClearRenderPass.
 
- Public Attributes inherited from RenderPassMetadata
DynamicPropertyType< Matrix4x4 > CameraMatrixProperty
 The camera matrix that the render pass calculates during rendering from the settings of the Camera and passes to the shader.
 
DynamicPropertyType< Vector3 > CameraPositionProperty
 The camera position that the render pass calculates during rendering from the settings of the Camera and passes to the shader.
 
DynamicPropertyType< String > CameraProperty
 Sets the Camera node that you want to use to render the nodes.
 
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< Vector2 > NearFarPlaneProperty
 The distances to the camera near and far planes that the render pass calculates during rendering from the settings of the Camera and passes to the shader.
 
DynamicPropertyType< Vector4 > OutputViewportProperty
 Viewport applied by the rendering of the render pass.
 
DynamicPropertyType< Matrix4x4 > PreviousCameraMatrixProperty
 Camera matrix from the previous frame, used for velocity buffer calculation.
 
DynamicPropertyType< Matrix4x4 > PreviousProjectionMatrixProperty
 Projection matrix from the previous frame, used for velocity buffer calculation.
 
DynamicPropertyType< Matrix4x4 > ProjectionMatrixProperty
 The projection matrix that the render pass calculates during rendering from the settings of the Camera and passes to the shader.
 
DynamicPropertyType< Boolean > ShadowProjectionFittingEnabledProperty
 Controls how the directional light shadow projection is calculated Enabling this will fit the lights projection to the area covered by the main camera.
 
DynamicPropertyType< Vector3 > ShadowProjectionMarginProperty
 Use to add extra margin by scaling the area of the projection.
 
DynamicPropertyType< Vector2 > ShadowProjectionRangeProperty
 Use to limit the projection to a smaller proportional slice (X: near, Y: far) of the main camera frustum.
 
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.
 
DynamicPropertyType< Vector4 > ViewPositionProperty
 The homogeneous view position that the render pass calculates during rendering from the settings of the Camera and passes to the shader.
 
- Public Attributes inherited from ResourceMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Resource")
 Metaclass for Resource.
 

Detailed Description

Metadata definitions for ClearRenderPass.

Member Data Documentation

◆ ClearColor0Property

DynamicPropertyType<ColorRGBA> ClearColor0Property
Initial value:
=
new DynamicPropertyType<>("ClearRenderPass.ClearColor0", ColorRGBA.class)

Sets the color that you want the Clear render pass to use to clear the first (default) color buffer.

◆ ClearColor1Property

DynamicPropertyType<ColorRGBA> ClearColor1Property
Initial value:
=
new DynamicPropertyType<>("ClearRenderPass.ClearColor1", ColorRGBA.class)

Sets the color that you want the Clear render pass to use to clear the second color buffer.

◆ ClearColor2Property

DynamicPropertyType<ColorRGBA> ClearColor2Property
Initial value:
=
new DynamicPropertyType<>("ClearRenderPass.ClearColor2", ColorRGBA.class)

Sets the color that you want the Clear render pass to use to clear the third color buffer.

◆ ClearColor3Property

DynamicPropertyType<ColorRGBA> ClearColor3Property
Initial value:
=
new DynamicPropertyType<>("ClearRenderPass.ClearColor3", ColorRGBA.class)

Sets the color that you want the Clear render pass to use to clear the fourth color buffer.

◆ ClearDepthProperty

DynamicPropertyType<Float> ClearDepthProperty
Initial value:
=
new DynamicPropertyType<>("ClearRenderPass.ClearDepth", Float.class)

Sets the depth that you want the Clear render pass to use to clear the depth buffer.

◆ ClearStencilProperty

DynamicPropertyType<Integer> ClearStencilProperty
Initial value:
=
new DynamicPropertyType<>("ClearRenderPass.ClearStencil", Integer.class)

Sets the clear stencil that you want the Clear render pass to use to clear the stencil buffer.