Kanzi 3.9.10
Public Attributes | List of all members
CompositionTargetRenderPassMetadata Interface Reference

Metadata definitions for CompositionTargetRenderPass. More...

Inheritance diagram for CompositionTargetRenderPassMetadata:
[legend]

Public Attributes

DynamicPropertyType< SamplerAddressingMode > AddressingModeProperty
 Sets how Kanzi handles the texture coordinates of the automatically generated composition target textures outside of the [0, 0] - [1, 1] rectangle:
 
DynamicPropertyType< Resource > CompositionTarget0Property
 Sets the first color target to which you want to render the result of the child render passes of this render pass.
 
DynamicPropertyType< Resource > CompositionTarget1Property
 Sets the second color target to which you want to render the result of the child render passes of this render pass.
 
DynamicPropertyType< Resource > CompositionTarget2Property
 Sets the third color target to which you want to render the result of the child render passes of this render pass.
 
DynamicPropertyType< Resource > CompositionTarget3Property
 Sets the fourth color target to which you want to render the result of the child render passes of this render pass.
 
DynamicPropertyType< GraphicsCompareFunction > DepthCompareFunctionProperty
 Sets the comparison function to be used with comparison samplers of the Composition Target Render Pass' depth target.
 
DynamicPropertyType< GraphicsFormat > DepthRenderbufferFormatProperty
 Sets the format of the automatically created depth renderbuffers.
 
DynamicPropertyType< Resource > DepthTargetProperty
 Sets the depth target to which you want to render the result of the child render passes of this render pass.
 
DynamicPropertyType< GraphicsFormat > DepthTextureFormatProperty
 Sets the format of the automatically created Result Depth Texture.
 
DynamicPropertyType< SamplerFilter > FilterModeProperty
 Sets how Kanzi handles accessing the texture samples of the automatically generated composition target:
 
DynamicPropertyType< Integer > HeightProperty
 Sets the absolute height for the automatically created composition target textures.
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.CompositionTargetRenderPass")
 Metaclass for CompositionTargetRenderPass.
 
DynamicPropertyType< SamplerMipmapMode > MipmapModeProperty
 Sets the mipmap mode of the automatically created composition target.
 
DynamicPropertyType< MultisampleCount > MultisampleLevelProperty
 Sets the amount of multisample anti-aliasing to apply to the automatically generated composition target textures.
 
DynamicPropertyType< GraphicsFormat > PixelFormat0Property
 Sets on the GPU the target pixel format of the first automatically created composition target texture.
 
DynamicPropertyType< GraphicsFormat > PixelFormat1Property
 Sets on the GPU the target pixel format of the second automatically created composition target texture.
 
DynamicPropertyType< GraphicsFormat > PixelFormat2Property
 Sets on the GPU the target pixel format of the third automatically created composition target texture.
 
DynamicPropertyType< GraphicsFormat > PixelFormat3Property
 Sets on the GPU the target pixel format of the fourth automatically created composition target texture.
 
DynamicPropertyType< Integer > ResolutionDivisorProperty
 Sets the resolution divisor for the automatically created composition target textures.
 
DynamicPropertyType< Integer > ResolutionMultiplierProperty
 Sets the resolution multiplier for the automatically created composition target textures.
 
DynamicPropertyType< Boolean > ResolveImmediatelyProperty
 Whether to resolve multisamples and generate mipmaps for the composition target texture immediately after rendering.
 
DynamicPropertyType< Resource > ResultDepthTextureProperty
 The depth texture to which the Composition Target Render Pass renders its content.
 
DynamicPropertyType< Resource > ResultTexture0Property
 The first color texture to which the Composition Target Render Pass renders its content.
 
DynamicPropertyType< Resource > ResultTexture1Property
 The second color texture to which the Composition Target Render Pass renders its content.
 
DynamicPropertyType< Resource > ResultTexture2Property
 The third color texture to which the Composition Target Render Pass renders its content.
 
