Contains property types of Standard post-process materials. More...

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

Static Public Member Functions
static float	getBloomIntensity (const Object &object)
	Gets the value of the BloomIntensityProperty of an object.

static ResourceSharedPtr	getBloomIntensityTexture (const Object &object)
	Gets the value of the BloomIntensityTextureProperty of an object.

static float	getBloomRadius (const Object &object)
	Gets the value of the BloomRadiusProperty of an object.

static bool	getBloomUseIntensityTextureProperty (const Object &object)
	Gets the value of the BloomUseIntensityTextureProperty of an object.

static Vector2	getBlurDirection (const Object &object)
	Gets the value of the BlurDirectionProperty of an object.

static float	getBlurRadius (const Object &object)
	Gets the value of the BlurRadiusProperty of an object.

static float	getTonemapA (const Object &object)
	Gets the value of the TonemapAProperty of an object.

static float	getTonemapB (const Object &object)
	Gets the value of the TonemapBProperty of an object.

static float	getTonemapC (const Object &object)
	Gets the value of the TonemapCProperty of an object.

static float	getTonemapD (const Object &object)
	Gets the value of the TonemapDProperty of an object.

static float	getTonemapE (const Object &object)
	Gets the value of the TonemapEProperty of an object.

static float	getTonemapF (const Object &object)
	Gets the value of the TonemapFProperty of an object.

static float	getTonemapWhiteScale (const Object &object)
	Gets the value of the TonemapWhiteScaleProperty of an object.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static void	setBloomIntensity (Object &object, float value)
	Sets the value of the BloomIntensityProperty of an object.

static void	setBloomIntensityTexture (Object &object, ResourceSharedPtr value)
	Sets the value of the BloomIntensityTextureProperty of an object.

static void	setBloomRadius (Object &object, float value)
	Sets the value of the BloomRadiusProperty of an object.

static void	setBloomUseIntensityTextureProperty (Object &object, bool value)
	Sets the value of the BloomUseIntensityTextureProperty of an object.

static void	setBlurDirection (Object &object, Vector2 value)
	Sets the value of the BlurDirectionProperty of an object.

static void	setBlurRadius (Object &object, float value)
	Sets the value of the BlurRadiusProperty of an object.

static void	setTonemapA (Object &object, float value)
	Sets the value of the TonemapAProperty of an object.

static void	setTonemapB (Object &object, float value)
	Sets the value of the TonemapBProperty of an object.

static void	setTonemapC (Object &object, float value)
	Sets the value of the TonemapCProperty of an object.

static void	setTonemapD (Object &object, float value)
	Sets the value of the TonemapDProperty of an object.

static void	setTonemapE (Object &object, float value)
	Sets the value of the TonemapEProperty of an object.

static void	setTonemapF (Object &object, float value)
	Sets the value of the TonemapFProperty of an object.

static void	setTonemapWhiteScale (Object &object, float value)
	Sets the value of the TonemapWhiteScaleProperty of an object.

Static Public Attributes
static PropertyType< float >	BloomIntensityProperty
	Determines the bloom Intensity.

static PropertyType< ResourceSharedPtr >	BloomIntensityTextureProperty
	Determines the bloom radius texture.

static PropertyType< float >	BloomRadiusProperty
	Determines the bloom radius.

static PropertyType< bool >	BloomUseIntensityTextureProperty
	Determines if the bloom Intensity texture is used or not.

static PropertyType< Vector2 >	BlurDirectionProperty
	Determines the blur direction.

static PropertyType< float >	BlurRadiusProperty
	Determines the blur radius.

static PropertyType< float >	TonemapAProperty
	Tonemap function parameter A.

static PropertyType< float >	TonemapBProperty
	Tonemap function parameter B.

static PropertyType< float >	TonemapCProperty
	Tonemap function parameter C.

static PropertyType< float >	TonemapDProperty
	Tonemap function parameter D.

static PropertyType< float >	TonemapEProperty
	Tonemap function parameter E.

static PropertyType< float >	TonemapFProperty
	Tonemap function parameter F.

static PropertyType< float >	TonemapWhiteScaleProperty
	Tonemap function parameter Wwhite scale.

Detailed Description

Contains property types of Standard post-process materials.

Since: Kanzi 4.0.0

Member Function Documentation

◆ getBlurRadius()

static float kanzi::StandardPostProcessMaterial::getBlurRadius ( const Object & object )

inlinestatic

