Kanzi  3.9.6
Java API
CubeMapRenderPass Class Reference

Use a Cubemap Render Pass to create a cubemap texture that represents the scene from some location. More...

Inheritance diagram for CubeMapRenderPass:
[legend]

Static Public Member Functions

static ObjectRef< T > create (Domain domain, String name)
 Constructs a new CubeMapRenderPass. 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 CubeMapRenderPassMetadata
DynamicPropertyType< ResourceCompositionTargetProperty
 Sets the target to which you want to render the result of this Cubemap Render Pass. More...
 
DynamicPropertyType< Integer > DepthCompareFunctionProperty
 Sets the comparison function to be used with comparison samplers of the Cubemap Render Pass' depth target. More...
 
DynamicPropertyType< Integer > DepthFormatProperty
 Sets the format of the automatically created depth render buffer used for the cubemap rendering. More...
 
DynamicPropertyType< Integer > FilterModeProperty
 Sets how Kanzi handles accessing the texture samples of the automatically generated composition cubemap target: More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.CubeMapRenderPass")
 Metaclass for CubeMapRenderPass.
 
DynamicPropertyType< Integer > MipmapModeProperty
 Sets the mipmap mode of the automatically created composition cubemap target. More...
 
DynamicPropertyType< String > OverrideCameraProperty
 Sets the Camera node that you want to use to render the nodes to the composition cubemap texture. More...
 
DynamicPropertyType< Integer > PixelFormatProperty
 Sets on the GPU the target pixel format of the automatically created composition cubemap target textures. More...
 
DynamicPropertyType< Integer > ResolutionProperty
 Sets the dimensions of the automatically created composition cubemap target textures. More...
 
DynamicPropertyType< Boolean > ResolveImmediatelyProperty
 Whether to generate mipmaps for the composition target texture immediately after rendering. More...
 
DynamicPropertyType< ResourceResultDepthTextureProperty
 The cubemap depth texture to which the Cubemap Render Pass renders its content. More...
 
DynamicPropertyType< ResourceResultTextureProperty
 The result cubemap texture that was rendered to by the Cubemap Render Pass. More...
 

Detailed Description

Use a Cubemap Render Pass to create a cubemap texture that represents the scene from some location.

You can use the generated cubemap as a cubemap texture. For example, use this approach to create environment maps for a scene.

Member Function Documentation

◆ create()

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

Constructs a new CubeMapRenderPass.

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

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static