Class CubeMapRenderPassMetadata

Defines properties and message types for CubeMapRenderPass.

Inherits properties and message types from RenderPassMetadata.

Property Types

See also PropertyType
CubeMapRenderPassMetadata.CompositionTargetProperty

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

CubeMapRenderPassMetadata.ResultTextureProperty

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

CubeMapRenderPassMetadata.DepthTargetProperty

Sets the target for depth rendering for this Cubemap Render Pass.

CubeMapRenderPassMetadata.ResultDepthTextureProperty

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

CubeMapRenderPassMetadata.ResolutionProperty

Sets the dimensions of the automatically created composition cubemap target textures. The default value is 64.

CubeMapRenderPassMetadata.PixelFormatProperty

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

CubeMapRenderPassMetadata.DepthFormatProperty

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.

CubeMapRenderPassMetadata.DepthCompareFunctionProperty

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

CubeMapRenderPassMetadata.FilterModeProperty

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

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.

CubeMapRenderPassMetadata.ResolveImmediatelyProperty

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.

CubeMapRenderPassMetadata.OverrideCameraProperty

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.

CubeMapRenderPassMetadata.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. The default value is 6.

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.