Gets the value of the BlurRadiusProperty of an object.

Parameters

object The object from which to get the value of the BlurRadiusProperty.

Returns: Returns the value of the BlurRadiusProperty.

◆ setBlurRadius()

static void kanzi::StandardPostProcessMaterial::setBlurRadius	(	Object &	object,
		float	value )

inlinestatic

Sets the value of the BlurRadiusProperty of an object.

Parameters

object	The object on which to set the BlurRadiusProperty.
value	The value to which to set the BlurRadiusProperty.

◆ getBlurDirection()

static Vector2 kanzi::StandardPostProcessMaterial::getBlurDirection ( const Object & object )

inlinestatic

Gets the value of the BlurDirectionProperty of an object.

Parameters

object The object from which to get the value of the BlurDirectionProperty.

Returns: Returns the value of the BlurDirectionProperty.

◆ setBlurDirection()

static void kanzi::StandardPostProcessMaterial::setBlurDirection	(	Object &	object,
		Vector2	value )

inlinestatic

Sets the value of the BlurDirectionProperty of an object.

Parameters

object	The object on which to set the BlurDirectionProperty.
value	The value to which to set the BlurDirectionProperty.

◆ getBloomRadius()

static float kanzi::StandardPostProcessMaterial::getBloomRadius ( const Object & object )

inlinestatic

Gets the value of the BloomRadiusProperty of an object.

Parameters

object The object from which to get the value of the BloomRadiusProperty.

Returns: Returns the value of the BloomRadiusProperty.

◆ setBloomRadius()

static void kanzi::StandardPostProcessMaterial::setBloomRadius	(	Object &	object,
		float	value )

inlinestatic

Sets the value of the BloomRadiusProperty of an object.

Parameters

object	The object on which to set the BloomRadiusProperty.
value	The value to which to set the BloomRadiusProperty.

◆ getBloomIntensity()

static float kanzi::StandardPostProcessMaterial::getBloomIntensity ( const Object & object )

inlinestatic

Gets the value of the BloomIntensityProperty of an object.

Parameters

object The object from which to get the value of the BloomIntensityProperty.

Returns: Returns the value of the BloomIntensityProperty.

◆ setBloomIntensity()

static void kanzi::StandardPostProcessMaterial::setBloomIntensity	(	Object &	object,
		float	value )

inlinestatic

Sets the value of the BloomIntensityProperty of an object.

Parameters

object	The object on which to set the BloomIntensityProperty.
value	The value to which to set the BloomIntensityProperty.

◆ getBloomUseIntensityTextureProperty()

static bool kanzi::StandardPostProcessMaterial::getBloomUseIntensityTextureProperty ( const Object & object )

inlinestatic

Gets the value of the BloomUseIntensityTextureProperty of an object.

Parameters

object The object from which to get the value of the BloomUseIntensityTextureProperty.

Returns: Returns the value of the BloomUseIntensityTextureProperty.

◆ setBloomUseIntensityTextureProperty()

static void kanzi::StandardPostProcessMaterial::setBloomUseIntensityTextureProperty	(	Object &	object,
		bool	value )

inlinestatic

Sets the value of the BloomUseIntensityTextureProperty of an object.

Parameters

object	The object on which to set the BloomUseIntensityTextureProperty.
value	The value to which to set the BloomUseIntensityTextureProperty.

◆ getBloomIntensityTexture()

static ResourceSharedPtr kanzi::StandardPostProcessMaterial::getBloomIntensityTexture ( const Object & object )

inlinestatic

Gets the value of the BloomIntensityTextureProperty of an object.

Parameters

object The object from which to get the value of the BloomIntensityTextureProperty.

Returns: Returns the value of the BloomIntensityTextureProperty.

◆ setBloomIntensityTexture()

static void kanzi::StandardPostProcessMaterial::setBloomIntensityTexture	(	Object &	object,
		ResourceSharedPtr	value )

inlinestatic

Sets the value of the BloomIntensityTextureProperty of an object.

Parameters

object	The object on which to set the BloomIntensityTextureProperty.
value	The value to which to set the BloomIntensityTextureProperty.

◆ getTonemapA()

static float kanzi::StandardPostProcessMaterial::getTonemapA ( const Object & object )

inlinestatic

Gets the value of the TonemapAProperty of an object.

Parameters

object The object from which to get the value of the TonemapAProperty.

Returns: Returns the value of the TonemapAProperty.

◆ setTonemapA()

