Progressive Rendering Viewport 2D

Progressive Rendering Viewport 2D properties

Name

Description

Inherited

Exported to Kanzi Engine

Tags

List of tags attached to the item

No

No

Effective Data Context

The data context in the current node that is resolved from data context properties and bindings

No

No

Foreground Hint

Give a hint of the type of the foreground of 2D nodes: - None renders the background brush after rendering the node. - Translucent renders the background brush before the content of the node. - Occluding renders the background brush.

No

Yes

Timeline

The animation timeline to play in Progressive Rendering Viewport 2D

No

Yes

Render Pass Prefab

Sets which render pass prefab will be used to instantiate the render pass tree.

No

Yes

Progressive Rendering Viewport 2D available properties

Name

Description

Inherited

Exported to Kanzi Engine

Active Activity Index

The index of the active Activity in the Data-Driven Exclusive Activity Host. After instantiating all Activity from a Data Source, this property refers to the only currently active Activity in this Data-Driven Exclusive Activity Host. To deactivate all the Activities in this Data-Driven Exclusive Activity Host, set this property to -1.

No

Yes

Activity Source

The data object that provides the data for this Activity node.

No

Yes

Activity Status

Sets the possible states of the Activity when its Activity Host activates or deactivates that Activity.

No

Yes

Activity Template

If set, the Data-Driven Exclusive Activity Host uses this prefab for Activity nodes that it creates.

No

Yes

Actual Layout Height

The calculated height of the node when used in a layout.

No

Yes

Actual Layout Width

The calculated width of the node when used in a layout.

No

Yes

Alpha Cutoff

Sets the cutoff threshold for alpha cutting. If the alpha value is less than the value of this property, Kanzi discards the fragment. The default value is 0.5.

No

Yes

Ambient Color

The color of the material when lights are not present.

No

Yes

Aspect Ratio

Determines the proportion of width and height. You cannot set both the Aspect Ratio and both, Width and Height.

No

Yes

Auto Press Interval

Sets the time in milliseconds after which a button that the user keeps pressed down sends the Button: Click message. While the user holds the button down, the button keeps sending the Button: Click message at the time interval set by this property. To disable the behavior, set to 0.

No

Yes

Background Brush

The background brush to paint the background of 2D nodes.

No

Yes

Base Color Factor

Sets the base color for the material.

No

Yes

Base Color Texture

Sets the texture that contains the base color for the material. Use the Base Color Factor property to filter the value from this texture.

No

Yes

Baseline

Font baseline in 3D space units.

No

Yes

Blend Intensity

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.

No

Yes

Blend Mode

Sets how to blend colors:

  • Opaque disables blending and replaces the destination pixels with the source pixels.

  • 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.

  • 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.

No

Yes

Blur Quality

Sets the visual quality of the blur. Lower quality uses less computing and memory resources.

No

Yes

Blur Radius

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.

No

Yes

Bottom Image

The image to use in middle of the bottom row.

No

Yes

Bottom-Left Image

Image to use in the bottom-left corner.

No

Yes

Bottom-Right Image

The image to use in the bottom-right corner.

No

Yes

BRDF Lookup Table

Gets the Bidirectional Reflectance Distribution Function (BRDF) lookup table for the material. The BRDF table is a texture that contains precomputed information about how light reflects off a material. You can use it to improve rendering quality.

No

Yes

Bring Activated Activity To Front

Sets whether to show the activated Activity in front within its Parallel Activity Host. This property affects the z-order of the activated Activity within the same Activity priority layer: - When enabled, the Activity is shown in front. - When disabled, the z-order of the activated child Activity is determined by the order in which you added that Activity to the parent Parallel Activity Host. This is the default behavior.

No

Yes

Brush Color

Color for brush. Set alpha to 0 to disable brush.

No

Yes

Brush Horizontal Tiling

Horizontal Tiling for the brush. Affects the scale of texture coordinates.

No

Yes

Brush Modulate Color

Modulation color for brush. Effects brush rendering that needs color modulation.

No

Yes

Brush Texture

Texture for brush.

No

Yes

Brush Vertical Tiling

Vertical Tiling for the brush. Affects the scale of texture coordinates.

No

Yes

Cache Valid

Indicates whether the node is cached. To disable the cache for one frame, disable this property.

No

Yes

Caching Mode

Sets the caching mode of this node: - Disabled sets Kanzi to render the node and its descendants normally, without caching. This is the default. - Enabled sets Kanzi to cache the node and its descendants and render the node from the cache image until you invalidate the cache by disabling the Cache Valid property. - Automatic sets Kanzi to automatically update the cache of the node whenever the content of the node or its descendants change.

No

Yes

Calculated Offset

Reports the current relative offset of an item in the Grid List Box in proportional range [0, 1].

No

Yes

Calculated Offset

Reports the current offset of an item in a Trajectory Layout in the proportional range [0, 1].

No

Yes

Camera

Sets which camera to use in scenes rendered by the selected Viewport 2D. If not set, Kanzi uses the camera in the scene.

No

Yes

Center Image

The image to use in the center.

No

Yes

Character Spacing

Sets the character spacing in pixels.

No

Yes

Clear Coat Normal Scale

Sets the clear coat normal scale for the material. Use the scale to set the intensity of the Clear Coat Normal Texture.

No

Yes

Clear Coat Normal Texture

Sets the texture that contains a clear coat normal map for the material. Use the Clear Coat Normal Scale property to scale the texture value.

No

Yes

Clear Coat Roughness Factor

Sets the roughness of the outer clear coat layer for the material: 0 represents a smooth, glossy surface, and 1 represents a rough, diffuse surface.

No

Yes

Clear Coat Roughness Texture

Sets the texture that contains a clear coat roughness map for the material. Kanzi reads the roughness from the Green channel of the texture. Use the Clear Coat Roughness Factor property to scale the roughness from this texture.

No

Yes

