Implementation of base Mipmap Generation Concept class for derived classes. More...

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

Inheritance diagram for kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >:

Classes
struct	MipmapRenderData
	Defines the data required when custom mipmap material has been specified. More...

Public Member Functions
MaterialSharedPtr	getColorMipmapMaterial0 () const
	Gets the value of the ColorMipmapMaterial0Property property.

MaterialSharedPtr	getColorMipmapMaterial1 () const
	Gets the value of the ColorMipmapMaterial1Property property.

MaterialSharedPtr	getColorMipmapMaterial2 () const
	Gets the value of the ColorMipmapMaterial2Property property.

MaterialSharedPtr	getColorMipmapMaterial3 () const
	Gets the value of the ColorMipmapMaterial3Property property.

MaterialSharedPtr	getCubemapMipmapMaterial () const
	Gets the value of the CubemapMipmapMaterialProperty property.

float	getCurrentMipmapLevel () const
	Gets the value of the CurrentMipmapLevelProperty property.

MaterialSharedPtr	getDepthMipmapMaterial () const
	Gets the value of the DepthMipmapMaterialProperty property.

TextureSharedPtr	getMipmapSourceTexture () const
	Gets the value of the MipmapSourceTextureProperty property.

void	setColorMipmapMaterial0 (MaterialSharedPtr value)
	Sets the value of the ColorMipmapMaterial0Property property.

void	setColorMipmapMaterial1 (MaterialSharedPtr value)
	Sets the value of the ColorMipmapMaterial1Property property.

void	setColorMipmapMaterial2 (MaterialSharedPtr value)
	Sets the value of the ColorMipmapMaterial2Property property.

void	setColorMipmapMaterial3 (MaterialSharedPtr value)
	Sets the value of the ColorMipmapMaterial3Property property.

void	setCubemapMipmapMaterial (MaterialSharedPtr value)
	Sets the value of the CubemapMipmapMaterialProperty property.

void	setCurrentMipmapLevel (float value)
	Sets the value of the CurrentMipmapLevelProperty property.

void	setDepthMipmapMaterial (MaterialSharedPtr value)
	Sets the value of the DepthMipmapMaterialProperty property.

void	setMipmapSourceTexture (TextureSharedPtr value)
	Sets the value of the MipmapSourceTextureProperty property.

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::MipmapGenerationConcept
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Protected Member Functions
	MipmapGenerationConceptImpl (Domain *domain, string_view name)
	Constructor.

void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Object::onPropertyChanged() implementation.

Protected Attributes
unique_ptr< MipmapRenderData >	m_mipmapRenderData

Additional Inherited Members
Static Public Attributes inherited from kanzi::MipmapGenerationConcept
static PropertyType< ResourceSharedPtr >	ColorMipmapMaterial0Property
	Sets the material to use to generate the mipmaps for the first color result texture (Result Texture 0) of a CompositionTargetRenderPass.

static PropertyType< ResourceSharedPtr >	ColorMipmapMaterial1Property
	Sets the material to use to generate the mipmaps for the second color result texture (Result Texture 1) of a CompositionTargetRenderPass.

static PropertyType< ResourceSharedPtr >	ColorMipmapMaterial2Property
	Sets the material to use to generate the mipmaps for the third color result texture (Result Texture 2) of a CompositionTargetRenderPass.

static PropertyType< ResourceSharedPtr >	ColorMipmapMaterial3Property
	Sets the material to use to generate the mipmaps for the fourth color result texture (Result Texture 3) of a CompositionTargetRenderPass.

static PropertyType< ResourceSharedPtr >	CubemapMipmapMaterialProperty
	Sets the material to use to generate the mipmaps for the Result Texture of a CubeMapRenderPass.

static PropertyType< float >	CurrentMipmapLevelProperty
	Reports the mipmap level that Kanzi is generating.

static PropertyType< ResourceSharedPtr >	DepthMipmapMaterialProperty
	Sets the material to use to generate the mipmaps for the Result Depth Texture of a CompositionTargetRenderPass.

