CubeMapRenderPass Class Reference
Use the Cubemap Render Pass to create a cubemap texture that represents the scene from some location. More...
Inheritance diagram for CubeMapRenderPass:
Static Public Member Functions | |
| static< T extends KanziObject > ObjectRef< T > | create (Domain domain, String name) |
| Create function. | |
Static Public Attributes | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
 Static Public Attributes inherited from RenderPass | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
| Static Public Attributes inherited from GPUResource | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
| Static Public Attributes inherited from Resource | |
| static final Metaclass | 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. | |
| String | getUrl () |
| Gets the resource URL. | |
| void | setKeepAlive (boolean keepAlive) |
| Sets the keep alive flag. | |
| Public Member Functions inherited from KanziObject | |
| boolean | equals (Object object) |
| Domain | getDomain () |
| Returns the domain the object belongs to. | |
| Metaclass | getDynamicMetaclass () |
| Returns the metaclass of the dynamic type of the object. | |
| long | getNative () |
| Gets a pointer to the backing C++ instance. | |
| 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. | |
| TDataType | getProperty (PropertyType< TDataType > propertyType) |
| Returns the current value of a property type. | |
| int | hashCode () |
| boolean | hasValue (PropertyType< TDataType > propertyType) |
| Evaluates whether there are any inputs into the property value. | |
| boolean | isStale () |
| Test if the object is stale i.e. | |
| void | removeLocalValue (PropertyType< TDataType > propertyType) |
| Removes the local value associated with the property. | |
| void | setFlagKeepDuringPatching (PropertyType< TDataType > propertyType) |
| Sets the flag to indicate that the property was loaded from KZB. | |
| void | setProperty (PropertyType< TDataType > propertyType, TDataType value) |
| Sets the local value of a property type. | |
| ObjectRef< TType > | tryCreateObjectRef (Class< TType > clazz) |
| Tries to create an owning ObjectRef instance to this KanziObject. | |
| Public Attributes inherited from ResourceMetadata | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Resource") |
| Metaclass for Resource. | |
| Public Attributes inherited from GPUResourceMetadata | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.GPUResource") |
| Metaclass for GPUResource. | |
| Public Attributes inherited from RenderPassMetadata | |
| DynamicPropertyType< Boolean > | EnabledProperty |
| Whether Kanzi executes this render pass and its child render pass tree. | |
| DynamicPropertyType< Vector4 > | InputViewportAreaProperty |
| Reports the viewport area relative to the composition space as passed from the parent render pass. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.RenderPass") |
| Metaclass for RenderPass. | |
| DynamicPropertyType< Integer > | UpdateOffsetProperty |
| Sets a frame offset to the rendering rate that you set with the Update Rate property. | |
| DynamicPropertyType< Integer > | UpdateRateProperty |
| Sets the rate at which to render the Render Pass. | |
| Public Attributes inherited from CubeMapRenderPassMetadata | |
| DynamicPropertyType< Resource > | CompositionTargetProperty |
| Sets the target to which you want to render the result of this Cubemap Render Pass. | |
| DynamicPropertyType< GraphicsCompareFunction > | DepthCompareFunctionProperty |
| Sets the comparison function to be used with comparison samplers of the Cubemap Render Pass' depth target. | |
| DynamicPropertyType< GraphicsFormat > | DepthFormatProperty |
| Sets the format of the automatically created depth render buffer used for the cubemap rendering. | |
| DynamicPropertyType< Resource > | DepthTargetProperty |
| Sets the target for depth rendering for this Cubemap Render Pass. | |
| DynamicPropertyType< Integer > | FaceUpdateRateProperty |
| Sets the number of cubemap faces to update each frame or at the rate that you set with the Render Pass > Update Rate property. | |
| DynamicPropertyType< SamplerFilter > | FilterModeProperty |
| Sets how Kanzi handles accessing the texture samples of the automatically generated composition cubemap target: | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.CubeMapRenderPass") |
| Metaclass for CubeMapRenderPass. | |
| DynamicPropertyType< SamplerMipmapMode > | MipmapModeProperty |
| Sets the mipmap mode of the automatically created composition cubemap target. | |
| DynamicPropertyType< String > | OverrideCameraProperty |
| Sets the Camera node that you want to use to render the nodes to the composition cubemap texture. | |
| DynamicPropertyType< GraphicsFormat > | PixelFormatProperty |
| Sets on the GPU the target pixel format of the automatically created composition cubemap target textures. | |
| DynamicPropertyType< Integer > | ResolutionProperty |
| Sets the dimensions of the automatically created composition cubemap target textures. | |
| DynamicPropertyType< Boolean > | ResolveImmediatelyProperty |
| Whether to generate mipmaps for the composition target texture immediately after rendering. | |
| DynamicPropertyType< Resource > | ResultDepthTextureProperty |
| The cubemap depth texture to which the Cubemap Render Pass renders its content. | |
| DynamicPropertyType< Resource > | ResultTextureProperty |
| The result cubemap texture that was rendered to by the Cubemap Render Pass. | |
| Public Attributes inherited from MipmapGenerationConceptMetadata | |
| DynamicPropertyType< Resource > | ColorMipmapMaterial0Property |
| Sets the material to use to generate the mipmaps for the first color result texture (Result Texture 0) of a Composition Target Render Pass. | |
| DynamicPropertyType< Resource > | ColorMipmapMaterial1Property |
| Sets the material to use to generate the mipmaps for the second color result texture (Result Texture 1) of a Composition Target Render Pass. | |
| DynamicPropertyType< Resource > | ColorMipmapMaterial2Property |
| Sets the material to use to generate the mipmaps for the third color result texture (Result Texture 2) of a Composition Target Render Pass. | |
| DynamicPropertyType< Resource > | ColorMipmapMaterial3Property |
| Sets the material to use to generate the mipmaps for the fourth color result texture (Result Texture 3) of a Composition Target Render Pass. | |
| DynamicPropertyType< Resource > | CubemapMipmapMaterialProperty |
| Sets the material to use to generate the mipmaps for the color Result Texture of a Cubemap Render Pass. | |
| DynamicPropertyType< Float > | CurrentMipmapLevelProperty |
| Reports the mipmap level that Kanzi is generating. | |
| DynamicPropertyType< Resource > | DepthMipmapMaterialProperty |
| Sets the material to use to generate the mipmaps for the Result Depth Texture of a Composition Target Render Pass. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.MipmapGenerationConcept") |
| Metaclass for MipmapGenerationConcept. | |
| DynamicPropertyType< Resource > | MipmapSourceTextureProperty |
| Reports the texture that contains the render target texture for which Kanzi creates mipmaps. | |
Detailed Description
Use the Cubemap Render Pass to create a cubemap texture that represents the scene from some location.
You can use the result of the Cubemap Render Pass as a cubemap texture. For example, use the Cubemap Render Pass to create dynamic reflections of the environment on the surface of 3D nodes.
Member Function Documentation
◆ create()
|
static |
Create function.
Reimplemented from RenderPass.