Clear Coat Strength Factor

Sets the clear coat strength for the material: 0 represents a material with no clear coat, and 1 represents a full strength clear coat.

No

Yes

Clear Coat Strength Texture

Sets the texture that contains a clear coat strength map for the material. Kanzi reads the strength from the Red channel of the texture. Use the Clear Coat Strength Factor property to scale the strength from this texture.

No

Yes

Clip Children

Sets whether to clip the child nodes of thos node. Kanzi clips the child nodes whose bounding box is completely outside of the bounding box of their parent node. Use this property with layout nodes. The child nodes can use only translation transformation.

No

Yes

Code Behind Source

Sets the metaclass name of the code behind class for this node.

No

Yes

Column

The column into which grid layout places the item.

No

Yes

Column Span

Defines the number of columns an item in a grid layout occupies.

No

Yes

Command

The command executed by a UI control

No

Yes

Composition Brush

The brush to use to compose 2D nodes to screen.

No

Yes

Content Stretch

Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size).

No

Yes

Controller Property

Sets the property type that the Exclusive Activity Host node uses to switch between its child Activity nodes.

No

Yes

Custom Asset Thumbnail

When enabled, the asset will have selected image as thumbnail instead of the generated one.

No

No

Cyclic Focus Navigation

Sets whether the focus chain navigation within the focus scope is cyclic. When you enable this property: - When the user navigates in the forward direction and the focus reaches the last focusable UI element of the focus scope, the focus navigation moves to the first focusable UI element. - When the user navigates in the backward direction and the focus reaches the first focusable UI element of the focus scope, the focus navigation moves to the last focusable UI element.

No

Yes

Data Context

Source of data for this node and its descendants

No

Yes

Data Source Controller Property Path

Sets the path in the Data Source object of an Exclusive Activity Host node to a Data Object item that the Exclusive Activity Host node uses as the Controller Property.

No

Yes

Description

Add a description of the purpose of this item. To export descriptions to a plain text file, select File > Export > Export Descriptions. When you export the kzb file, this description is not included in the exported file.

No

No

Detail Base Color Factor

Sets the detail base color for the material. The detail base color is alpha blended with the standard base color.

No

Yes

Detail Base Color Texture

Sets the detail texture that contains the base color for the material. Use the Detail Base Color Factor property to filter the value from this texture. The detail base color is alpha blended with the standard base color. Use the Detail Texture Tiling and Detail Texture Offset properties to set UVs for this texture.

No

Yes

Detail Clear Coat Normal Scale

Sets the detail clear coat normal scale for the material. Use the scale to set the intensity of the Detail Clear Coat Normal Texture.

No

Yes

Detail Clear Coat Normal Texture

Sets the detail texture that contains a clear coat normal map for the material. Use the Detail Clear Coat Normal Scale property to scale the texture value.

No

Yes

Detail Clear Coat Roughness Texture

Sets the detail texture that contains a clear coat roughness map for the material. Use the Clear Coat Roughness Factor and Clear Coat Roughness Texture properties to scale the roughness from this texture. Use the Detail Texture Tiling and Detail Texture Offset properties to set UVs for this texture.

No

Yes

Detail Clear Coat Strength Texture

Sets the detail texture that contains a clear coat strength map for the material. Kanzi reads the strength from the Red channel of the texture. Use the Clear Coat Strength Factor and Clear Coat Strength Texture properties to scale the strength from this texture. Use the Detail Texture Tiling and Detail Texture Offset properties to set UVs for this texture.

No

Yes

Detail Diffuse Color Factor

Sets the detail diffuse color for the material. Kanzi alpha blends the detail diffuse color with the standard diffuse color.

No

Yes

Detail Diffuse Color Texture

Sets the detail texture that contains the diffuse color for the material. Use the Detail Diffuse Color Factor property to filter the value from this texture. Kanzi alpha blends the detail diffuse color with the standard diffuse color. Use the Detail Texture Tiling and Detail Texture Offset properties to set UVs for this texture.

No

Yes

Detail Emissive Factor

Sets the color of the light that is emitted from a detail texture for the material. This color affects the local material rendering, but the light is not cast to other objects. The detail emissive light is alpha blended with the standard emissive light. Use the Detail Texture Tiling and Detail Texture Offset properties to set UVs for this texture.

No

Yes

Detail Emissive Texture

Sets the detail texture that contains the light emitted from the material. Use the Detail Emissive Factor property to scale the value from this texture. Use the Detail Texture Tiling and Detail Texture Offset properties to set UVs for this texture.

No

Yes

Detail Glossiness Texture

Sets the detail texture that contains a glossiness map for the material. Kanzi reads the glossiness from the Alpha channel of this texture. Use the Glossiness Factor and Glossiness Texture properties to scale the glossiness from this texture. Use the Detail Texture Tiling and Detail Texture Offset properties to set UVs for this texture.

No

Yes

Detail Metallic Texture

Sets the detail texture that contains a metallic map for the material. Kanzi reads the metalness from the Blue channel of this texture. Use the Metallic Factor and Metallic Texture properties to scale the metalness from this texture. Use the Detail Texture Tiling and Detail Texture Offset properties to set UVs for this texture.

No

Yes

Detail Normal Scale

Sets the detail normal scale for the material. Use the scale to set the intensity of the Detail Normal Texture.

No

Yes

Detail Normal Texture

Sets the detail texture that contains a normal map for the material. Use the Detail Normal Scale property to scale the texture value.

No

Yes

Detail Occlusion Strength

Sets the detail occlusion strength for the material. Use the strength to set the intensity of the Detail Occlusion Texture.

No

Yes

Detail Occlusion Texture

Sets the detail texture that contains an occlusion map for the material. Kanzi reads the occlusion from the Red channel of this texture. Use the Detail Occlusion Strength property to scale the occlusion from this texture. Use the Detail Texture Tiling and Detail Texture Offset properties to set UVs for this texture.

