Kanzi 3.9.10
Public Attributes | List of all members
ShadowEffect2DMetadata Interface Reference

Metadata definitions for ShadowEffect2D. More...

Inheritance diagram for ShadowEffect2DMetadata:
[legend]

Public Attributes

DynamicPropertyType< Vector2 > ActualOffsetProperty
 Reports the offset of the shadow from the object along the x and y axes in pixels.
 
DynamicPropertyType< Float > AngleProperty
 Sets the direction of the shadow as an angle relative to the positive x axis.
 
DynamicPropertyType< Integer > BlendModeProperty
 Sets the blend mode to use for rendering the shadow.
 
DynamicPropertyType< Float > BlurRadiusProperty
 Sets the softness of the shadow by defining the distance in pixels the shadow blur extends outward from an edge.
 
DynamicPropertyType< ColorRGBA > ColorProperty
 Sets the color and alpha of the shadow.
 
DynamicPropertyType< Float > DistanceProperty
 Sets how far to move the shadow from the object in the direction set by the Shadow Angle property.
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ShadowEffect2D")
 Metaclass for ShadowEffect2D.
 
DynamicPropertyType< Vector2 > OverrideOffsetProperty
 Sets the offset of the shadow from the object along the x and y axes in pixels.
 
DynamicPropertyType< ShadowEffect2DEnums.Quality > QualityProperty
 Sets the visual quality of the shadow.
 
DynamicPropertyType< Boolean > ShadowOnlyProperty
 Whether to render only the shadow without the node contents.
 
DynamicPropertyType< ShadowEffect2DEnums.Type > TypeProperty
 Sets the type of the shadow:
 
- Public Attributes inherited from NodeEffect2DMetadata
DynamicPropertyType< Boolean > EnabledProperty
 Whether to apply this effect.
 
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 ShadowEffect2D.

Member Data Documentation

◆ ActualOffsetProperty

DynamicPropertyType<Vector2> ActualOffsetProperty
Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.ActualOffset", Vector2.class)

Reports the offset of the shadow from the object along the x and y axes in pixels.

Kanzi calculates the offset from the values of the Shadow Distance and Shadow Angle properties or from the Override Shadow Offset, if it is set.

◆ AngleProperty

DynamicPropertyType<Float> AngleProperty
Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.Angle", Float.class)

Sets the direction of the shadow as an angle relative to the positive x axis.

The default is 45 degrees. When you set the Override Shadow Offset property, this property has no effect.

◆ BlendModeProperty

DynamicPropertyType<Integer> BlendModeProperty
Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.BlendMode", Integer.class)

Sets the blend mode to use for rendering the shadow.

Color Blending:

  • Additive adds the source pixels to the destination pixels.
  • Multiply multiplies the source and destination pixels.
  • Screen adds the source and destination pixels and subtracts from the result the product of the source and destination.
  • Alpha: Automatic uses premultiplied or non-premultiplied alpha depending on the value of the "Premultiply Alpha" property in the project or an image.
  • Alpha: Non-premultiplied is a legacy mode. For non-premultiplied input use the Alpha: Mixed mode.
  • Alpha: Premultiplied expects premultiplied alpha RGBA in the source pixels and blends the source pixels on top of the destination pixels. This is the default and recommended mode for alpha blending.
  • Alpha: Mixed expects non-premultiplied alpha RGBA in the source pixels, and blends the source pixels with the destination framebuffer.

Alpha Compositing:

  • Opaque disables blending and replaces the destination pixels with the source pixels.
  • Clear sets the destination pixels to transparent black.
  • Exclusive Or draws the non-overlapping source and destination pixels.
  • Source Atop discards those source pixels that do not cover destination pixels and draws the rest of the source pixels over destination pixels.
  • Source In draws those source pixels that cover destination pixels and discards all destination pixels.
  • Source Out draws the source pixels with alpha reduced by the inverse of the destination alpha, and discards all destination pixels.
  • Destination Atop discards those destination pixels that are not covered by source pixels, and draws the rest of the destination pixels over source pixels.
  • Destination In draws only those destination pixels that intersect with the source pixels, and discards all source pixels.
  • Destination Out draws the destination pixels with alpha reduced by the inverse of the source alpha, and discards all source pixels.
  • Destination Over draws the destination pixels over the source pixels.

Advanced Color Blending:

  • Multiply (advanced khr) is similar to the Multiply mode but it screens the alpha.
  • Overlay multiplies dark pixels and screens light pixels.
  • Darken compares the destination and source pixels and selects the darker one.
  • Lighten compares the destination and source pixels and selects the lighter one.
  • Color Burn darkens the destination to reflect the color of the source.
  • Color Dodge lightens the destination to reflect the color of the source.
  • Hard Light multiplies with dark source color and screens with light source color.
  • Soft Light burns with dark source color and dodges with light source color.
  • Difference uses the difference of the source and destination pixels.
  • Exclusion is similar to difference but the result is lower in contrast.
  • HSL Hue uses the hue of the source, and the luminosity and saturation of the destination.
  • HSL Saturation uses the saturation of the source, and the hue and luminosity of the destination.
  • HSL Color uses the hue and saturation of the source, and the luminosity of the destination.
  • HSL Luminosity uses luminosity of the source, and the jue and saturation of the destination.

The advanced color blending modes require the GL_KHR_blend_equation_advanced and GL_KHR_blend_equation_advanced_coherent OpengGL extensions.

◆ BlurRadiusProperty

DynamicPropertyType<Float> BlurRadiusProperty
Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.BlurRadius", Float.class)

Sets the softness of the shadow by defining the distance in pixels the shadow blur extends outward from an edge.

For a shadow with sharp edges, set to 0. The default is 8 pixels.

◆ ColorProperty

DynamicPropertyType<ColorRGBA> ColorProperty
Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.Color", ColorRGBA.class)

Sets the color and alpha of the shadow.

◆ DistanceProperty

DynamicPropertyType<Float> DistanceProperty
Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.Distance", Float.class)

Sets how far to move the shadow from the object in the direction set by the Shadow Angle property.

The default is 10 pixels. When you set the Override Shadow Offset property, this property has no effect.

◆ OverrideOffsetProperty

DynamicPropertyType<Vector2> OverrideOffsetProperty
Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.OverrideOffset", Vector2.class)

Sets the offset of the shadow from the object along the x and y axes in pixels.

When you set this property, the Shadow Angle and Shadow Distance properties have no effect. To disable the offset override, remove this property.

◆ QualityProperty

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

Sets the visual quality of the shadow.

Lower quality uses less computing and memory resources.

◆ ShadowOnlyProperty

DynamicPropertyType<Boolean> ShadowOnlyProperty
Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.ShadowOnly", Boolean.class)

Whether to render only the shadow without the node contents.

◆ TypeProperty

DynamicPropertyType<ShadowEffect2DEnums.Type> TypeProperty
Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.Type", ShadowEffect2DEnums.Type.class)

Sets the type of the shadow:

  • Drop Shadow appears behind or below objects.
  • Inner Shadow appears inside objects.