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. More...
DynamicPropertyType< GraphicsCompareFunction >	DepthCompareFunctionProperty
	Sets the comparison function to be used with comparison samplers of the Cubemap Render Pass' depth target. More...
DynamicPropertyType< GraphicsFormat >	DepthFormatProperty
	Sets the format of the automatically created depth render buffer used for the cubemap rendering. More...
DynamicPropertyType< SamplerFilter >	FilterModeProperty
	Sets how Kanzi handles accessing the texture samples of the automatically generated composition cubemap target: More...
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.CubeMapRenderPass")
	Metaclass for CubeMapRenderPass.
DynamicPropertyType< SamplerMipmapMode >	MipmapModeProperty
	Sets the mipmap mode of the automatically created composition cubemap target. More...
DynamicPropertyType< String >	OverrideCameraProperty
	Sets the Camera node that you want to use to render the nodes to the composition cubemap texture. More...
DynamicPropertyType< GraphicsFormat >	PixelFormatProperty
	Sets on the GPU the target pixel format of the automatically created composition cubemap target textures. More...
DynamicPropertyType< Integer >	ResolutionProperty
	Sets the dimensions of the automatically created composition cubemap target textures. More...
DynamicPropertyType< Boolean >	ResolveImmediatelyProperty
	Whether to generate mipmaps for the composition target texture immediately after rendering. More...
DynamicPropertyType< Resource >	ResultDepthTextureProperty
	The cubemap depth texture to which the Cubemap Render Pass renders its content. More...
DynamicPropertyType< Resource >	ResultTextureProperty
	The result cubemap texture that was rendered to by the Cubemap Render Pass. More...
Public Attributes inherited from RenderPassMetadata
DynamicPropertyType< Boolean >	EnabledProperty
	Whether Kanzi executes this render pass and its child render pass tree. More...
DynamicPropertyType< Vector4 >	InputViewportAreaProperty
	Reports the viewport area relative to the composition space as passed from the parent render pass. More...
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.RenderPass")
	Metaclass for RenderPass.
Public Attributes inherited from ResourceMetadata
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.Resource")
	Metaclass for Resource.

Detailed Description

Metadata definitions for CubeMapRenderPass.

Member Data Documentation

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.

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.

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.

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.

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.

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.

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.

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.

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.

DynamicPropertyType<Resource> ResultDepthTextureProperty

Initial value:

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

The cubemap depth texture to which the Cubemap Render Pass renders its content.

DynamicPropertyType<Resource> ResultTextureProperty

Initial value:

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

The result cubemap texture that was rendered to by the Cubemap Render Pass.