Kanzi  3.9.4
Java API
PipelineStateRenderPass Class Reference

Use a Pipeline State Render Pass to set for its child render passes the depth and stencil testing, transparency, and culling. More...

Inheritance diagram for PipelineStateRenderPass:
[legend]

Static Public Member Functions

static ObjectRef< T > create (Domain domain, String name)
 Constructs a new PipelineStateRenderPass. 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 = com.rightware.kanzi.metadata.ResourceMetadata.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. 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...
 
- 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 PipelineStateRenderPassMetadata
DynamicPropertyType< Integer > BlendModeProperty
 Overrides the blend mode set in each node that this render pass renders. More...
 
DynamicPropertyType< Integer > ColorWriteModeProperty
 Sets which channels the render pass writes to the color buffer. More...
 
DynamicPropertyType< Integer > CullModeProperty
 Sets the culling of the triangle faces in the rendered meshes. More...
 
DynamicPropertyType< Integer > DepthTestFunctionProperty
 Controls whether the depth test discards a fragment. More...
 
DynamicPropertyType< Boolean > DepthWriteEnabledProperty
 Sets whether the render pass writes to the depth buffer. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.PipelineStateRenderPass")
 Metaclass for PipelineStateRenderPass.
 
DynamicPropertyType< Vector2PolygonDepthOffsetProperty
 Sets the polygon depth offset to apply to the element that the Pipeline State Render Pass renders: More...
 
DynamicPropertyType< Integer > ScissorModeProperty
 Sets the scissor test coordinate mode. More...
 
DynamicPropertyType< Vector4ScissorProperty
 Sets the scissor test within the current rendering Viewport node. More...
 
DynamicPropertyType< Integer > StencilFailOperationProperty
 Sets the operation that the render pass performs when the stencil test fails. More...
 
DynamicPropertyType< Integer > StencilMaskProperty
 Sets a mask on which the AND operation is executed with both the reference value and the stored stencil value when the test is done. More...
 
DynamicPropertyType< Integer > StencilPassDepthFailOperationProperty
 Sets the operation that the render pass performs when the stencil test passes, but the depth test fails. More...
 
DynamicPropertyType< Integer > StencilPassDepthPassOperationProperty
 Sets the operation that the render pass performs when both, the stencil and the depth test, pass. More...
 
DynamicPropertyType< Integer > StencilReferenceValueProperty
 Sets the reference value for the stencil test. More...
 
DynamicPropertyType< Integer > StencilTestFunctionProperty
 Controls whether the stencil test discards a fragment. More...
 
DynamicPropertyType< Boolean > StencilWriteEnabledProperty
 Sets whether to enable writing to the stencil buffer. More...
 
DynamicPropertyType< Integer > ViewportModeProperty
 Sets the coordinate type for the Viewport node. More...
 
DynamicPropertyType< Vector4ViewportProperty
 Modifies the current rendering Viewport node. More...
 

Detailed Description

Use a Pipeline State Render Pass to set for its child render passes the depth and stencil testing, transparency, and culling.

Member Function Documentation

◆ create()

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

Constructs a new PipelineStateRenderPass.

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

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static