CompositionTargetRenderPass Class Reference
Use the Composition Target Render Pass to set one to four composition targets and render all descendant render passes to the composition targets that the Composition Target Render Pass created. More...
Inheritance diagram for CompositionTargetRenderPass:
Static Public Member Functions | |
| static< T extends KanziObject > ObjectRef< T > | create (Domain domain, String name) |
| Creates a Composition Target Render Pass. | |
Static Public Attributes | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
 Static Public Attributes inherited from RenderPass | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
| Static Public Attributes inherited from GPUResource | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
| Static Public Attributes inherited from Resource | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
| Static Public Attributes inherited from KanziObject | |
| static final Metaclass | metaclass = new AbstractMetaclass("Kanzi.Object") |
| The Metaclass for the class. | |
Additional Inherited Members | |
| Public Member Functions inherited from Resource | |
| String | getName () |
| Gets the resource name. | |
| String | getUrl () |
| Gets the resource URL. | |
| void | setKeepAlive (boolean keepAlive) |
| Sets the keep alive flag. | |
| Public Member Functions inherited from KanziObject | |
| boolean | equals (Object object) |
| Domain | getDomain () |
| Returns the domain the object belongs to. | |
| Metaclass | getDynamicMetaclass () |
| Returns the metaclass of the dynamic type of the object. | |
| long | getNative () |
| Gets a pointer to the backing C++ instance. | |
| TDataType | getOptionalProperty (PropertyType< TDataType > propertyType) |
| Returns the current value of a property type, but does not use the default value if there are no inputs to the property value. | |
| TDataType | getProperty (PropertyType< TDataType > propertyType) |
| Returns the current value of a property type. | |
| int | hashCode () |
| boolean | hasValue (PropertyType< TDataType > propertyType) |
| Evaluates whether there are any inputs into the property value. | |
| boolean | isStale () |
| Test if the object is stale i.e. | |
| void | removeLocalValue (PropertyType< TDataType > propertyType) |
| Removes the local value associated with the property. | |
| void | setProperty (PropertyType< TDataType > propertyType, TDataType value) |
| Sets the local value of a property type. | |
| ObjectRef< TType > | tryCreateObjectRef (Class< TType > clazz) |
| Tries to create an owning ObjectRef instance to this KanziObject. | |
| Public Attributes inherited from ResourceMetadata | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Resource") |
| Metaclass for Resource. | |
| Public Attributes inherited from GPUResourceMetadata | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.GPUResource") |
| Metaclass for GPUResource. | |
| 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 CompositionTargetRenderPassMetadata | |
| 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 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
Use the Composition Target Render Pass to set one to four composition targets and render all descendant render passes to the composition targets that the Composition Target Render Pass created.
If you set multiple composition targets, rendering can write to all specified buffers at the same time. See Using multiple composition targets. After Kanzi renders the descendant render passes of a Composition Target Render Pass, the Composition Target Render Pass restores the earlier composition settings.
Member Function Documentation
◆ create()
|
static |
Creates a Composition Target Render Pass.
- Parameters
-
domain The domain to use. name The name of the Composition Target Render Pass.
- Returns
- The created Composition Target Render Pass.
Reimplemented from RenderPass.