No

Yes

Detail Roughness Texture

Sets the detail texture that contains a roughness map for the material. Kanzi reads the roughness from the Green channel of the texture. Use the Roughness Factor and Roughness Texture properties to scale the roughness from this texture. Use the Detail Texture Tiling and Detail Texture Offset properties to set UVs for this texture.

No

Yes

Detail Specular Color Factor

Sets the detail specular color for the material. Kanzi alpha blends the detail specular color with the standard specular color.

No

Yes

Detail Specular Color Texture

Sets the detail texture that contains the specular color for the material. Use the Detail Specular Color Factor property to filter the value from this texture. Kanzi alpha blends the detail specular color with the standard specular color. Use the Detail Texture Tiling and Detail Texture Offset properties to set UVs for this texture.

No

Yes

Detail Texture Offset

Sets the detail texture offset for the material. Kanzi adds this value to the UVs to produce a second set of detail UVs to use for all detail texture properties.

No

Yes

Detail Texture Tiling

Sets the detail texture tiling factor for the material. Kanzi multiplies this value by the UVs to produce a second set of detail UVs to use for all detail texture properties.

No

Yes

Diffuse Color

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

No

Yes

Diffuse Color Factor

Sets the diffuse color for the material.

No

Yes

Diffuse Color Texture

Sets the texture that contains the diffuse color for the material. Use the Diffuse Color Factor property to filter the value from this texture.

No

Yes

Direction

Defines the axis along which the stack layout arranges its items.

No

Yes

Disable KZB Export

Disables the exporting of the item into KZB. Can be used for, e.g. letting items out from certain profiles. The disabled items are always included in preview.

No

No

Disable Render Target Clear Color

Do not clear render target buffers before rendering into it even if necessary.

No

Yes

Down On Hover

Whether holding a finger on the device screen and moving it over the button transitions the button to the down state.

No

Yes

Effect

Reports the runtime effect instance that this node uses. Kanzi sets the value of this property internally when the value of the Effect Prefab property in this node changes.

No

Yes

Effect Prefab

The 2D Effect to use for this node.

No

Yes

Effectively Enabled

Indicates whether this node and its ancestor nodes are enabled. Use this property in state managers and bindings to observe whether a node is effectively enabled. To enable or disable a node, use the Enabled property. When a node is effectively disabled: - When that node is focused, it receives keyboard input until the focus moves to another node. - When that node is not focused, it is not part of the focus chain and does not receive keyboard input.

No

Yes

Emissive Color

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

No

Yes

Emissive Factor

Sets the color of the light that is emitted from the material. This color affects the local material rendering, but the light is not cast to other objects.

No

Yes

Emissive Texture

Sets the texture that contains the light emitted from the material. Use the Emissive Factor property to scale the value from this texture.

No

Yes

Enabled

Whether this node is enabled. When you disable this property in a node, that node and its descendant nodes in the same overlay focus scope are effectively disabled. Effectively disabling a node removes that node from the focus chain and cancels all the active input manipulators.Use the Effectively Enabled property to observe whether a node is effectively enabled.

No

Yes

Environment Ambient Factor

Sets the strength of the cubemap texture to use for ambient environment light. Use the Environment Ambient Texture property to set the cubemap texture. The ambient environment light affects diffuse lighting in image based lighting.

No

Yes

Environment Ambient Texture

Sets the cubemap to use for the ambient environment light for the material. This cubemap affects the diffuse lighting during image based lighting. Use the Environment Ambient Factor property to set the strength of the cubemap texture.

No

Yes

Environment Reflection Factor

Sets the strength of the cubemap texture to use for specular environment light. Use the Environment Reflection Texture property to set the cubemap texture. The specular environment light affects reflective lighting in image based lighting.

No

Yes

Environment Reflection Texture

Sets the cubemap to use for the specular environment light for the material. This cubemap affects reflective lighting during image based lighting. Use the Environment Reflection Factor property to set the strength of the cubemap texture.

No

Yes

Export in Asset Package

When enabled, this item is exported into asset package if this project is saved as one.

No

No

Exposure

Sets the exposure compensation for the material. The exposure compensation emulates camera exposure by controlling the total amount of light rendered. Use a negative value to darken the rendered image, and a positive value to lighten the image. Exposure is exponential: 1.0 is twice as bright as 0.0, and -1.0 is half as bright as 0.0.

No

Yes

Fixed Character Width

When set, overrides the font advance widths to make each character take a fixed amount of space specified in pixels.

No

Yes

Focus Order

Sets the focus chain order of the node within the focus scope.

No

Yes

Focus Scope Type

Sets the type of the focus scope node: - Group groups focusable nodes. - Fence keeps the focus chain navigation inside the scope and does not allow the focus chain navigation to enter or leave that scope. - Modal overlay blocks the key and touch input that originates outside of its boundaries and keeps the focus navigation within the scope boundaries. - Auto-Closing Modal overlay loses focus when key or touch input originates from a node that is outside of its node tree, and suppresses that input. - Modeless overlay propagates the key and touch input that originates outside of its boundaries to the nodes outside of its boundaries. - Auto-Closing Modeless overlay loses focus when key or touch input originates from a node that is outside of its boundaries, and propagates that input.

No

Yes

Focus State

Reports the focus state of a node: - No focus (0) indicates that the node is not focused. For a focus scope node indicates that none of the nodes in the scope have focus. - Logical focus (1) indicates that the node is the logical focus node of an overlay-type focus scope. For a focus scope node indicates that one of the nodes in that scope is the logical focus node. - Keyboard focus (2) indicates that the node is the keyboard focus node of the application and receives keyboard input. For a focus scope node indicates that one of the nodes in that scope is the keyboard focus node.

Use this property in state managers and bindings to implement focus states in the UI nodes.

To observe whether a node is the keyboard focus node, you can use the boolean Focus > Focused property.

No

Yes

Focusable

