Kanzi  3.9.6
Java API
ClearRenderPass Class Reference

Use a Clear Render Pass to clear the color, depth, and stencil buffers of the current render context. More...

Inheritance diagram for ClearRenderPass:
[legend]

Static Public Member Functions

static ObjectRef< T > create (Domain domain, String name)
 Constructs a new ClearRenderPass. 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 ClearRenderPassMetadata
DynamicPropertyType< ColorRGBAClearColor0Property
 Sets the color that you want the Clear Render Pass to use to clear the first (default) color buffer. More...
 
DynamicPropertyType< ColorRGBAClearColor1Property
 Sets the color that you want the Clear Render Pass to use to clear the second color buffer. More...
 
DynamicPropertyType< ColorRGBAClearColor2Property
 Sets the color that you want the Clear Render Pass to use to clear the third color buffer. More...
 
DynamicPropertyType< ColorRGBAClearColor3Property
 Sets the color that you want the Clear Render Pass to use to clear the fourth color buffer. More...
 
DynamicPropertyType< Float > ClearDepthProperty
 Sets the depth that you want the Clear Render Pass to use to clear the depth buffer. More...
 
DynamicPropertyType< Integer > ClearStencilProperty
 Sets the clear stencil that you want the Clear Render Pass to use to clear the stencil buffer. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ClearRenderPass")
 Metaclass for ClearRenderPass.
 

Detailed Description

Use a Clear Render Pass to clear the color, depth, and stencil buffers of the current render context.

Member Function Documentation

◆ create()

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

Constructs a new ClearRenderPass.

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

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static