Image File¶
Image File properties¶
Name |
Description |
Inherited |
Exported to Kanzi Engine |
|---|---|---|---|
Target Format |
The format of the image in the exported kzb file. |
No |
No |
ATC Compression Scheme |
The compression scheme of ATC compression |
No |
No |
PVRTC Bit Depth |
The amount of bits to use to encode each pixel. |
No |
No |
PVRTC Encoding Quality |
The quality level to use when compressing the image. |
No |
No |
PVRTC Compression Scheme |
The compression scheme to use. |
No |
No |
ASTC Block Size |
The block size in pixels when compressing the image. The less pixels in the block, the better the quality of the compressed image and the bigger the file size. |
No |
No |
ASTC Compression Speed |
The compression speed when compressing the image. Use faster compression for fast and good results and slower compression for better quality. |
No |
No |
Color Format in Raw |
The color format of the image in the kzb file when using the raw target format. |
No |
No |
PNG Compression Level |
Affects how PNG images are compressed when exported to kzb |
No |
No |
sRGB Content |
Whether to use the sRGB color space for the image format. |
No |
No |
Ignore Embedded Color Profile |
Whether to ignore color conversions for this image. When you enable this property, Kanzi Studio removes the ICC profile from the image file and does not perform gamma correction. |
No |
No |
Premultiply Alpha |
Whether to premultiply the alpha channel into color channels in images that have an alpha channel. If you want to control the value of this property in the Project > Properties with the Premultiply Alpha property, select Project default. |
No |
No |
Linear Premultiply |
Premultiply the alpha channel in a linear color space. For sRGB images, using a linear color space for premultiplication results in the fewest artifacts. If source image was created for legacy mode, disabling this option may give better results. |
No |
No |
Effort |
Quality of the ETC2 compression, 100 for the highest quality. |
No |
No |
Generate Mipmaps |
Whether or not to generate mipmaps. If the image has mipmaps inside, those will take precedence over generated ones. |
No |
No |
Use Original Image |
Whether or not to use original image in images folder directly instead of compressing it when exporting kzb. Note that use of the original image is not always possible. |
No |
No |
Export Behavior |
Whether to export the image always or only when it is used by other assets in the Kanzi Studio project. Set this as "Export Always" when the image is used by the application code. |
No |
No |
Export Empty When File Is Missing |
Whether to export empty or default image when file is missing. |
No |
No |
Image |
A thumbnail preview of the selected image (Read-only) |
No |
No |
Size |
The size of the image on disk in pixels (Read-only) |
No |
No |
Bit Depth |
The bit depth of the image on disk (Read-only) |
No |
No |
Contains Transparency |
Whether the image contains transparency. (Read-only) |
No |
No |
Contains ICC Profile |
Whether the image contains the ICC profile. If the image contains an invalid ICC profile, in the Project > Properties enable the Remove ICC Profiles of PNG Images property to remove the ICC profiles from the PNG images during kzb file export. (Read-only) |
No |
No |
Image File available properties¶
Name |
Description |
Inherited |
Exported to Kanzi Engine |
|---|---|---|---|
Clamp Pixels |
Clamp the color channel maximum to the value. For SDR images the effective range is 0 to 1, and for HDR images any non-negative value. If one color channel needs to be clamped, then all other color channels are scaled down by the same ratio. |
No |
No |
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 |
Is Used by Code |
Whether or not the application code uses this asset. Used for determining unused assets. |
No |
No |
Native Pixel Format |
Sets the native image format to use when exporting this image to the kzb file. Make sure that the graphics backend of your target device supports the format. |
No |
No |
Image File 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 |