Indicates whether the node can receive focus.

No

Yes

Focused

Indicates whether the node has keyboard focus.

No

Yes

Font Color

Sets the color of the text.

No

Yes

Font Family

The font family used to render the text.

No

Yes

Font Hinting Preference

Sets the hinting preference of the font. - No hinting: Render text without hinting the outlines of glyphs. - Native hinting: Prefer native hinter of the font over the auto-hinter of the rasterizer. - Auto hinting: Prefer auto-hinter of the rasterizer over the native hinter of the font.

No

Yes

Font Material

Sets the material whose shader is used to render the text. The shader must use the ContentTexture uniform which is automatically filled with glyph data.

No

Yes

Font Size

Sets the size of the font in pixels.

No

Yes

Font Style

Sets the style of the FontStyleConcept.

No

Yes

Font Weight

Sets the weight of the FontStyleConcept.

No

Yes

Force Composition

Force rendering to composing target even if not otherwise necessary.

No

Yes

Foreground Brush

The foreground brush to paint the foreground of 2D nodes.

No

Yes

Foreground Hint

Give a hint of the type of the foreground of 2D nodes: - None renders the background brush after rendering the node. - Translucent renders the background brush before the content of the node. - Occluding renders the background brush.

No

Yes

Fractional Character Width

Sets whether Kanzi uses fractional or rounded character widths to lay out text. In most cases fractional widths provide the best result. However, with small font sizes, fractional widths can cause the characters to run together or have too much space, making it difficult to read. - When enabled, Kanzi uses fractional character widths, which means that the spacing between characters varies and can be a fraction of a pixel. - When disabled, Kanzi uses character widths rounded to the nearest pixel. Disable fractional widths when you want to fix character spacing in whole-pixel increments and prevent characters in small font sizes from running together.

No

Yes

Global Ambient Color

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

No

Yes

Glossiness Factor

Sets the glossiness of the material: 0 represents a rough, diffuse surface, and 1 represents a smooth, glossy surface.

No

Yes

Glossiness Texture

Sets the texture that contains a glossiness map for the material. Kanzi reads the glossiness from the Alpha channel of this texture. Use the Glossiness Factor property to scale the glossiness from this texture.

No

Yes

Glyph Texture

The automatic texture of the glyph cache.

No

Yes

Hit Test Camera

Sets which hit test camera to use in scenes rendered by the selected Viewport 2D. If not set, Kanzi uses the camera in the scene.

No

Yes

Hit Testable

When enabled, users can pick the node from the default Camera node of the active Scene node. For example, you must enable hit testing for Button nodes to work.

No

Yes

Hold Interval

Sets the amount of time in milliseconds that the user must hold the button pressed down for Kanzi to recognize it as a long-press gesture. To disable the long-press gesture, set to 0.

No

Yes

Horizontal Alignment

The alignment in horizontal direction the node should use when it resides under a layout.

No

Yes

Horizontal Margin

Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. To set the Horizontal Margin property fields in a binding use: - Vector_X to access the Left property field - Vector_Y to access the Right property field

No

Yes

Horizontal Padding

Sets the padding spaces between the content and the left and right boundaries of the Text node.

No

Yes

Hover

Indicates whether a node is the foremost hit testable node under the cursor.

No

Yes

Image

The image to display.

No

Yes

Index In Group

Sets the index of the Button in the Toggle Button Group to which that Button is registered. If a Button does not have local value for this property, it is not registered to the ancestor Toggle Button Group. When set to -1 the Toggle Button Group assigns an index for the Button.

No

Yes

Invert Mask

Whether to invert the mask so that transparent areas become opaque and opaque areas become transparent.

No

Yes

Is Down

Indicates whether the button is pressed and in the down state.

No

Yes

Is Value Changing

Whether the value is currently changing.

No

Yes

Item Index

Reports the index of the item in the List Box Item Container.

No

Yes

Layout Height

The height of the node when used in a layout. Overrides the default bounds of the item.

No

Yes

Layout Transformation

The 2D transformation to be applied before layouting.

No

Yes

Layout Width

The width of the node when used in a layout. Overrides the default bounds of the item.

No

Yes

Left Image

The image to use in the center-left.

No

Yes

Line Spacing

Sets the line spacing in multiples of the normal line height of the selected FontStyleConcept.

No

Yes

Mask Channel

Sets the texture channel to use as the input for the mask: - Alpha uses the alpha channel from the texture. This is the default. - Red uses the red color channel from the texture. - Green uses the green color channel from the texture. - Blue uses the blue color channel from the texture. - Luminance uses the luminance calculated from the red, green, and blue channels.

No

Yes

Mask Height

Sets the height of the mask to use in a layout. This value overrides the height of the texture that you use as the mask.

No

Yes

Mask Horizontal Alignment

Sets the horizontal alignment of the mask effect:

  • Left aligns the left edge of the mask with the left edge of the node. This is the default.

  • Right aligns the right edge of the mask with the right edge of the node.

  • Center aligns the mask horizontally to the center of the node.

  • Stretch stretches the mask horizontally to fit the node from the left edge to the right edge.

No

Yes

Mask Offset

Sets the mask offset along the X and Y axes in pixels. Kanzi applies the mask offset after stretch, alignment, and scale.

No

Yes

Mask Scale

Sets the factor by which to scale the mask. Kanzi applies the scale after stretch and alignment.

No

Yes

Mask Strength

Sets the strength of the mask effect in the range from 0 to 1:

  • 0 disables the mask effect.

  • 1 applies the mask at full strength. This is the default.

  • Any value between 0 and 1 partially applies the mask as if the non-masked result was blended with the fully masked version.

No

Yes

Mask Stretch

