DrawObjectsRenderPassMetadata Interface Reference
Metadata definitions for DrawObjectsRenderPass. More...
Inheritance diagram for DrawObjectsRenderPassMetadata:
Public Attributes | |
| DynamicPropertyType< Boolean > | FrustumCullingEnabledProperty |
| Enable to disable rendering objects that are not inside the view frustum. | |
| DynamicPropertyType< String > | MaterialRequirementsProperty |
| Sets the material requirements required from materials selected for rendering. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.DrawObjectsRenderPass") |
| Metaclass for DrawObjectsRenderPass. | |
| DynamicPropertyType< Resource > | ObjectSourceProperty |
| Sets the object source which collects the nodes that you want to render with this render pass. | |
| DynamicPropertyType< DrawObjectsRenderPassEnums.SortingOrder > | SortingOrderProperty |
| Sets the sorting order for render entries. | |
 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. | |
| Public Attributes inherited from PipelineStateConceptMetadata | |
| DynamicPropertyType< Boolean > | AlphaToCoverageEnabledProperty |
| Sets whether Alpha To Coverage is enabled or not. | |
| DynamicPropertyType< Integer > | BlendModeProperty |
| Overrides the blend mode set in each node that this render pass renders. | |
| DynamicPropertyType< ColorWriteMask > | ColorWriteModeProperty |
| Sets which channels the render pass writes to the color buffer. | |
| DynamicPropertyType< GraphicsCullMode > | CullModeProperty |
| Sets the culling of the triangle faces in the rendered meshes: | |
| DynamicPropertyType< GraphicsCompareFunction > | DepthTestFunctionProperty |
| Controls whether the depth test discards a fragment. | |
| DynamicPropertyType< Boolean > | DepthWriteEnabledProperty |
| Sets whether the render pass writes to the depth buffer. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.PipelineStateConcept") |
| Metaclass for PipelineStateConcept. | |
| DynamicPropertyType< Vector2 > | PolygonDepthOffsetProperty |
| Sets the polygon depth offset to apply to the element that the Pipeline State render pass renders: | |
| DynamicPropertyType< PipelineStateConceptEnums.ViewportMode > | ScissorModeProperty |
| Sets the scissor test coordinate mode. | |
| DynamicPropertyType< Vector4 > | ScissorProperty |
| Sets the scissor test in the current rendering Viewport 2D node. | |
| DynamicPropertyType< GraphicsStencilOperation > | StencilFailOperationProperty |
| Sets the operation that the render pass performs when the stencil test fails. | |
| DynamicPropertyType< Integer > | StencilMaskProperty |
| Sets a mask on which the AND operation is executed with both the reference value and the stored stencil value when the test is done. | |
| DynamicPropertyType< GraphicsStencilOperation > | StencilPassDepthFailOperationProperty |
| Sets the operation that the render pass performs when the stencil test passes, but the depth test fails. | |
| DynamicPropertyType< GraphicsStencilOperation > | StencilPassDepthPassOperationProperty |
| Sets the operation that the render pass performs when both, the stencil and the depth test, pass. | |
| DynamicPropertyType< Integer > | StencilReferenceValueProperty |
| Sets the reference value for the stencil test. | |
| DynamicPropertyType< GraphicsCompareFunction > | StencilTestFunctionProperty |
| Controls whether the stencil test discards a fragment. | |
| DynamicPropertyType< Boolean > | StencilWriteEnabledProperty |
| Sets whether to enable writing to the stencil buffer. | |
| DynamicPropertyType< PipelineStateConceptEnums.ViewportMode > | ViewportModeProperty |
| Sets the coordinate type for the Viewport node. | |
| DynamicPropertyType< Vector4 > | ViewportProperty |
| Modifies the current rendering Viewport node. | |
Detailed Description
Metadata definitions for DrawObjectsRenderPass.
Member Data Documentation
◆ 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.
◆ MaterialRequirementsProperty
| DynamicPropertyType<String> MaterialRequirementsProperty |
Initial value:
=
new DynamicPropertyType<>("DrawObjectsRenderPass.MaterialRequirements", String.class)
Sets the material requirements required from materials selected for rendering.
◆ 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.
◆ SortingOrderProperty
| DynamicPropertyType<DrawObjectsRenderPassEnums.SortingOrder> SortingOrderProperty |
Initial value:
=
new DynamicPropertyType<>(
"DrawObjectsRenderPass.SortingOrder", DrawObjectsRenderPassEnums.SortingOrder.class)
Sets the sorting order for render entries.