CubeMapRenderPassMetadata Interface Reference

Metadata definitions for CubeMapRenderPass. More...

Inheritance diagram for CubeMapRenderPassMetadata:

Public Attributes
DynamicPropertyType< Resource >	CompositionTargetProperty
	Sets the target to which you want to render the result of this Cubemap render pass.
DynamicPropertyType< GraphicsCompareFunction >	DepthCompareFunctionProperty
	Sets the comparison function to be used with comparison samplers of the Cubemap render pass' depth target.
DynamicPropertyType< GraphicsFormat >	DepthFormatProperty
	Sets the format of the automatically created depth render buffer used for the cubemap rendering.
DynamicPropertyType< GraphicsFormat >	DepthRenderbufferFormatProperty
	Sets the format of the automatically created depth renderbuffers.
DynamicPropertyType< Resource >	DepthTargetProperty
	Sets the target for depth rendering for this Cubemap render pass.
DynamicPropertyType< Integer >	FaceUpdateRateProperty
	Sets the number of cubemap faces to update each frame or at the rate that you set with the Render Pass > Update Rate property.
DynamicPropertyType< SamplerFilter >	FilterModeProperty
	Sets how Kanzi handles accessing the texture samples of the automatically generated composition cubemap target:
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.CubeMapRenderPass")
	Metaclass for CubeMapRenderPass.
DynamicPropertyType< SamplerMipmapMode >	MipmapModeProperty
	Sets the mipmap mode of the automatically created composition cubemap target.
DynamicPropertyType< String >	OverrideCameraProperty
	Sets the Camera node that you want to use to render the nodes to the composition cubemap texture.
DynamicPropertyType< GraphicsFormat >	PixelFormatProperty
	Sets on the GPU the target pixel format of the automatically created composition cubemap target textures.
DynamicPropertyType< Integer >	ResolutionProperty
	Sets the dimensions of the automatically created composition cubemap target textures.
DynamicPropertyType< Boolean >	ResolveImmediatelyProperty
	Whether to generate mipmaps for the composition target texture immediately after rendering.
DynamicPropertyType< Resource >	ResultDepthTextureProperty
	The cubemap depth texture to which the Cubemap render pass renders its content.
DynamicPropertyType< Resource >	ResultTextureProperty
	The result cubemap texture that was rendered to by the Cubemap render pass.
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 MipmapGenerationConceptMetadata
DynamicPropertyType< Resource >	ColorMipmapMaterial0Property
	Sets the material to use to generate the mipmaps for the first color result texture (Result Texture 0) of a Composition Target Render Pass.
DynamicPropertyType< Resource >	ColorMipmapMaterial1Property
	Sets the material to use to generate the mipmaps for the second color result texture (Result Texture 1) of a Composition Target Render Pass.
DynamicPropertyType< Resource >	ColorMipmapMaterial2Property
	Sets the material to use to generate the mipmaps for the third color result texture (Result Texture 2) of a Composition Target Render Pass.
DynamicPropertyType< Resource >	ColorMipmapMaterial3Property
	Sets the material to use to generate the mipmaps for the fourth color result texture (Result Texture 3) of a Composition Target Render Pass.
DynamicPropertyType< Resource >	CubemapMipmapMaterialProperty
	Sets the material to use to generate the mipmaps for the color Result Texture of a Cubemap Render Pass.
DynamicPropertyType< Float >	CurrentMipmapLevelProperty
	Reports the mipmap level that Kanzi is generating.
DynamicPropertyType< Resource >	DepthMipmapMaterialProperty
	Sets the material to use to generate the mipmaps for the Result Depth Texture of a Composition Target Render Pass.
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.MipmapGenerationConcept")
	Metaclass for MipmapGenerationConcept.
DynamicPropertyType< Resource >	MipmapSourceTextureProperty
	Reports the texture that contains the render target texture for which Kanzi creates mipmaps.

Detailed Description

Metadata definitions for CubeMapRenderPass.

Member Data Documentation

CompositionTargetProperty

DynamicPropertyType<Resource> CompositionTargetProperty

Initial value:

=
        new DynamicPropertyType<>("CubeMapRenderPass.CompositionTarget", Resource.class)

Sets the target to which you want to render the result of this Cubemap render pass.

DepthCompareFunctionProperty

DynamicPropertyType<GraphicsCompareFunction> DepthCompareFunctionProperty

Initial value:

