Kanzi  3.9.6
Java API
StandardMaterialMetadata Interface Reference

Metadata definitions for StandardMaterial. More...

Public Attributes

DynamicPropertyType< ColorRGBAAmbientProperty
 The color of the material when lights are not present. More...
 
DynamicPropertyType< Float > BlendIntensityProperty
 Controls the intensity of materials that are blended on top of an existing color. More...
 
DynamicPropertyType< Integer > BlendModeProperty
 Sets how to blend colors. More...
 
DynamicPropertyType< ColorRGBADiffuseProperty
 The color of the material when it is lit by a light. More...
 
DynamicPropertyType< ColorRGBAEmissiveProperty
 The color of the light that is emitted from the material surface. More...
 
DynamicPropertyType< ColorRGBAGlobalAmbientProperty
 The color that is multiplied automatically with the "Ambient" property of the materials in the scene. More...
 
DynamicPropertyType< ResourceGlyphTextureProperty
 The automatic texture of the glyph cache. More...
 
DynamicPropertyType< Vector2MaskTextureOffsetProperty
 Sets an offset for mask in materials. More...
 
DynamicPropertyType< ResourceMaskTextureProperty
 The texture for masking other texture or color. More...
 
DynamicPropertyType< Vector2MaskTextureTilingProperty
 Determines the number of times a mask is presented in a material. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.StandardMaterial")
 Metaclass for StandardMaterial.
 
DynamicPropertyType< ColorRGBASpecularColorProperty
 The color of the specular reflection. More...
 
DynamicPropertyType< Float > SpecularExponentProperty
 Determines the size of the specular highlight. More...
 
DynamicPropertyType< Vector2TextureOffsetProperty
 Sets an offset for texture in materials. More...
 
DynamicPropertyType< ResourceTextureProperty
 The texture of the material. More...
 
DynamicPropertyType< Vector2TextureTilingProperty
 Determines the number of times a texture is presented in a material. More...
 

Detailed Description

Metadata definitions for StandardMaterial.

Member Data Documentation

◆ AmbientProperty

DynamicPropertyType<ColorRGBA> AmbientProperty
Initial value:
=
new DynamicPropertyType<>("Ambient", ColorRGBA.class)

The color of the material when lights are not present.

◆ BlendIntensityProperty

DynamicPropertyType<Float> BlendIntensityProperty
Initial value:
=
new DynamicPropertyType<>("BlendIntensity", Float.class)

Controls the intensity of materials that are blended on top of an existing color.

Attached property enables overriding of the blend intensity of the used materials at render pass or object node level.

◆ BlendModeProperty

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

Sets how to blend colors.

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.

◆ DiffuseProperty

DynamicPropertyType<ColorRGBA> DiffuseProperty
Initial value:
=
new DynamicPropertyType<>("Diffuse", ColorRGBA.class)

The color of the material when it is lit by a light.

◆ EmissiveProperty

DynamicPropertyType<ColorRGBA> EmissiveProperty
Initial value:
=
new DynamicPropertyType<>("Emissive", ColorRGBA.class)

The color of the light that is emitted from the material surface.

◆ GlobalAmbientProperty

DynamicPropertyType<ColorRGBA> GlobalAmbientProperty
Initial value:
=
new DynamicPropertyType<>("GlobalAmbient", ColorRGBA.class)

The color that is multiplied automatically with the "Ambient" property of the materials in the scene.

◆ GlyphTextureProperty

DynamicPropertyType<Resource> GlyphTextureProperty
Initial value:
=
new DynamicPropertyType<>("GlyphTexture", Resource.class)

The automatic texture of the glyph cache.

◆ MaskTextureOffsetProperty

DynamicPropertyType<Vector2> MaskTextureOffsetProperty
Initial value:
=
new DynamicPropertyType<>("MaskTextureOffset", Vector2.class)

Sets an offset for mask in materials.

◆ MaskTextureProperty

DynamicPropertyType<Resource> MaskTextureProperty
Initial value:
=
new DynamicPropertyType<>("MaskTexture", Resource.class)

The texture for masking other texture or color.

◆ MaskTextureTilingProperty

DynamicPropertyType<Vector2> MaskTextureTilingProperty
Initial value:
=
new DynamicPropertyType<>("MaskTextureTiling", Vector2.class)

Determines the number of times a mask is presented in a material.

◆ SpecularColorProperty

DynamicPropertyType<ColorRGBA> SpecularColorProperty
Initial value:
=
new DynamicPropertyType<>("SpecularColor", ColorRGBA.class)

The color of the specular reflection.

◆ SpecularExponentProperty

DynamicPropertyType<Float> SpecularExponentProperty
Initial value:
=
new DynamicPropertyType<>("SpecularExponent", Float.class)

Determines the size of the specular highlight.

◆ TextureOffsetProperty

DynamicPropertyType<Vector2> TextureOffsetProperty
Initial value:
=
new DynamicPropertyType<>("TextureOffset", Vector2.class)

Sets an offset for texture in materials.

◆ TextureProperty

DynamicPropertyType<Resource> TextureProperty
Initial value:
=
new DynamicPropertyType<>("Texture", Resource.class)

The texture of the material.

◆ TextureTilingProperty

DynamicPropertyType<Vector2> TextureTilingProperty
Initial value:
=
new DynamicPropertyType<>("TextureTiling", Vector2.class)

Determines the number of times a texture is presented in a material.