Sets the stretch mode of the mask effect:

  • None disables stretching. This is the default.

  • Fill stretches the mask to fill the node.

  • Uniform stretches the mask using uniform scaling to fill the node in either vertical or horizontal direction, whichever requires smaller scale.

  • Uniform To Fill stretches the mask using uniform scaling to fill the node in either vertical or horizontal direction, whichever requires larger scale.

  • Repeat does not stretch the mask, and allows the mask to repeat outside of its area based on the mask texture wrap mode.

No

Yes

Mask Texture

The texture for masking other texture or color.

No

Yes

Mask Texture

Sets the mask texture. The default is no texture.

No

Yes

Mask Texture Offset

Sets an offset for mask in materials.

No

Yes

Mask Texture Tiling

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

No

Yes

Mask Vertical Alignment

Sets the vertical alignment of the mask effect:

  • Bottom aligns the bottom edge of the mask with the bottom edge of the node.

  • Top aligns the top edge of the mask with the top edge of the node. This is the default.

  • Center aligns the mask vertically to the center of the node.

  • Stretch stretches the mask vertically to fit the node from the top edge to the bottom edge.

No

Yes

Mask Width

Sets the width of the mask to use in a layout. This value overrides the width of the texture that you use as the mask.

No

Yes

Masked Blur

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.

No

Yes

Maximum Distance From Curve

The distance from the curve where hit testing succeeds.

No

Yes

Maximum Value

The maximum value that the range allows.

No

Yes

Metallic Factor

Sets the metalness of the material: 0 represents a non-metallic or dielectric object, and 1 represents a metallic object.

No

Yes

Metallic Texture

Sets the texture that contains a metallic map for the material. Kanzi reads the metalness from the Blue channel of this texture. Use the Metallic Factor property to scale the value from this texture.

No

Yes

Minimum Value

The minimum value that the range allows.

No

Yes

Multisample Level

Sets the multisampling level of the progressive rendering backbuffers. To disable multisampling, remove the property or set the property value to 1.

No

Yes

Node.Path

Full path to the node.

No

Yes

Normal Scale

Sets the normal scale for the material. Use the scale to set the intensity of the Normal Texture.

No

Yes

Normal Texture

Sets the texture that contains a normal map for the material. Use the Normal Scale property to scale the texture value.

No

Yes

Normalized Value

The current value normalized to range [0, 1].

No

Yes

Occlusion Strength

Sets the occlusion strength for the material. Use the strength to set the intensity of the Occlusion Texture.

No

Yes

Occlusion Texture

Sets the texture that contains an occlusion map for the material. Use the Occlusion Strength property to scale the occlusion from the texture.

No

Yes

Off-Screen Rendering

When set and the node has an explicitly set render target, do not render the resulting framebuffer to screen.

No

Yes

Opacity

Opacity of the node.

No

Yes

Overflow

Sets the characters that represent the truncated text when the text string to be rendered is too long to fit in the node. The default value is "...".

No

Yes

Perspective Transformation

The 3D transformation to be applied after layouting.

No

Yes

Perspective Transformation FOV

The 3D transformation field of view (degrees) to be applied after layouting.

No

Yes

Perspective Transformation Mode

Defines the mode of operation for the coordinate system and field of view.

No

Yes

Perspective Transformation Origin

The 3D transformation origin to be used for perspective transformation on this or child nodes.

No

Yes

Perspective Transformation Pivot

The 3D pivot point in relative coordinates.

No

Yes

Pixel Format

The pixel format of the node if rendering to a texture.

No

Yes

Remove Side Bearings

Whether to position the leftmost characters of left-aligned text and rightmost characters of right-aligned text exactly within the boundary of the text node.

No

Yes

Render Pass

The RenderPass used for rendering the Scene for the Viewport. Instantiated from the RenderPassPrefab. Set internally by Kanzi whenever RenderPassPrefabProperty changes.

No

Yes

Render Pass Prefab

Sets which render pass prefab will be used to instantiate the render pass tree.

No

Yes

Render Self

Whether the node renders itself. Does not affect the rendering of child nodes.

No

Yes

Render Target

Forces the node to be rendered into a given render target texture. When set to "No Target", regular conditions whether node is rendered to a texture, such as opacity and rotation, are applied.

No

Yes

Render Target Minimum Height

Sets the minimum height of implicitly generated render targets.

No

Yes

Render Target Minimum Width

Sets the minimum width of implicitly generated render targets.

No

Yes

Render Target Reallocation Limit

The change in size that triggers reallocation of a render target.

No

Yes

Render Transformation

The 2D transformation to be applied after layouting.

No

Yes

Render Transformation Origin

Sets the render transform origin in relative coordinates.

No

Yes

Reversed

Defines whether the stack layout arranges its items in reverse order.

No

Yes

Right Image

The image to use in the center-right.

No

Yes

Roughness Factor

Sets the roughness of the material: 0 represents a smooth, glossy surface, and 1 represents a rough, diffuse surface.

No

Yes

Roughness Texture

Sets the texture that contains a roughness map for the material. Kanzi reads the roughness from the Green channel of the texture. Use the Roughness Factor property to scale the roughness from this texture.

No

Yes

Row

The row into which grid layout places the item.

No

Yes

Row Span

Defines the number of rows an item in a grid layout occupies.

No

Yes

Selected

Indicates whether the List Box item held by this List Box Item Container is selected. The List Box sets the value of this property.

No

Yes

Selected Item Index

Sets the index of the item that is currently selected in the List Box node. A List Box node updates this property when the user scrolls that List Box node. By setting the value of this property to the index of the item that you want to select in a List Box, you can select that item.

No

Yes

Shadow Angle

Sets the direction of the shadow as an angle relative to the positive x axis. The default is 45 degrees.

No

Yes

Shadow Blur Radius

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.

No

Yes

Shadow Color

Sets the color and alpha of the shadow.

No

Yes

Shadow Distance

Sets how far to move the shadow from the object in the direction set by the Shadow Angle property. The default is 10 pixels.

No

Yes

Shadow Only

Whether to render only the shadow without the node contents.

No

Yes