=
        new DynamicPropertyType<>(
            "CubeMapRenderPass.DepthCompareFunction", GraphicsCompareFunction.class)

Sets the comparison function to be used with comparison samplers of the Cubemap render pass' depth target.

DepthFormatProperty

DynamicPropertyType<GraphicsFormat> DepthFormatProperty

Initial value:

=
        new DynamicPropertyType<>("CubeMapRenderPass.DepthFormat", GraphicsFormat.class)

Sets the format of the automatically created depth render buffer used for the cubemap rendering.

If this property is not set, the depth requirement and format are autodetected.

DepthRenderbufferFormatProperty

DynamicPropertyType<GraphicsFormat> DepthRenderbufferFormatProperty

Initial value:

= new DynamicPropertyType<>(
        "CubeMapRenderPass.DepthRenderbufferFormat", GraphicsFormat.class)

Sets the format of the automatically created depth renderbuffers.

When you do not set this property, Kanzi sets the depth renderbuffer format automatically to the best available format, in most cases the 32-bit float format. To create depth textures, set the Depth Format property whose value overrides the value of this property.

DepthTargetProperty

DynamicPropertyType<Resource> DepthTargetProperty

Initial value:

=
        new DynamicPropertyType<>("CubeMapRenderPass.DepthTarget", Resource.class)

Sets the target for depth rendering for this Cubemap render pass.

FaceUpdateRateProperty

DynamicPropertyType<Integer> FaceUpdateRateProperty

Initial value:

=
        new DynamicPropertyType<>("CubeMapRenderPass.FaceUpdateRate", Integer.class)

Sets the number of cubemap faces to update each frame or at the rate that you set with the Render Pass > Update Rate property.

The default value is 6.

FilterModeProperty

DynamicPropertyType<SamplerFilter> FilterModeProperty

Initial value:

=
        new DynamicPropertyType<>("CubeMapRenderPass.FilterMode", SamplerFilter.class)

Sets how Kanzi handles accessing the texture samples of the automatically generated composition cubemap target:

• Nearest takes the color from the nearest sample.
• Linear interpolates color from neighboring samples. This is the default value.

MipmapModeProperty

DynamicPropertyType<SamplerMipmapMode> MipmapModeProperty

Initial value:

=
        new DynamicPropertyType<>("CubeMapRenderPass.MipmapMode", SamplerMipmapMode.class)

Sets the mipmap mode of the automatically created composition cubemap target.

To enable mipmaps set the property value to Linear or Nearest. Enabling mipmaps introduces the runtime cost of generating mipmaps after rendering. To disable mipmaps remove the property.

OverrideCameraProperty

DynamicPropertyType<String> OverrideCameraProperty

Initial value:

=
        new DynamicPropertyType<>("CubeMapRenderPass.OverrideCamera", String.class)

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

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

PixelFormatProperty

DynamicPropertyType<GraphicsFormat> PixelFormatProperty

Initial value:

=
        new DynamicPropertyType<>("CubeMapRenderPass.PixelFormat", GraphicsFormat.class)

Sets on the GPU the target pixel format of the automatically created composition cubemap target textures.

ResolutionProperty

DynamicPropertyType<Integer> ResolutionProperty

Initial value:

=
        new DynamicPropertyType<>("CubeMapRenderPass.Resolution", Integer.class)

Sets the dimensions of the automatically created composition cubemap target textures.

The default value is 64.

ResolveImmediatelyProperty

DynamicPropertyType<Boolean> ResolveImmediatelyProperty

Initial value:

=
        new DynamicPropertyType<>("CubeMapRenderPass.ResolveImmediately", Boolean.class)

Whether to generate mipmaps for the composition target texture immediately after rendering.

By default the Cubemap render pass generates mipmaps immediately. When you continue rendering to the composition target in another Cubemap render pass that performs the resolve, disable this property.

ResultDepthTextureProperty

DynamicPropertyType<Resource> ResultDepthTextureProperty

Initial value:

=
        new DynamicPropertyType<>("CubeMapRenderPass.ResultDepthTexture", Resource.class)

The cubemap depth texture to which the Cubemap render pass renders its content.

ResultTextureProperty

DynamicPropertyType<Resource> ResultTextureProperty

Initial value:

=
        new DynamicPropertyType<>("CubeMapRenderPass.ResultTexture", Resource.class)

The result cubemap texture that was rendered to by the Cubemap render pass.