Kanzi 3.9.10
DrawObjectsRenderPassMetadata Interface Reference

Metadata definitions for DrawObjectsRenderPass. More...

Inheritance diagram for DrawObjectsRenderPassMetadata:
[legend]

Public Attributes

DynamicPropertyType< Matrix4x4CameraMatrixProperty
 The camera matrix that the Draw Objects Render Pass calculates during rendering from the settings of the Camera and passes to the shader.
 
DynamicPropertyType< Vector3CameraPositionProperty
 The camera position that the Draw Objects 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< BooleanFrustumCullingEnabledProperty
 Enable to disable rendering objects that are not inside the view frustum.
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.DrawObjectsRenderPass")
 Metaclass for DrawObjectsRenderPass.
 
DynamicPropertyType< Vector2NearFarPlaneProperty
 The distances to the camera near and far planes that the Draw Objects Render Pass calculates during rendering from the settings of the Camera and passes to the shader.
 
DynamicPropertyType< ResourceObjectSourceProperty
 Sets the object source which collects the nodes that you want to render with this render pass.
 
DynamicPropertyType< Matrix4x4ProjectionMatrixProperty
 The projection matrix that the Draw Objects Render Pass calculates during rendering from the settings of the Camera and passes to the shader.
 
DynamicPropertyType< Vector4ViewportProperty
 Viewport applied by the rendering of the Draw Objects Render Pass.
 
DynamicPropertyType< Vector4ViewPositionProperty
 The homogeneous view position that the Draw Objects Render Pass calculates during rendering from the settings of the Camera and passes to the shader.
 
- Public Attributes inherited from RenderPassMetadata
DynamicPropertyType< BooleanEnabledProperty
 Whether Kanzi executes this render pass and its child render pass tree.
 
DynamicPropertyType< Vector4InputViewportAreaProperty
 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 DrawObjectsRenderPass.

Member Data Documentation

◆ CameraMatrixProperty

DynamicPropertyType<Matrix4x4> CameraMatrixProperty
Initial value:
=
new DynamicPropertyType<>("DrawObjectsRenderPass.CameraMatrix", Matrix4x4.class)

The camera matrix that the Draw Objects Render Pass calculates during rendering from the settings of the Camera and passes to the shader.

◆ CameraPositionProperty

DynamicPropertyType<Vector3> CameraPositionProperty
Initial value:
=
new DynamicPropertyType<>("DrawObjectsRenderPass.CameraPosition", Vector3.class)

The camera position that the Draw Objects Render Pass calculates during rendering from the settings of the Camera and passes to the shader.

◆ CameraProperty

DynamicPropertyType<String> CameraProperty
Initial value:
=
new DynamicPropertyType<>("RenderPass.Camera", String.class)

Sets the Camera node that you want to use to render the nodes.

To use the default Camera node in that Scene node, do not set the value for this property.

◆ FrustumCullingEnabledProperty

DynamicPropertyType<Boolean> FrustumCullingEnabledProperty
Initial value:
=
new DynamicPropertyType<>("DrawObjectsRenderPass.FrustumCullingEnabled", Boolean.class)

Enable to disable rendering objects that are not inside the view frustum.

Trades GPU rendering time for CPU cull test time.

◆ NearFarPlaneProperty

DynamicPropertyType<Vector2> NearFarPlaneProperty
Initial value:
=
new DynamicPropertyType<>("DrawObjectsRenderPass.NearFarPlane", Vector2.class)

The distances to the camera near and far planes that the Draw Objects Render Pass calculates during rendering from the settings of the Camera and passes to the shader.

◆ ObjectSourceProperty

DynamicPropertyType<Resource> ObjectSourceProperty
Initial value:
=
new DynamicPropertyType<>("DrawObjectsRenderPass.ObjectSource", Resource.class)

Sets the object source which collects the nodes that you want to render with this render pass.

To render all nodes in a Scene node (Root Object Source), do not set the value for this property.

◆ ProjectionMatrixProperty

DynamicPropertyType<Matrix4x4> ProjectionMatrixProperty
Initial value:
=
new DynamicPropertyType<>("DrawObjectsRenderPass.ProjectionMatrix", Matrix4x4.class)

The projection matrix that the Draw Objects Render Pass calculates during rendering from the settings of the Camera and passes to the shader.

◆ ViewportProperty

DynamicPropertyType<Vector4> ViewportProperty
Initial value:
=
new DynamicPropertyType<>("DrawObjectsRenderPass.Viewport", Vector4.class)

Viewport applied by the rendering of the Draw Objects Render Pass.

◆ ViewPositionProperty

DynamicPropertyType<Vector4> ViewPositionProperty
Initial value:
=
new DynamicPropertyType<>("DrawObjectsRenderPass.ViewPosition", Vector4.class)

The homogeneous view position that the Draw Objects Render Pass calculates during rendering from the settings of the Camera and passes to the shader.