Kanzi  3.9.6
Java API
LegacyRenderPass Class Reference
Inheritance diagram for LegacyRenderPass:
[legend]

Static Public Member Functions

static ObjectRef< T > create (Domain domain, String name)
 Constructs a new LegacyRenderPass. 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...
 
EnumType getProperty (PropertyType< Integer > propertyType, Class< EnumType > enumClass)
 Returns the current value of an integer property type converted to a matching constant from specified enumeration. 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...
 
void setProperty (PropertyType< Integer > propertyType, EnumType value)
 Sets the local value of an integer property type using a constant from an enumeration. 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 LegacyRenderPassMetadata
DynamicPropertyType< Vector4Color0FloatClearValueProperty
 Clear color value for signed integer color buffer 0. More...
 
DynamicPropertyType< Vector4Color0IntegerClearValueProperty
 Clear color value for integer color buffer 0. More...
 
DynamicPropertyType< ColorRGBAColor1ColorClearValueProperty
 The color used to clear the color buffer 1. More...
 
DynamicPropertyType< Vector4Color1FloatClearValueProperty
 Clear color value for signed integer color buffer 1. More...
 
DynamicPropertyType< Vector4Color1IntegerClearValueProperty
 Clear color value for integer color buffer 1. More...
 
DynamicPropertyType< ColorRGBAColor2ColorClearValueProperty
 The color used to clear the color buffer 2. More...
 
DynamicPropertyType< Vector4Color2FloatClearValueProperty
 Clear color value for signed integer color buffer 2. More...
 
DynamicPropertyType< Vector4Color2IntegerClearValueProperty
 Clear color value for integer color buffer 2. More...
 
DynamicPropertyType< ColorRGBAColor3ColorClearValueProperty
 The color used to clear the color buffer 3. More...
 
DynamicPropertyType< Vector4Color3FloatClearValueProperty
 Clear color value for signed integer color buffer 3. More...
 
DynamicPropertyType< Vector4Color3IntegerClearValueProperty
 Clear color value for integer color buffer 3. More...
 
DynamicPropertyType< ColorRGBAColorBufferClearColorProperty
 The color used to clear the color buffer 0. More...
 
DynamicPropertyType< Boolean > ColorBufferClearEnabledProperty
 Whether to clear the color buffer before writing the new color values. More...
 
DynamicPropertyType< Integer > ColorWriteModeProperty
 When set to None, writing to color buffer is disabled. More...
 
DynamicPropertyType< Boolean > ComposerEnabledProperty
 This determines if composer is rendered (enabled by default). More...
 
DynamicPropertyType< Integer > CullModeProperty
 Sets the culling of the triangle faces in the rendered meshes of legacy render passes: More...
 
DynamicPropertyType< Boolean > DepthBufferClearEnabledProperty
 Sets whether to clear the depth buffer. More...
 
DynamicPropertyType< Float > DepthBufferClearValueProperty
 The value used for clearing the depth buffer. More...
 
DynamicPropertyType< Boolean > DepthBufferTestEnabledProperty
 Whether to enable the depth test. More...
 
DynamicPropertyType< Boolean > DepthBufferWriteEnabledProperty
 Sets whether to enable the writing of the depth buffer. More...
 
DynamicPropertyType< Boolean > FlushAfterRenderProperty
 This determines if GPU pipeline is flushed after rendering of this composer has occurred, to prevent GPU pipeline stall. More...
 
DynamicPropertyType< Boolean > FrustumCullingOnProperty
 Sets whether to use frustum culling. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.LegacyRenderPass")
 Metaclass for LegacyRenderPass.
 
DynamicPropertyType< Boolean > RenderOnceProperty
 Sets whether this render pass is rendered only once. More...
 
DynamicPropertyType< String > RenderPassCameraProperty
 The camera that is used for rendering this render pass. More...
 
DynamicPropertyType< ResourceRenderPassMaterialProperty
 The material that overrides all the materials in the objects that are rendered by this render pass. More...
 
DynamicPropertyType< ResourceRenderPassObjectSourceProperty
 The object source for the render pass. More...
 
