Kanzi 3.9.10
kanzi::MipmapGenerationConcept Class Reference

Use the MipmapGenerationConcept properties to control mipmap generation material of a Render Pass. More...

#include <kanzi/core.ui/graphics3d/mipmap_generation_concept.hpp>

Inheritance diagram for kanzi::MipmapGenerationConcept:
[legend]

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Static Public Attributes

static PropertyType< ResourceSharedPtrColorMipmapMaterial0Property
 Sets the material to use to generate the mipmaps for the first color result texture (Result Texture 0) of a CompositionTargetRenderPass.
 
static PropertyType< ResourceSharedPtrColorMipmapMaterial1Property
 Sets the material to use to generate the mipmaps for the second color result texture (Result Texture 1) of a CompositionTargetRenderPass.
 
static PropertyType< ResourceSharedPtrColorMipmapMaterial2Property
 Sets the material to use to generate the mipmaps for the third color result texture (Result Texture 2) of a CompositionTargetRenderPass.
 
static PropertyType< ResourceSharedPtrColorMipmapMaterial3Property
 Sets the material to use to generate the mipmaps for the fourth color result texture (Result Texture 3) of a CompositionTargetRenderPass.
 
static PropertyType< ResourceSharedPtrCubemapMipmapMaterialProperty
 Sets the material to use to generate the mipmaps for the Result Texture of a CubeMapRenderPass.
 
static PropertyType< floatCurrentMipmapLevelProperty
 Reports the mipmap level that Kanzi is generating.
 
static PropertyType< ResourceSharedPtrDepthMipmapMaterialProperty
 Sets the material to use to generate the mipmaps for the Result Depth Texture of a CompositionTargetRenderPass.
 
static PropertyType< ResourceSharedPtrMipmapSourceTextureProperty
 Reports the texture that contains the render target texture for which Kanzi creates mipmaps.
 

Detailed Description

Use the MipmapGenerationConcept properties to control mipmap generation material of a Render Pass.

Since
Kanzi 3.9.10

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::MipmapGenerationConcept::makeEditorInfo ( )
static

Member Data Documentation

◆ CubemapMipmapMaterialProperty

PropertyType<ResourceSharedPtr> kanzi::MipmapGenerationConcept::CubemapMipmapMaterialProperty
static

Sets the material to use to generate the mipmaps for the Result Texture of a CubeMapRenderPass.

To use the default mipmap generation, remove this property or set its value to ResourceSharedPtr(). The default value is ResourceSharedPtr().

See also
MipmapGenerationConceptImpl::setCubemapMipmapMaterial(), MipmapGenerationConceptImpl::getCubemapMipmapMaterial(), CubeMapRenderPass::ResultTextureProperty

◆ ColorMipmapMaterial0Property

PropertyType<ResourceSharedPtr> kanzi::MipmapGenerationConcept::ColorMipmapMaterial0Property
static

Sets the material to use to generate the mipmaps for the first color result texture (Result Texture 0) of a CompositionTargetRenderPass.

To use the default mipmap generation, remove this property or set its value to ResourceSharedPtr(). The default value is ResourceSharedPtr().

See also
MipmapGenerationConceptImpl::setColorMipmapMaterial0(), MipmapGenerationConceptImpl::getColorMipmapMaterial0(), CompositionTargetRenderPass::ResultTexture0Property

◆ ColorMipmapMaterial1Property

PropertyType<ResourceSharedPtr> kanzi::MipmapGenerationConcept::ColorMipmapMaterial1Property
static

Sets the material to use to generate the mipmaps for the second color result texture (Result Texture 1) of a CompositionTargetRenderPass.

To use the default mipmap generation, remove this property or set its value to ResourceSharedPtr(). The default value is ResourceSharedPtr().

See also
MipmapGenerationConceptImpl::setColorMipmapMaterial1(), MipmapGenerationConceptImpl::getColorMipmapMaterial1(), CompositionTargetRenderPass::ResultTexture1Property

◆ ColorMipmapMaterial2Property

PropertyType<ResourceSharedPtr> kanzi::MipmapGenerationConcept::ColorMipmapMaterial2Property
static

Sets the material to use to generate the mipmaps for the third color result texture (Result Texture 2) of a CompositionTargetRenderPass.

To use the default mipmap generation, remove this property or set its value to ResourceSharedPtr(). The default value is ResourceSharedPtr().

See also
MipmapGenerationConceptImpl::setColorMipmapMaterial2(), MipmapGenerationConceptImpl::getColorMipmapMaterial2(), CompositionTargetRenderPass::ResultTexture2Property

◆ ColorMipmapMaterial3Property

PropertyType<ResourceSharedPtr> kanzi::MipmapGenerationConcept::ColorMipmapMaterial3Property
static

Sets the material to use to generate the mipmaps for the fourth color result texture (Result Texture 3) of a CompositionTargetRenderPass.

To use the default mipmap generation, remove this property or set its value to ResourceSharedPtr(). The default value is ResourceSharedPtr().

See also
MipmapGenerationConceptImpl::setColorMipmapMaterial3(), MipmapGenerationConceptImpl::getColorMipmapMaterial3(), CompositionTargetRenderPass::ResultTexture3Property

◆ DepthMipmapMaterialProperty

PropertyType<ResourceSharedPtr> kanzi::MipmapGenerationConcept::DepthMipmapMaterialProperty
static

Sets the material to use to generate the mipmaps for the Result Depth Texture of a CompositionTargetRenderPass.

To use the default mipmap generation, remove this property or set its value to ResourceSharedPtr(). The default value is ResourceSharedPtr().

See also
MipmapGenerationConceptImpl::setDepthMipmapMaterial(), MipmapGenerationConceptImpl::getDepthMipmapMaterial(), CompositionTargetRenderPass::ResultDepthTextureProperty

◆ CurrentMipmapLevelProperty

PropertyType<float> kanzi::MipmapGenerationConcept::CurrentMipmapLevelProperty
static

Reports the mipmap level that Kanzi is generating.

Use this property in a material that you use to customize how Kanzi generates mipmaps for the composition targets of a CompositionTargetRenderPass or CubeMapRenderPass. The value of this property is valid only while Kanzi generates the mipmaps. The default value is 0.

See also
MipmapGenerationConceptImpl::setCurrentMipmapLevel(), MipmapGenerationConceptImpl::getCurrentMipmapLevel()

◆ MipmapSourceTextureProperty

PropertyType<ResourceSharedPtr> kanzi::MipmapGenerationConcept::MipmapSourceTextureProperty
static

Reports the texture that contains the render target texture for which Kanzi creates mipmaps.

Use this property as the input texture in a material that you use to customize how Kanzi generates mipmaps for the composition targets of a CompositionTargetRenderPass or CubeMapRenderPass. The default value is ResourceSharedPtr().

See also
MipmapGenerationConceptImpl::setMipmapSourceTexture(), MipmapGenerationConceptImpl::getMipmapSourceTexture()

The documentation for this class was generated from the following file: