Kanzi  3.9.7
Java API
CompositionTargetRenderPass Class Reference

Use a Composition Target Render Pass to render to a composition target. More...

Inheritance diagram for CompositionTargetRenderPass:
[legend]

Static Public Member Functions

static ObjectRef< T > create (Domain domain, String name)
 Constructs a new CompositionTargetRenderPass. More...
 
- Static Public Member Functions inherited from RenderPass
static ObjectRef< T > create (Domain domain, String name)
 Constructs a new RenderPass. More...
 

Static Public Attributes

static final Metaclass metaclass
 The Metaclass for the class. More...
 
- Static Public Attributes inherited from RenderPass
static final Metaclass metaclass
 The Metaclass for the class. More...
 
- Static Public Attributes inherited from Resource
static final Metaclass metaclass
 The Metaclass for the class. More...
 
- 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. More...
 
String getUrl ()
 Gets the resource URL. More...
 
void setKeepAlive (boolean keepAlive)
 Sets the keep alive flag. More...
 
- Public Member Functions inherited from KanziObject
boolean equals (Object object)
 
Domain getDomain ()
 Returns the domain the object belongs to. More...
 
Metaclass getDynamicMetaclass ()
 Returns the metaclass of the dynamic type of the object. More...
 
long getNative ()
 Gets a pointer to the backing C++ instance. More...
 
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. More...
 
TDataType getProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type. More...
 
int hashCode ()
 
boolean hasValue (PropertyType< TDataType > propertyType)
 Evaluates whether there are any inputs into the property value. More...
 
boolean isStale ()
 Test if the object is stale i.e. More...
 
void removeLocalValue (PropertyType< TDataType > propertyType)
 Removes the local value associated with the property. More...
 
void setProperty (PropertyType< TDataType > propertyType, TDataType value)
 Sets the local value of a property type. More...
 
ObjectRef< TType > tryCreateObjectRef (Class< TType > clazz)
 Tries to create an owning ObjectRef instance to this KanziObject. More...
 
- Public Attributes inherited from ResourceMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Resource")
 Metaclass for Resource.
 
- Public Attributes inherited from RenderPassMetadata
DynamicPropertyType< Boolean > EnabledProperty
 Whether Kanzi executes this render pass and its child render pass tree. More...
 
DynamicPropertyType< Vector4InputViewportAreaProperty
 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 CompositionTargetRenderPassMetadata
DynamicPropertyType< SamplerAddressingModeAddressingModeProperty
 Sets how Kanzi handles the texture coordinates of the automatically generated composition target textures outside of the [0, 0] - [1, 1] rectangle: More...
 
DynamicPropertyType< ResourceCompositionTarget0Property
 Sets the first color target to which you want to render the result of the child render passes of this render pass. More...
 
DynamicPropertyType< ResourceCompositionTarget1Property
 Sets the second color target to which you want to render the result of the child render passes of this render pass. More...
 
DynamicPropertyType< ResourceCompositionTarget2Property
 Sets the third color target to which you want to render the result of the child render passes of this render pass. More...
 
DynamicPropertyType< ResourceCompositionTarget3Property
 Sets the fourth color target to which you want to render the result of the child render passes of this render pass. More...
 
DynamicPropertyType< GraphicsCompareFunctionDepthCompareFunctionProperty
 Sets the comparison function to be used with comparison samplers of the Composition Target Render Pass' depth target. More...
 
DynamicPropertyType< GraphicsFormatDepthRenderbufferFormatProperty
 Sets the format of the automatically created depth renderbuffers. More...
 
DynamicPropertyType< ResourceDepthTargetProperty
 Sets the depth target to which you want to render the result of the child render passes of this render pass. More...
 
DynamicPropertyType< GraphicsFormatDepthTextureFormatProperty
 Sets the format of the automatically created Result Depth Texture. More...
 
DynamicPropertyType< SamplerFilterFilterModeProperty
 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< SamplerMipmapModeMipmapModeProperty
 Sets the mipmap mode of the automatically created composition target. More...
 
DynamicPropertyType< MultisampleCountMultisampleLevelProperty
 Sets the amount of multisample anti-aliasing to apply to the automatically generated composition target textures. More...
 
DynamicPropertyType< GraphicsFormatPixelFormat0Property
 Sets on the GPU the target pixel format of the first automatically created composition target texture. More...
 
DynamicPropertyType< GraphicsFormatPixelFormat1Property
 Sets on the GPU the target pixel format of the second automatically created composition target texture. More...
 
DynamicPropertyType< GraphicsFormatPixelFormat2Property
 Sets on the GPU the target pixel format of the third automatically created composition target texture. More...
 
DynamicPropertyType< GraphicsFormatPixelFormat3Property
 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< ResourceResultDepthTextureProperty
 The depth texture to which the Composition Target Render Pass renders its content. More...
 
DynamicPropertyType< ResourceResultTexture0Property
 The first color texture to which the Composition Target Render Pass renders its content. More...
 
DynamicPropertyType< ResourceResultTexture1Property
 The second color texture to which the Composition Target Render Pass renders its content. More...
 
DynamicPropertyType< ResourceResultTexture2Property
 The third color texture to which the Composition Target Render Pass renders its content. More...
 
DynamicPropertyType< ResourceResultTexture3Property
 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...
 

Detailed Description

Use a Composition Target Render Pass to render to a composition target.

Member Function Documentation

static ObjectRef<T> create ( Domain  domain,
String  name 
)
static

Constructs a new CompositionTargetRenderPass.

Parameters
domainUI Domain where this object belongs.
nameName of the object.

Member Data Documentation

final Metaclass metaclass
static