Shadow Quality

Sets the visual quality of the shadow. Lower quality uses less computing and memory resources.

No

Yes

Shadow Type

Sets the type of the shadow: - Drop Shadow appears behind or below objects. - Inner Shadow appears inside objects.

No

Yes

Side

The docking side of an item in the dock layout.

No

Yes

Snap Character To Pixel

Sets whether Kanzi positions characters in 2D rendering to the nearest pixel: - When enabled, text sharpness improves, but some characters can shift a fraction of a pixel. - When disabled, certain combinations of screen resolution, use of anti-aliasing, and font size can cause the text to appear blurry. In that case, you can improve the appearance of the text with the Fractional Character Width and Character Spacing properties.

No

Yes

Snap to Pixel

Snap the translation of the node and its size into pixel boundary.

No

Yes

Specular Anti-Aliasing Strength

Sets the strength of the specular anti-aliasing effect. Higher value results in blurrier specular highlights. For no specular anti-aliasing, set the value to 0. For full specular anti-aliasing, set the value to 1. The default value is 0.25.

No

Yes

Specular Anti-Aliasing Threshold

Sets the upper limit for the amount of specular anti-aliasing effect to apply. The default value is 0.18.

No

Yes

Specular Color

The color of the specular reflection.

No

Yes

Specular Color Factor

Sets the specular color for the material.

No

Yes

Specular Color Texture

Sets the texture that contains the specular color for the material. Use the Specular Color Factor property to filter the value from this texture.

No

Yes

Specular Exponent

Determines the size of the specular highlight.

No

Yes

State Manager

Sets the State Manager to the node.

No

Yes

Step Value

The minimum amount that the value of the range can change at a time.

No

Yes

Stretch

Whether to scale this Trajectory Layout to match the layout size.

No

Yes

Style

Sets a style to the node.

No

Yes

Tags

List of tags attached to the item

No

No

Text

Sets the text content that the text node renders. To create a line break press Shift+Enter.

No

Yes

Text Horizontal Alignment

Sets the horizontal alignment of the text.

No

Yes

Text Vertical Alignment

Sets the vertical alignment of the text.

No

Yes

Texture

The texture of the material.

No

Yes

Texture 0

Sets the first texture you want the Blit Render Pass to blit.

No

Yes

Texture 1

Sets the second texture you want the Blit Render Pass to blit.

No

Yes

Texture 2

Sets the third texture you want the Blit Render Pass to blit.

No

Yes

Texture 3

Sets the fourth texture you want the Blit Render Pass to blit.

No

Yes

Texture Offset

Sets an offset for texture in materials.

No

Yes

Texture Tiling

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

No

Yes

Timeline

The animation timeline to play in Progressive Rendering Viewport 2D

No

Yes

Toggle State

Sets the toggle state of the Button.

No

Yes

Toggle State Count

Sets the number of toggle states of the Button.

No

Yes

Tone Map Linear Scale

Sets the scale for the linear tonemap option for the material. When linear tonemapping is used, Kanzi divides all output color by the value of this property.

No

Yes

Top Image

The image to use in the middle of the top row.

No

Yes

Top-Left Image

The image to use in the top-left corner.

No

Yes

Top-Right Image

The image to use in the top-right corner.

No

Yes

Trajectory Override Offset

Sets the offset of an item in a Trajectory Layout. When you do not set this property, the Trajectory Layout sets the offset.

No

Yes

Transition Phase

The phase of the transition. For example, use for pixel-based effects.

No

Yes

Two Pass Rendering

Defines whether the Text Block 3D is rendered in two passes. Disabling the two pass rendering improves performance, but can cause invalid rendering results when glyph bounds overlap.

No

Yes

Use Screen Space

Whether to layout the mask relative to the screen instead of the node.

No

Yes

Value

The current value.

No

Yes

Vertical Alignment

The alignment in vertical direction the node should use when it resides under a layout.

No

Yes

Vertical Margin

Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. To set the Vertical Margin property fields in a binding use: - Vector_X to access the Bottom property field - Vector_Y to access the Top property field

No

Yes

Vertical Padding

Sets the padding spaces between the content and the top and bottom boundaries of the Text node.

No

Yes

Visible

When disabled, Kanzi does not render the node.

No

Yes

Visible Amount in Parent

Sets the amount the node is inside its parent. Use the value of this property in shaders to implement fades. Calculated by the parent node.

No

Yes

Word Wrap

Sets whether to break long lines into multiple lines to make the text fit within the boundaries of the Text Block node.

No

Yes

Progressive Rendering Viewport 2D messages

Name

Description

Inherited

Exported to Kanzi Engine

About To Gain Focus

Kanzi sends this message before a focusable node receives focus.

No

Yes

About To Lose Focus

Kanzi sends this message before the focused node loses focus.

No

Yes

Activity Activated

An Activity sends this message when it is activated.

No

Yes

Activity Activating

An Activity sends this message when it is in the activating state.

No

Yes

Activity Deactivated

An Activity sends this message when it is deactivated.

No

Yes

Activity Deactivating

An Activity sends this message when it is in the deactivating state.

No

Yes

Activity Prefab Attached

An Activity Host sends this message when it attaches the prefab of the Activity that is activated.

No

Yes

Activity Prefab Detached

An Activity Host sends this message when it detaches the prefab of the Activity that is deactivated.

No

Yes

Activity Status Changed

An Activity sends this message when the value of its Activity Status property changes.

No

Yes

Animation Playback Completed

Occurs when animation player completes animation playback.

No

Yes

Animation Playback Started

Occurs when animation player starts animation playback.

No

Yes

Animation Playback Stopped

Occurs when animation player stops animation playback.

No

Yes

Asynchronous Load Completed

Occurs when asynchronous loading of resources from a prefab has been finished.

No

Yes

Button: Cancel

Occurs when a user lifts their finger outside of a Button that they previously pressed.

No

Yes