static void kanzi::StandardPostProcessMaterial::setTonemapA	(	Object &	object,
		float	value )

inlinestatic

Sets the value of the TonemapAProperty of an object.

Parameters

object	The object on which to set the TonemapAProperty.
value	The value to which to set the TonemapAProperty.

◆ getTonemapB()

static float kanzi::StandardPostProcessMaterial::getTonemapB ( const Object & object )

inlinestatic

Gets the value of the TonemapBProperty of an object.

Parameters

object The object from which to get the value of the TonemapBProperty.

Returns: Returns the value of the TonemapBProperty.

◆ setTonemapB()

static void kanzi::StandardPostProcessMaterial::setTonemapB	(	Object &	object,
		float	value )

inlinestatic

Sets the value of the TonemapBProperty of an object.

Parameters

object	The object on which to set the TonemapBProperty.
value	The value to which to set the TonemapBProperty.

◆ getTonemapC()

static float kanzi::StandardPostProcessMaterial::getTonemapC ( const Object & object )

inlinestatic

Gets the value of the TonemapCProperty of an object.

Parameters

object The object from which to get the value of the TonemapCProperty.

Returns: Returns the value of the TonemapCProperty.

◆ setTonemapC()

static void kanzi::StandardPostProcessMaterial::setTonemapC	(	Object &	object,
		float	value )

inlinestatic

Sets the value of the TonemapCProperty of an object.

Parameters

object	The object on which to set the TonemapCProperty.
value	The value to which to set the TonemapCProperty.

◆ getTonemapD()

static float kanzi::StandardPostProcessMaterial::getTonemapD ( const Object & object )

inlinestatic

Gets the value of the TonemapDProperty of an object.

Parameters

object The object from which to get the value of the TonemapDProperty.

Returns: Returns the value of the TonemapDProperty.

◆ setTonemapD()

static void kanzi::StandardPostProcessMaterial::setTonemapD	(	Object &	object,
		float	value )

inlinestatic

Sets the value of the TonemapDProperty of an object.

Parameters

object	The object on which to set the TonemapDProperty.
value	The value to which to set the TonemapDProperty.

◆ getTonemapE()

static float kanzi::StandardPostProcessMaterial::getTonemapE ( const Object & object )

inlinestatic

Gets the value of the TonemapEProperty of an object.

Parameters

object The object from which to get the value of the TonemapEProperty.

Returns: Returns the value of the TonemapEProperty.

◆ setTonemapE()

static void kanzi::StandardPostProcessMaterial::setTonemapE	(	Object &	object,
		float	value )

inlinestatic

Sets the value of the TonemapEProperty of an object.

Parameters

object	The object on which to set the TonemapEProperty.
value	The value to which to set the TonemapEProperty.

◆ getTonemapF()

static float kanzi::StandardPostProcessMaterial::getTonemapF ( const Object & object )

inlinestatic

Gets the value of the TonemapFProperty of an object.

Parameters

object The object from which to get the value of the TonemapFProperty.

Returns: Returns the value of the TonemapFProperty.

◆ setTonemapF()

static void kanzi::StandardPostProcessMaterial::setTonemapF	(	Object &	object,
		float	value )

inlinestatic

Sets the value of the TonemapFProperty of an object.

Parameters

object	The object on which to set the TonemapFProperty.
value	The value to which to set the TonemapFProperty.

◆ getTonemapWhiteScale()

static float kanzi::StandardPostProcessMaterial::getTonemapWhiteScale ( const Object & object )

inlinestatic

Gets the value of the TonemapWhiteScaleProperty of an object.

Parameters

object The object from which to get the value of the TonemapWhiteScaleProperty.

Returns: Returns the value of the TonemapWhiteScaleProperty.

◆ setTonemapWhiteScale()

static void kanzi::StandardPostProcessMaterial::setTonemapWhiteScale	(	Object &	object,
		float	value )

inlinestatic

Sets the value of the TonemapWhiteScaleProperty of an object.

Parameters

object	The object on which to set the TonemapWhiteScaleProperty.
value	The value to which to set the TonemapWhiteScaleProperty.

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::StandardPostProcessMaterial::makeEditorInfo ( )

static

Member Data Documentation

◆ BlurRadiusProperty

PropertyType<float> kanzi::StandardPostProcessMaterial::BlurRadiusProperty

static

Determines the blur radius.

The default value is 1.0f.

See also: setBlurRadius(), getBlurRadius()