static PropertyType< ResourceSharedPtr >	MipmapSourceTextureProperty
	Reports the texture that contains the render target texture for which Kanzi creates mipmaps.

Detailed Description

template<typename TBaseClass, typename TDerivedClass>
class kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >

Implementation of base Mipmap Generation Concept class for derived classes.

Template Parameters

TBaseClass	Type of the base class, derived from RenderPass.
TDerivedClass	Type of the derived class that holds the Mipmap Generation properties.

Since: Kanzi 3.9.10

Constructor & Destructor Documentation

◆ MipmapGenerationConceptImpl()

template<typename TBaseClass , typename TDerivedClass >

kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::MipmapGenerationConceptImpl	(	Domain *	domain,
		string_view	name )

explicitprotected

Constructor.

Member Function Documentation

◆ makeEditorInfo()

template<typename TBaseClass , typename TDerivedClass >

static PropertyTypeEditorInfoSharedPtr kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::makeEditorInfo ( )

inlinestatic

◆ setCubemapMipmapMaterial()

template<typename TBaseClass , typename TDerivedClass >

void kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::setCubemapMipmapMaterial ( MaterialSharedPtr value )

inline

Sets the value of the CubemapMipmapMaterialProperty property.

Parameters

value The new value of the CubemapMipmapMaterial property.

See also: getCubemapMipmapMaterial()

◆ getCubemapMipmapMaterial()

template<typename TBaseClass , typename TDerivedClass >

MaterialSharedPtr kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::getCubemapMipmapMaterial ( ) const

inline

Gets the value of the CubemapMipmapMaterialProperty property.

Returns: The value of the CubemapMipmapMaterial property.

See also: setCubemapMipmapMaterial()

◆ setColorMipmapMaterial0()

template<typename TBaseClass , typename TDerivedClass >

void kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::setColorMipmapMaterial0 ( MaterialSharedPtr value )

inline

Sets the value of the ColorMipmapMaterial0Property property.

Parameters

value The new value of the ColorMipmapMaterial0 property.

See also: getColorMipmapMaterial0()

◆ getColorMipmapMaterial0()

template<typename TBaseClass , typename TDerivedClass >

MaterialSharedPtr kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::getColorMipmapMaterial0 ( ) const

inline

Gets the value of the ColorMipmapMaterial0Property property.

Returns: The value of the ColorMipmapMaterial0 property.

See also: setColorMipmapMaterial0()

◆ setColorMipmapMaterial1()

template<typename TBaseClass , typename TDerivedClass >

void kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::setColorMipmapMaterial1 ( MaterialSharedPtr value )

inline

Sets the value of the ColorMipmapMaterial1Property property.

Parameters

value The new value of the ColorMipmapMaterial1 property.

See also: getColorMipmapMaterial1()

◆ getColorMipmapMaterial1()

template<typename TBaseClass , typename TDerivedClass >

MaterialSharedPtr kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::getColorMipmapMaterial1 ( ) const

inline

Gets the value of the ColorMipmapMaterial1Property property.

Returns: The value of the ColorMipmapMaterial1 property.

See also: setColorMipmapMaterial1()

◆ setColorMipmapMaterial2()

template<typename TBaseClass , typename TDerivedClass >

void kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::setColorMipmapMaterial2 ( MaterialSharedPtr value )

inline

Sets the value of the ColorMipmapMaterial2Property property.

Parameters

value The new value of the ColorMipmapMaterial2 property.

See also: getColorMipmapMaterial2()

◆ getColorMipmapMaterial2()

template<typename TBaseClass , typename TDerivedClass >

MaterialSharedPtr kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::getColorMipmapMaterial2 ( ) const

inline

Gets the value of the ColorMipmapMaterial2Property property.

Returns: The value of the ColorMipmapMaterial2 property.

See also: setColorMipmapMaterial2()

◆ setColorMipmapMaterial3()

template<typename TBaseClass , typename TDerivedClass >

void kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::setColorMipmapMaterial3 ( MaterialSharedPtr value )

inline

Sets the value of the ColorMipmapMaterial3Property property.

