Kanzi  3.9.5
Java API
BlurEffect2DMetadata Interface Reference

Metadata definitions for BlurEffect2D. More...

Inheritance diagram for BlurEffect2DMetadata:
[legend]

Public Attributes

DynamicPropertyType< Boolean > MaskedProperty
 Sets whether to blur only the pixels whose alpha channel value is not zero. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.BlurEffect2D")
 Metaclass for BlurEffect2D.
 
DynamicPropertyType< Integer > QualityProperty
 Sets the visual quality of the blur. More...
 
DynamicPropertyType< Float > RadiusProperty
 Sets the amount of blur by defining the radius of the circular area of pixels that blend into each other. More...
 
- Public Attributes inherited from NodeEffect2DMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.NodeEffect2D")
 Metaclass for NodeEffect2D.
 
- Public Attributes inherited from ResourceMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Resource")
 Metaclass for Resource.
 

Detailed Description

Metadata definitions for BlurEffect2D.

Member Data Documentation

◆ MaskedProperty

DynamicPropertyType<Boolean> MaskedProperty
Initial value:
=
new DynamicPropertyType<>("BlurEffect2D.Masked", Boolean.class)

Sets whether to blur only the pixels whose alpha channel value is not zero.

When you enable this property, the blur does not spread to fully transparent pixels and the edges of the content stay sharp. The default value is false.

◆ QualityProperty

DynamicPropertyType<Integer> QualityProperty
Initial value:
=
new DynamicPropertyType<>("BlurEffect2D.Quality", Integer.class)

Sets the visual quality of the blur.

Lower quality uses less computing and memory resources.

◆ RadiusProperty

DynamicPropertyType<Float> RadiusProperty
Initial value:
=
new DynamicPropertyType<>("BlurEffect2D.Radius", Float.class)

Sets the amount of blur by defining the radius of the circular area of pixels that blend into each other.

The blur radius also determines the distance in pixels that the blur expands the render area by extending outward from an edge, unless you enable the Masked Blur property. To disable the blur effect, set this property to 0. The default value is 8.