◆ BlurDirectionProperty

PropertyType<Vector2> kanzi::StandardPostProcessMaterial::BlurDirectionProperty

static

Determines the blur direction.

The default value is { 1.0, 0.0 }

See also: setBlurDirection(), getBlurDirection()

◆ BloomRadiusProperty

PropertyType<float> kanzi::StandardPostProcessMaterial::BloomRadiusProperty

static

Determines the bloom radius.

The default value is 1.0f.

See also: setBloomRadius(), getBloomRadius()

◆ BloomIntensityProperty

PropertyType<float> kanzi::StandardPostProcessMaterial::BloomIntensityProperty

static

Determines the bloom Intensity.

The default value is 1.0f.

See also: setBloomIntensity(), getBloomIntensity()

◆ BloomUseIntensityTextureProperty

PropertyType<bool> kanzi::StandardPostProcessMaterial::BloomUseIntensityTextureProperty

static

Determines if the bloom Intensity texture is used or not.

The default value is False.

See also: setBloomUseIntensityTextureProperty(), getBloomUseIntensityTextureProperty()

◆ BloomIntensityTextureProperty

PropertyType<ResourceSharedPtr> kanzi::StandardPostProcessMaterial::BloomIntensityTextureProperty

static

Determines the bloom radius texture.

See also: setBloomRadius(), getBloomRadius()

◆ TonemapAProperty

PropertyType<float> kanzi::StandardPostProcessMaterial::TonemapAProperty

static

Tonemap function parameter A.

The default value is 0.15f.

See also: setTonemapA(), getTonemapA()

◆ TonemapBProperty

PropertyType<float> kanzi::StandardPostProcessMaterial::TonemapBProperty

static

Tonemap function parameter B.

The default value is 0.5.

See also: setTonemapB(), getTonemapB()

◆ TonemapCProperty

PropertyType<float> kanzi::StandardPostProcessMaterial::TonemapCProperty

static

Tonemap function parameter C.

The default value is 0.1.

See also: setTonemapC(), getTonemapC()

◆ TonemapDProperty

PropertyType<float> kanzi::StandardPostProcessMaterial::TonemapDProperty

static

Tonemap function parameter D.

The default value is 0.2.

See also: setTonemapD(), getTonemapD()

◆ TonemapEProperty

PropertyType<float> kanzi::StandardPostProcessMaterial::TonemapEProperty

static

Tonemap function parameter E.

The default value is 0.02.

See also: setTonemapE(), getTonemapE()

◆ TonemapFProperty

PropertyType<float> kanzi::StandardPostProcessMaterial::TonemapFProperty

static

Tonemap function parameter F.

The default value is 0.3.

See also: setTonemapF(), getTonemapF()

◆ TonemapWhiteScaleProperty

PropertyType<float> kanzi::StandardPostProcessMaterial::TonemapWhiteScaleProperty

static

Tonemap function parameter Wwhite scale.

The default value is 10.0.

See also: setTonemapWhiteScale(), getTonemapWhiteScale()

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

kanzi/core.ui/graphics3d/standard_postprocess_material.hpp

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ getBlurRadius()

◆ setBlurRadius()

◆ getBlurDirection()

◆ setBlurDirection()

◆ getBloomRadius()

◆ setBloomRadius()

◆ getBloomIntensity()

◆ setBloomIntensity()

◆ getBloomUseIntensityTextureProperty()

◆ setBloomUseIntensityTextureProperty()

◆ getBloomIntensityTexture()

◆ setBloomIntensityTexture()

◆ getTonemapA()

◆ setTonemapA()

◆ getTonemapB()

◆ setTonemapB()

◆ getTonemapC()

◆ setTonemapC()

◆ getTonemapD()

◆ setTonemapD()

◆ getTonemapE()

◆ setTonemapE()

◆ getTonemapF()

◆ setTonemapF()

◆ getTonemapWhiteScale()

◆ setTonemapWhiteScale()

◆ makeEditorInfo()

Member Data Documentation

◆ BlurRadiusProperty

◆ BlurDirectionProperty

◆ BloomRadiusProperty

◆ BloomIntensityProperty

◆ BloomUseIntensityTextureProperty

◆ BloomIntensityTextureProperty

◆ TonemapAProperty

◆ TonemapBProperty

◆ TonemapCProperty

◆ TonemapDProperty

◆ TonemapEProperty

◆ TonemapFProperty

◆ TonemapWhiteScaleProperty