DynamicPropertyType< ResourceRenderPassRenderTargetColor0Property
 Sets where this render pass renders. More...
 
DynamicPropertyType< ResourceRenderPassRenderTargetColor1Property
 Sets where this render pass renders. More...
 
DynamicPropertyType< ResourceRenderPassRenderTargetColor2Property
 Sets where this render pass renders. More...
 
DynamicPropertyType< ResourceRenderPassRenderTargetColor3Property
 Sets where this render pass renders. More...
 
DynamicPropertyType< ResourceRenderPassRenderTargetDepthStencilProperty
 Render Target Depth Stencil. More...
 
DynamicPropertyType< Boolean > RenderPassRenderTargetGenerateMipmapProperty
 Sets whether the render target texture generates mipmaps after the render pass. More...
 
DynamicPropertyType< Integer > RenderPassRenderTargetInvalidateAttachmentsProperty
 Which attachments, if any, should be invalidated after the render pass. More...
 
DynamicPropertyType< Integer > RenderPassRenderTargetMipmapLevelProperty
 Render Target Mipmap Level. More...
 
DynamicPropertyType< Boolean > RenderPassRenderTargetResolveProperty
 Sets whether the render target is multisample resolved after the render pass. More...
 
DynamicPropertyType< Boolean > RenderPassScissorEnabledProperty
 Whether scissor area is enabled in render pass or not. More...
 
DynamicPropertyType< Float > RenderPassScissorHeightProperty
 Height of the scissor area. More...
 
DynamicPropertyType< Integer > RenderPassScissorTypeProperty
 Whether the border settings of the scissor area are relative (range 0-1) or absolute (pixel coordinates). More...
 
DynamicPropertyType< Float > RenderPassScissorWidthProperty
 Width of the scissor area. More...
 
DynamicPropertyType< Float > RenderPassScissorXProperty
 X coordinate of the left border of the scissor area. More...
 
DynamicPropertyType< Float > RenderPassScissorYProperty
 Y coordinate of the top border of the scissor area. More...
 
DynamicPropertyType< Boolean > StencilBufferClearEnabledProperty
 Sets whether to clear the stencil buffer. More...
 
DynamicPropertyType< Integer > StencilBufferClearValueProperty
 The value used for clearing the stencil buffer. More...
 
DynamicPropertyType< Boolean > StencilBufferTestEnabledProperty
 Whether or not the stencil test is enabled. More...
 
DynamicPropertyType< Integer > StencilFailOperationProperty
 Operation that is performed when the stencil test fails. More...
 
DynamicPropertyType< Integer > StencilFunctionProperty
 The function used to control whether a fragment is discarded by the stencil test. More...
 
DynamicPropertyType< Integer > StencilFunctionReferenceMaskProperty
 Specifies a mask in legacy render passes that is ANDed with both the reference value and the stored stencil value when the test is done. More...
 
DynamicPropertyType< Integer > StencilFunctionReferenceValueProperty
 Specifies the reference value for the stencil test in legacy render passes. More...
 
DynamicPropertyType< Integer > StencilPassDepthFailOperationProperty
 Operation that is performed when the stencil test fails and the depth test passes. More...
 
DynamicPropertyType< Integer > StencilPassDepthPassOperationProperty
 Operation that is performed when both the stencil and depth test pass. More...
 
DynamicPropertyType< Float > ViewportHeightProperty
 The height of the render area on the render target. More...
 
DynamicPropertyType< Integer > ViewportTypeProperty
 When absolute, the viewport settings are read in pixel coordinates, when relative the settings are read as proportional values from top-left (0,0) corner to bottom-right (1,1) corner. More...
 
DynamicPropertyType< Float > ViewportWidthProperty
 The width of the render area on the render target. More...
 
DynamicPropertyType< Float > ViewportXProperty
 The X coordinate in v to render the render pass on the render target. More...
 
DynamicPropertyType< Float > ViewportYProperty
 The Y coordinate in which to render the render pass on the render target. More...
 

Member Function Documentation

◆ create()

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

Constructs a new LegacyRenderPass.

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

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static