DynamicPropertyType< Resource > ResultTexture3Property
 The fourth color texture to which the Composition Target Render Pass renders its content.
 
DynamicPropertyType< Integer > WidthProperty
 Sets the absolute width for the automatically created composition target textures.
 
- Public Attributes inherited from RenderPassMetadata
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< 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.
 
- 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 CompositionTargetRenderPass.

Member Data Documentation

◆ AddressingModeProperty

DynamicPropertyType<SamplerAddressingMode> AddressingModeProperty
Initial value:
= new DynamicPropertyType<>(
"CompositionTargetRenderPass.AddressingMode", SamplerAddressingMode.class)

Sets how Kanzi handles the texture coordinates of the automatically generated composition target textures outside of the [0, 0] - [1, 1] rectangle:

  • Repeat sets the texture to repeat outside of these coordinates. This is the default value.
  • Mirror sets the texture to repeat, but mirrors every other repetition.
  • Clamp confines the texture to these coordinates and outside of these texture coordinates repeats the edge texels of the texture.
  • Mirror once sets the texture to repeat once in the negative direction, and after that clamps the texture.

◆ CompositionTarget0Property

DynamicPropertyType<Resource> CompositionTarget0Property
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.CompositionTarget0", Resource.class)

Sets the first color target to which you want to render the result of the child render passes of this render pass.

◆ CompositionTarget1Property

DynamicPropertyType<Resource> CompositionTarget1Property
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.CompositionTarget1", Resource.class)

Sets the second color target to which you want to render the result of the child render passes of this render pass.

◆ CompositionTarget2Property

DynamicPropertyType<Resource> CompositionTarget2Property
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.CompositionTarget2", Resource.class)

Sets the third color target to which you want to render the result of the child render passes of this render pass.

◆ CompositionTarget3Property

DynamicPropertyType<Resource> CompositionTarget3Property
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.CompositionTarget3", Resource.class)

Sets the fourth color target to which you want to render the result of the child render passes of this render pass.

◆ DepthCompareFunctionProperty

DynamicPropertyType<GraphicsCompareFunction> DepthCompareFunctionProperty
Initial value:
=
new DynamicPropertyType<>(
"CompositionTargetRenderPass.DepthCompareFunction", GraphicsCompareFunction.class)

Sets the comparison function to be used with comparison samplers of the Composition Target Render Pass' depth target.

◆ DepthRenderbufferFormatProperty

DynamicPropertyType<GraphicsFormat> DepthRenderbufferFormatProperty
Initial value:
= new DynamicPropertyType<>(
"CompositionTargetRenderPass.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 Texture Format property whose value overrides the value of this property.

◆ DepthTargetProperty

DynamicPropertyType<Resource> DepthTargetProperty
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.DepthTarget", Resource.class)

Sets the depth target to which you want to render the result of the child render passes of this render pass.

◆ DepthTextureFormatProperty

DynamicPropertyType<GraphicsFormat> DepthTextureFormatProperty
Initial value:
= new DynamicPropertyType<>(
"CompositionTargetRenderPass.DepthTextureFormat", GraphicsFormat.class)

Sets the format of the automatically created Result Depth Texture.

◆ FilterModeProperty

DynamicPropertyType<SamplerFilter> FilterModeProperty
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.FilterMode", SamplerFilter.class)

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

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

◆ HeightProperty

DynamicPropertyType<Integer> HeightProperty
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.Height", Integer.class)

Sets the absolute height for the automatically created composition target textures.

If this property is not set, the size is taken from the current composition stack state using the values of the Resolution Multiplier and Resolution Divisor properties.

◆ MipmapModeProperty

DynamicPropertyType<SamplerMipmapMode> MipmapModeProperty
Initial value:
= new DynamicPropertyType<>(
"CompositionTargetRenderPass.MipmapMode", SamplerMipmapMode.class)

Sets the mipmap mode of the automatically created composition target.

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

◆ MultisampleLevelProperty

DynamicPropertyType<MultisampleCount> MultisampleLevelProperty
Initial value:
= new DynamicPropertyType<>(
"CompositionTargetRenderPass.MultisampleLevel", MultisampleCount.class)

Sets the amount of multisample anti-aliasing to apply to the automatically generated composition target textures.

◆ PixelFormat0Property

DynamicPropertyType<GraphicsFormat> PixelFormat0Property
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.PixelFormat0", GraphicsFormat.class)

Sets on the GPU the target pixel format of the first automatically created composition target texture.

◆ PixelFormat1Property

DynamicPropertyType<GraphicsFormat> PixelFormat1Property
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.PixelFormat1", GraphicsFormat.class)

Sets on the GPU the target pixel format of the second automatically created composition target texture.

◆ PixelFormat2Property

DynamicPropertyType<GraphicsFormat> PixelFormat2Property
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.PixelFormat2", GraphicsFormat.class)

Sets on the GPU the target pixel format of the third automatically created composition target texture.

◆ PixelFormat3Property

DynamicPropertyType<GraphicsFormat> PixelFormat3Property
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.PixelFormat3", GraphicsFormat.class)

Sets on the GPU the target pixel format of the fourth automatically created composition target texture.

◆ ResolutionDivisorProperty

DynamicPropertyType<Integer> ResolutionDivisorProperty
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.ResolutionDivisor", Integer.class)

Sets the resolution divisor for the automatically created composition target textures.

Together with the Resolution Multiplier property, this property sets the size of the composition target in relation to the size of the current Viewport 2D node. For more fine-grained control, bind from the Render Pass > Input Viewport Area property to the Width and Height properties.

◆ ResolutionMultiplierProperty

DynamicPropertyType<Integer> ResolutionMultiplierProperty
Initial value:
= new DynamicPropertyType<>(
"CompositionTargetRenderPass.ResolutionMultiplier", Integer.class)

Sets the resolution multiplier for the automatically created composition target textures.

Together with the Resolution Divisor property, this property sets the size of the composition target in relation to the size of the current Viewport 2D node. For more fine-grained control, bind from the Render Pass > Input Viewport Area property to the Width and Height properties.

◆ ResolveImmediatelyProperty

DynamicPropertyType<Boolean> ResolveImmediatelyProperty
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.ResolveImmediately", Boolean.class)

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

By default, the Composition Target Render Pass resolves multisamples and generates mipmaps immediately. When you continue rendering to the composition target in another Composition Target Render Pass that performs the resolve, disable this property.

◆ ResultDepthTextureProperty

DynamicPropertyType<Resource> ResultDepthTextureProperty
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.ResultDepthTexture", Resource.class)

The depth texture to which the Composition Target Render Pass renders its content.

◆ ResultTexture0Property

DynamicPropertyType<Resource> ResultTexture0Property
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.ResultTexture0", Resource.class)

The first color texture to which the Composition Target Render Pass renders its content.

◆ ResultTexture1Property

DynamicPropertyType<Resource> ResultTexture1Property
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.ResultTexture1", Resource.class)

The second color texture to which the Composition Target Render Pass renders its content.

◆ ResultTexture2Property

DynamicPropertyType<Resource> ResultTexture2Property
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.ResultTexture2", Resource.class)

The third color texture to which the Composition Target Render Pass renders its content.

◆ ResultTexture3Property

DynamicPropertyType<Resource> ResultTexture3Property
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.ResultTexture3", Resource.class)

The fourth color texture to which the Composition Target Render Pass renders its content.

◆ WidthProperty

DynamicPropertyType<Integer> WidthProperty
Initial value:
=
new DynamicPropertyType<>("CompositionTargetRenderPass.Width", Integer.class)

Sets the absolute width for the automatically created composition target textures.

If this property is not set, the size is taken from the current composition stack state using the values of the Resolution Multiplier and Resolution Divisor properties.