OutlineEffect2DMetadata
¶
Defines properties and message types for OutlineEffect2D.
Inherits properties and message types from NodeEffect2DMetadata.
OutlineEffect2DMetadata.BlendModeProperty¶ | Sets the blend mode to use for rendering the outline. Color Blending:
Alpha Compositing:
Advanced Color Blending:
The advanced color blending modes require the GL_KHR_blend_equation_advanced and GL_KHR_blend_equation_advanced_coherent OpengGL extensions. |
OutlineEffect2DMetadata.WidthProperty¶ | Sets the width of the outline in pixels outside the content area. The default value is 4 pixels. |
OutlineEffect2DMetadata.ColorProperty¶ | Sets the color of the outline. |
OutlineEffect2DMetadata.SoftnessProperty¶ | Sets the softness of the outline. For a sharp outline, set to 0. For a fade-in that takes the complete outline width to reach maximum value, set to 1. The default value is 0.27. |
OutlineEffect2DMetadata.InnerWidthProperty¶ | Sets the width of the outline in pixels inside the content area. By default, this property uses the value of the Outline Width property. |
OutlineEffect2DMetadata.InnerSoftnessProperty¶ | Sets the softness of the outline relative to its width inside the content area. For a sharp outline, set to 0. For a fade-in that takes the complete outline width to reach maximum value, set to 1. By default, this property uses the value of the Outline Softness property. |
OutlineEffect2DMetadata.TextureProperty¶ | Sets the texture to apply to the outline. Kanzi applies to the outline only the top row of pixels from this texture. Set Outline Color to the color with which you want to modulate the colors in this texture. |
OutlineEffect2DMetadata.TextureOffsetProperty¶ | Sets the relative starting offset for sampling the outline texture. The default value is 0.0. |
OutlineEffect2DMetadata.TextureTilingProperty¶ | Sets the number of times the texture wraps around within the outline area. To repeat a texture, set its Wrap Mode to Repeat. The default value is 1.0 |
OutlineEffect2DMetadata.ContentMaskProperty¶ | Sets the color that masks color components relevant to the outline calculation. The comparison value is the result of a dot product between the mask and the content RGBA color value. By default Kanzi calculates the outline only from the alpha value. |
OutlineEffect2DMetadata.ContentThresholdProperty¶ | Sets the threshold at which the value Kanzi calculates using the content mask is considered valid. When the value calculated from masking the content exceeds this value, that pixel is part of the outlined area. |
OutlineEffect2DMetadata.ContentGradientProperty¶ | Sets the gradient along which the content fades out:
For a perfectly smooth gradient, set Start to 0 and Softness to 1. The default value [ 0.0, 0.19 ] makes the content fade out quickly before the outline fade-out starts. |
OutlineEffect2DMetadata.InvertContentMaskProperty¶ | Whether to invert the value that Kanzi calculates using content masking. |
OutlineEffect2DMetadata.MethodProperty¶ | Sets the method for outline calculation:
|
Message arguments classes define message arguments used for different message types. Each class defines a number of property types - arguments - together with getter and setter functions for them.