Parameters

value The new value of the ColorMipmapMaterial3 property.

See also: getColorMipmapMaterial3()

◆ getColorMipmapMaterial3()

template<typename TBaseClass , typename TDerivedClass >

MaterialSharedPtr kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::getColorMipmapMaterial3 ( ) const

inline

Gets the value of the ColorMipmapMaterial3Property property.

Returns: The value of the ColorMipmapMaterial3 property.

See also: setColorMipmapMaterial3()

◆ setDepthMipmapMaterial()

template<typename TBaseClass , typename TDerivedClass >

void kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::setDepthMipmapMaterial ( MaterialSharedPtr value )

inline

Sets the value of the DepthMipmapMaterialProperty property.

Parameters

value The new value of the DepthMipmapMaterial property.

See also: getDepthMipmapMaterial()

◆ getDepthMipmapMaterial()

template<typename TBaseClass , typename TDerivedClass >

MaterialSharedPtr kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::getDepthMipmapMaterial ( ) const

inline

Gets the value of the DepthMipmapMaterialProperty property.

Returns: The value of the DepthMipmapMaterial property.

See also: setDepthMipmapMaterial()

◆ setCurrentMipmapLevel()

template<typename TBaseClass , typename TDerivedClass >

void kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::setCurrentMipmapLevel ( float value )

inline

Sets the value of the CurrentMipmapLevelProperty property.

Parameters

value The new value of the CurrentMipmapLevel property.

See also: getCurrentMipmapLevel()

◆ getCurrentMipmapLevel()

template<typename TBaseClass , typename TDerivedClass >

float kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::getCurrentMipmapLevel ( ) const

inline

Gets the value of the CurrentMipmapLevelProperty property.

Returns: The value of the CurrentMipmapLevel property.

See also: setCurrentMipmapLevel()

◆ setMipmapSourceTexture()

template<typename TBaseClass , typename TDerivedClass >

void kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::setMipmapSourceTexture ( TextureSharedPtr value )

inline

Sets the value of the MipmapSourceTextureProperty property.

Parameters

value The new value of the MipmapSourceTexture property.

See also: getMipmapSourceTexture()

◆ getMipmapSourceTexture()

template<typename TBaseClass , typename TDerivedClass >

TextureSharedPtr kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::getMipmapSourceTexture ( ) const

inline

Gets the value of the MipmapSourceTextureProperty property.

Returns: The value of the MipmapTexture property.

◆ onPropertyChanged()

template<typename TBaseClass , typename TDerivedClass >

void kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::onPropertyChanged	(	AbstractPropertyType	propertyType,
		PropertyNotificationReason	reason )

overrideprotected

Object::onPropertyChanged() implementation.

Member Data Documentation

◆ m_mipmapRenderData

template<typename TBaseClass , typename TDerivedClass >

unique_ptr<MipmapRenderData> kanzi::MipmapGenerationConceptImpl< TBaseClass, TDerivedClass >::m_mipmapRenderData

protected

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

kanzi/core.ui/graphics3d/mipmap_generation_concept_impl.hpp
kanzi/core.ui/graphics3d/mipmap_generation_concept_impl_private.hpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MipmapGenerationConceptImpl()

Member Function Documentation

◆ makeEditorInfo()

◆ setCubemapMipmapMaterial()

◆ getCubemapMipmapMaterial()

◆ setColorMipmapMaterial0()

◆ getColorMipmapMaterial0()

◆ setColorMipmapMaterial1()

◆ getColorMipmapMaterial1()

◆ setColorMipmapMaterial2()

◆ getColorMipmapMaterial2()

◆ setColorMipmapMaterial3()

◆ getColorMipmapMaterial3()

◆ setDepthMipmapMaterial()

◆ getDepthMipmapMaterial()

◆ setCurrentMipmapLevel()

◆ getCurrentMipmapLevel()

◆ setMipmapSourceTexture()

◆ getMipmapSourceTexture()

◆ onPropertyChanged()

Member Data Documentation

◆ m_mipmapRenderData