Class CompositionTargetRenderPassMetadata

Defines properties and message types for CompositionTargetRenderPass.

Inherits properties and message types from RenderPassMetadata.

Property Types

See also PropertyType
CompositionTargetRenderPassMetadata.CompositionTarget0Property

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

CompositionTargetRenderPassMetadata.CompositionTarget1Property

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

CompositionTargetRenderPassMetadata.CompositionTarget2Property

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

CompositionTargetRenderPassMetadata.CompositionTarget3Property

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

CompositionTargetRenderPassMetadata.DepthTargetProperty

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

CompositionTargetRenderPassMetadata.ResultTexture0Property

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

CompositionTargetRenderPassMetadata.ResultTexture1Property

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

CompositionTargetRenderPassMetadata.ResultTexture2Property

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

CompositionTargetRenderPassMetadata.ResultTexture3Property

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

CompositionTargetRenderPassMetadata.ResultDepthTextureProperty

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

CompositionTargetRenderPassMetadata.ResolutionMultiplierProperty

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.

CompositionTargetRenderPassMetadata.ResolutionDivisorProperty

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.

CompositionTargetRenderPassMetadata.WidthProperty

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.

CompositionTargetRenderPassMetadata.HeightProperty

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.

CompositionTargetRenderPassMetadata.PixelFormat0Property

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

CompositionTargetRenderPassMetadata.PixelFormat1Property

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

CompositionTargetRenderPassMetadata.PixelFormat2Property

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

CompositionTargetRenderPassMetadata.PixelFormat3Property

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

CompositionTargetRenderPassMetadata.DepthTextureFormatProperty

Sets the format of the automatically created Result Depth Texture.

CompositionTargetRenderPassMetadata.DepthRenderbufferFormatProperty

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.

CompositionTargetRenderPassMetadata.DepthCompareFunctionProperty

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

CompositionTargetRenderPassMetadata.AddressingModeProperty

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.
CompositionTargetRenderPassMetadata.FilterModeProperty

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.
CompositionTargetRenderPassMetadata.MipmapModeProperty

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.

CompositionTargetRenderPassMetadata.MultisampleLevelProperty

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

CompositionTargetRenderPassMetadata.ResolveImmediatelyProperty

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.

Message Types

See also MessageType

Message Arguments

Message arguments classes define message arguments used for different message types. Each class defines a number of property types - arguments - together with getter and setter functions for them.