CompositionTargetRenderPassMetadata Interface Reference

Metadata definitions for CompositionTargetRenderPass. More...

Inheritance diagram for CompositionTargetRenderPassMetadata:

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

Member Data Documentation

AddressingModeProperty

DynamicPropertyType<Integer> AddressingModeProperty

Initial value:

=
        new DynamicPropertyType<>("CompositionTargetRenderPass.AddressingMode", Integer.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<Integer> DepthCompareFunctionProperty

Initial value:

= new DynamicPropertyType<>(
        "CompositionTargetRenderPass.DepthCompareFunction", Integer.class)

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

DepthRenderbufferFormatProperty

DynamicPropertyType<Integer> DepthRenderbufferFormatProperty

Initial value:

= new DynamicPropertyType<>(
        "CompositionTargetRenderPass.DepthRenderbufferFormat", Integer.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. The value of the Depth Texture Format property 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<Integer> DepthTextureFormatProperty

Initial value:

=
        new DynamicPropertyType<>("CompositionTargetRenderPass.DepthTextureFormat", Integer.class)

Sets the format of the automatically created Result Depth Texture.

FilterModeProperty

DynamicPropertyType<Integer> FilterModeProperty

Initial value:

=
        new DynamicPropertyType<>("CompositionTargetRenderPass.FilterMode", Integer.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<Integer> MipmapModeProperty

Initial value:

=
        new DynamicPropertyType<>("CompositionTargetRenderPass.MipmapMode", Integer.class)

Sets the mipmap mode of the automatically created composition 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.

MultisampleLevelProperty

DynamicPropertyType<Integer> MultisampleLevelProperty

Initial value:

=
        new DynamicPropertyType<>("CompositionTargetRenderPass.MultisampleLevel", Integer.class)

Sets the number of samples you want to use for each output pixel of the automatically generated composition target textures.

To disable multisampling, remove the property or set the property value to 1.

PixelFormat0Property

DynamicPropertyType<Integer> PixelFormat0Property

Initial value:

=
        new DynamicPropertyType<>("CompositionTargetRenderPass.PixelFormat0", Integer.class)

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

PixelFormat1Property

DynamicPropertyType<Integer> PixelFormat1Property

Initial value:

=
        new DynamicPropertyType<>("CompositionTargetRenderPass.PixelFormat1", Integer.class)

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

PixelFormat2Property

DynamicPropertyType<Integer> PixelFormat2Property

Initial value:

=
        new DynamicPropertyType<>("CompositionTargetRenderPass.PixelFormat2", Integer.class)

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

PixelFormat3Property

DynamicPropertyType<Integer> PixelFormat3Property

Initial value:

=
        new DynamicPropertyType<>("CompositionTargetRenderPass.PixelFormat3", Integer.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 InputViewport property to 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 InputViewport property to 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.