Button: Click

Occurs when a user lifts their finger on top of a Button that they previously pressed and when the time set by the Auto Press Interval property in the pressed Button expires.

No

Yes

Button: Down

Occurs when the user presses down the Button.

No

Yes

Button: Enter

Button: Enter trigger is set off: - When the user presses down the button. - When the user presses down the button, moves the pointer outside of the button area, and then moves the pointer back to the button area while still holding down the pointer.

No

Yes

Button: Leave

Button: Leave trigger is set off: - When the user presses down the button and then lifts the pointer. - When the user presses down the button and then moves the pointer outside of the button area. - When the user sets off a Button : Long Press trigger.

No

Yes

Button: Long Press

Occurs when the user presses down a Button and holds the Button pressed for the amount of milliseconds defined in the Hold Interval property of that Button.

No

Yes

Click

Occurs when the user presses and releases a hit-testable node with a Click Manipulator, while the pointer is still within the node area and Kanzi does not recognize another gesture.

You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.

No

Yes

Click Begin

Occurs when the user presses a hit-testable node with a Click Manipulator.

You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.

No

Yes

Click Cancel

Occurs when the user first presses a hit-testable node with a Click Manipulator, then moves the pointer outside of the node area, and lifts the pointer.

You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.

No

Yes

Click Enter

Occurs when the user presses a hit-testable node with a Click Manipulator and then every time the user moves the pointer on top of that node while still holding down the pointer.

You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.

No

Yes

Click Leave

Occurs when the user presses a hit-testable node with a Click Manipulator and then every time the user moves the pointer outside of that node.

You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.

No

Yes

Command

Command message arguments

No

Yes

Composition Text Changed

Occurs when the text produced in an Input Method Editor is updated in a Text Box node.

No

Yes

Composition Text Committed

Occurs: - When the text produced in an Input Method Editor is committed to the cached text in a Text Box node. - When a trigger executes the Commit Composition Text action.

No

Yes

Cursor Moved

Occurs when the user moves the cursor in a Text Box node.

No

Yes

Data Trigger

Monitors changes in properties and data source values. Use a Data Trigger to apply an action to either set a property value of a target node or activate an Activity node.

No

Yes

Drag and Drop Canceled

Occurs when focus moves away from the node during the drag-and-drop gesture.

No

Yes

Drag and Drop Finished

Occurs when the user lifts their finger after starting the drag-and-drop gesture.

No

Yes

Drag and Drop Moved

Occurs when the user moves their finger after starting the drag-and-drop gesture.

No

Yes

Drag and Drop Started

Occurs when the user holds their finger for 500ms on the node.

No

Yes

Easing Interpolation Completed

Occurs when Property Target Easing Interpolator completes its interpolation.

No

Yes

Editing Finished

Occurs when a Text Box node leaves the editing state after the user modified the text content.

No

Yes

Editing Started

Occurs when the user makes the first modification to the text in a Text Box node that is in the editing state.

No

Yes

Entered Editing State

Occurs when a Text Box node enters the editing state.

No

Yes

Entered State

Occurs when a state manager has entered a state.

No

Yes

Focus Entered Focus Scope

When focus enters a focus scope, Kanzi sends this message to the focus scope node that contains the node that gains focus.

No

Yes

Focus Gained

Kanzi sends this message to the node that received focus.

No

Yes

Focus Left Focus Scope

When focus leaves a focus scope, Kanzi sends this message to the focus scope node that contains the node that loses focus.

No

Yes

Focus Lost

Kanzi sends this message to the node that lost focus.

No

Yes

Input Method Action

Occurs when the user taps the action button on their on-screen keyboard while editing the text in a Text Box node.

No

Yes

Input Method Available

Occurs when an input method becomes available to a Text Box node. For example, an on-screen keyboard becomes available when it appears on the screen.

No

Yes

Input Method Unavailable

Occurs when the input method that is composing text in a Text Box node becomes unavailable. For example, an on-screen keyboard becomes unavailable when the user hides it.

No

Yes

Input Outside Overlay

Kanzi sends this message to an overlay focus scope when the application area outside the boundaries of that overlay receives input.

No

Yes

Intermediate Click

Occurs when the user presses and releases a hit-testable node with a Multi-Click Manipulator that is set to send messages for intermediate clicks.

To set a Multi-Click Manipulator to send messages for intermediate clicks, in the Multi-Click Manipulator enable the Send Intermediate Click Messages property.

You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.

No

Yes

Interpolation Completed

Occurs when property target interpolator completes interpolation.

No

Yes

Key Canceled

Occurs when Kanzi recognizes a key-canceled gesture. A key-canceled gesture occurs when Kanzi recognizes that the user canceled a gesture.

No

Yes

Key Navigation Canceled

Occurs when the key-pressed gesture is canceled for the navigation direction.

No

Yes

Key Navigation Finished

Occurs when Kanzi recognizes the key-released gesture for the navigation direction. To capture key navigation gestures for a node, create a Navigation Manipulator component in that node.

No

Yes

Key Navigation Started

Occurs when Kanzi recognizes the key-pressed and key repeat gestures for the navigation direction. To capture key navigation gestures for a node, create a Navigation Manipulator component in that node.

No

Yes

Key Pressed

Occurs when Kanzi recognizes a key-pressed gesture. A key-pressed gesture occurs when Kanzi recognizes a key event that contains all the elements that compose that gesture.

No

Yes

Key Released

Occurs when Kanzi recognizes a key-released gesture. A key-released gesture occurs when Kanzi recognizes the release of one of the elements that compose that gesture.

No

Yes

Left Editing State

Occurs when a Text Box node leaves the editing state

No

Yes

Left State

Occurs when a state manager has left a state.

No

Yes

List Box: Item Hidden

Occurs when an item is unloaded from the working memory. To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property.

No

Yes

List Box: Item Selected

Occurs when an item is selected.

No

Yes

