Sprite Element
Sprite Elements render a single texture (image) in your UI Editor layout. They are perfect for adding icons, logos, images, and any static graphic asset.
When to Use a Sprite Element
- Icons & Buttons
Use sprites for clickable icons, buttons, and other UI controls. - Background Images
Display static backgrounds or decorative elements. - Images
Any image that you want to add to your layout.
Sprite Element Properties
Property | Type | Details |
---|---|---|
Name | text | Name of the element. Make sure the name of the element is unique if the element needs to be accessible from code (Enterprise Plan only). |
Texture | File picker | The texture (image) file path for the element. |
Texture mode | Dropdown | Texture mapping mode. fill will match the image to the element size, stretching the image when necessary. cover will resize the image to cover the entire element while maintaining aspect ratio, cropping the image when necessary. |
Tint | Color picker | Tint color of the element. Use to change the color overlay of the element. Default (white) has no effect on the color. |
Blend mode | .% | Texture blending mode which affects the visual appearance of the element and how it interacts with other layers. |
Mask | checkbox | Enable or disable masking. |
Anchor | .% | Used to position the anchor point of the element (x: 0, y: 0 = top/left, x: 1, y: 1 = bottom/right) |
Parent Align | .% | Position of the element relative to its parent’s position. (x: 0, y: 0 = top/left, x: 1, y: 1 = bottom/right) |
Parent Size | .% | Use to resize the element relative to its parent's size (x: 1, y: 1 = match parent size, x: 0.5, y: 0.5 = half of parent size, x: 0, y: 0 = disables parent relative sizing). |
Content size | .% | Use to set the element's size automatically based on its content. (x: 1, y: 1 = match parent size, x: 1, y: 1 = matches the size of the provided sprite, x: 2, y: 2 = doubles the size of the provided sprite). |
Size | px | Explicitly set pixel size (logical screen units). |
Offset | px | Additional pixel offset from the element's position. |
Transform Properties
Transform properties affect the Element, as well as any child elements nested within the Element.
Property | Type | Notes |
---|---|---|
Pivot | .% | Pivot point for any transformations applied to the element. (x: 0, y: 0 = top/left, x: 0.5, y: 0.5 = center, x: 1, y: 1 = bottom/right). |
Angle | Degrees | Rotate the element around its Pivot point. |
Skew | Degrees | Skew along X/Y axes around the Pivot point. |
Scale | .% | Percentage scale of the element. Setting this value to x: 2, y: 2 scales the element twice as large. |
Alpha | .% | Transparency applied to the element. The default value 1 displays the element fully opaque, while 0.5 would make the element semi-transparent. Setting the value to 0 makes the element completely disappear. |
Modifiers
Modifiers are vital to creating different visual states for your elements in the UI Editor. They allow you to set up visual state changes and transitions using various properties such as size, position, alpha, etc.
Sounds
Sounds are very similar to Modifiers, but instead of creating visual effects, they create sound effects which can be triggered using Events.
Triggers
Triggers allow you to add interactivity to your QSApp by enabling the ability to trigger modifiers and events when the trigger is activated. You can add triggers for actions like clicking, hovering, and dragging elements.