List Box: Item Visible

Occurs when an item is loaded to the working memory. To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property.

No

Yes

List Box: Scroll Finished

Occurs when the List Box stops scrolling.

No

Yes

List Box: Scroll Started

Occurs when the List Box starts to scroll.

No

Yes

List Box: Scrolled

Occurs when the List Box scrolls.

No

Yes

List Box: Target Changed

Occurs when List Box gets a new target item.

No

Yes

List Box: User Scroll Finished

Occurs when the application user stops scrolling the List Box.

No

Yes

List Box: User Scroll Started

Occurs when the application user starts to scroll the List Box.

No

Yes

Long Press

Occurs when the user presses a hit-testable node with a Long-Press Manipulator and holds the press for the time that you set in the Long-Press Manipulator.

You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.

No

Yes

Long Press Cancel

Occurs during the long-press gesture when the user moves the focus away from a hit-testable node with a Long-Press Manipulator.

You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.

No

Yes

Message Trigger

No

Yes

Multi-Click

Occurs when the user presses and releases a hit-testable node with a Multi-Click Manipulator a specified number of times (default 2) within a set amount of time (default 250 ms) between presses.

You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.

No

Yes

Multi-Click Canceled

Occurs during the multi-click gesture when the user moves the focus away from a hit-testable node with a Multi-Click Manipulator.

You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.

No

Yes

On Attached

This trigger is set off when the item is initialized. For example, when you add a node to the node tree, or enter a state that contains this trigger.

No

Yes

On Property Change

Occurs when a property is changed

No

Yes

On Timer

Occurs when timer interval is elapsed

No

Yes

Overlay Brought To Front

Occurs when an overlay focus scope becomes the foremost overlay scope in the overlay focus scope stack.

No

Yes

Overlay Gained Focus

When an overlay scope gains focus, Kanzi sends this message to the overlay scope node that contains the node that gains focus.

No

Yes

Overlay Lost Focus

When an overlay scope loses focus, Kanzi sends this message to the overlay scope node that contains the node that loses focus.

No

Yes

Overlay Sent To Back

Occurs when an overlay focus scope is no longer the foremost overlay scope in the overlay focus scope stack.

No

Yes

Page Activated

Page has been activated.

No

Yes

Page Deactivated

Page has been deactivated.

No

Yes

Page Navigation Finished

Page host has finished navigation process.

No

Yes

Page Navigation Started

Page host has started navigation process.

No

Yes

Pan Canceled

Occurs when focus moves away from the node during the pan gesture.

No

Yes

Pan Entered

Occurs when the pan gesture enters the node the manipulator is attached to.

No

Yes

Pan Finished

Occurs when the user lifts their finger after Kanzi recognizes a pan gesture.

No

Yes

Pan Left

Occurs when the pan gesture leaves the node the manipulator is attached to.

No

Yes

Pan Moved

Occurs when the user changes the position of their finger and that change exceeds the recognition thresholds.

No

Yes

Pan Started

Occurs when the user presses down their finger on the node. If the user lifts their finger before exceeding the position change threshold, Kanzi cancels the pan gesture.

No

Yes

Pinch Canceled

Occurs when focus moves away from the node during the pinch gesture.

No

Yes

Pinch Finished

Occurs when the user lifts their finger after Kanzi recognizes a pinch gesture.

No

Yes

Pinch Moved

Occurs when the user changes the position of their finger and that change exceed the scale or rotation threshold.

No

Yes

Pinch Started

Occurs when the user presses down their finger. If the user lifts their finger before it exceeds the scale or rotate threshold, Kanzi cancels the pinch.

No

Yes

Range Concept: Value Change Finished

Occurs when the range value stops changing.

No

Yes

Range Concept: Value Change Started

Occurs when the range value starts changing.

No

Yes

Range Concept: Value Changed

Occurs when the range value has changed.

No

Yes

Scope Brought To Front (deprecated)

Occurs when an overlay focus scope is brought to front. Deprecated. Use Overlay Brought To Front instead.

No

Yes

Scope Sent To Back (deprecated)

Occurs when a foremost overlay focus scope is sent to back. Deprecated. Use Overlay Sent to Back instead.

No

Yes

Scroll Ended

Occurs when the scroll position of a Scroll View node stops changing.

No

Yes

Scroll Started

Occurs when the scroll position of a Scroll View node starts changing.

No

Yes

Scroll Zoomed

Occurs when the zoom level of a Scroll View node changes.

No

Yes

Scrolled

Occurs when the scroll position of a Scroll View node changes.

No

Yes

Selection Changed

Occurs when the user changes the text selection in a Text Box node.

No

Yes

Selection Cleared

Occurs when the user clears or resets the text selection in a Text Box node.

No

Yes

Selection Started

Occurs when the user starts selecting text in a Text Box node.

No

Yes

Snap Request

Occurs when a Scroll View node requests snapping target from the hosting component.

No

Yes

Text Changed

Occurs when the user changes the text in a Text Box node.

No

Yes

Text Composition Canceled

Occurs: - When the text composition in a Text Box node is canceled by Input Method that is in text composition state. - When a trigger executes the Cancel Text Composition action.

No

Yes

Toggle Button Group: Toggled

Occurs when the toggle state of a Toggle Button node in a Toggle Button Group node changes.

No

Yes

Toggle Button: State Toggled

Occurs when the toggle state of the Button changes.

No

Yes

Toggle Button: Toggled Off

Occurs when the Button is toggled off.

No

Yes

Toggle Button: Toggled On

Occurs when the Button is toggled on.

No

Yes

Transition Finished

Occurs when a state manager finishes a transition to a state.

No

Yes

Transition Started

Occurs when a state manager begins a transition to a state.

No

Yes

User Scroll Ended

Occurs when the user stops scrolling a Scroll View node.

No

Yes

User Scroll Started

Occurs when the user starts scrolling a Scroll View node.

No

Yes