Namespace Yaui

Classes

YauiButton

A selectable that invokes Yaui.YauiButton.OnClick when clicked or submitted.

YauiCustomDraw

Draws meshes of its own in the draw order of the element on the same GameObject, like a ParticleSystem (Yaui.YauiParticle). Each mesh is a draw call of its own; the primitives around it split.

YauiDrawList

The meshes a Yaui.YauiCustomDraw draws in a frame, in order.

A selectable that picks one of its options from a list, like uGUI's Dropdown. The list is a copy of Yaui.YauiDropdown.Template (an inactive element, typically a scroll view) shown on top of the panel below the dropdown, with a copy of the template's item (the toggle around Yaui.YauiDropdown.ItemText) for each option. Presses outside the list close it.

YauiDropdown.DropdownEvent

YauiDropdown.OptionData

YauiElement

A node of the UI: a flex layout box with a background, border and shadow, that can be transformed. The GameObject's Transform is ignored except for the hierarchy; its children with a Yaui.YauiElement are laid out inside this box and drawn on top of it in sibling order.

YauiImage

An element that draws a sprite over its content box (inside the padding and border), on top of its box. The corner radii of the box also round a simple image.

YauiInputField

An editable text: a selectable that shows its text in a Yaui.YauiText, with a caret and a selection, keyboard editing (with the clipboard), IME composition and the on-screen keyboard of mobile platforms. Selecting it starts editing; Enter (single line), Escape or deselecting ends it.

YauiInputField.InputEvent

YauiMask

Masks the descendants of this element to its shape: the box with its corner radii, or, on a Yaui.YauiImage with a sprite, the sprite's alpha. Masks nest to any depth (up to 255) through the stencil buffer, at the cost of splitting the draw call at the mask's boundaries.

YauiPanel

The root of a YAUI tree. Draws its Yaui.YauiElement and the elements below it as a screen space overlay, sized like uGUI's CanvasScaler (scale with screen size).

YauiParticle

Draws the ParticleSystems on this GameObject and its descendants (up to other elements) in the draw order of the element, like ParticleEffectForUGUI does for uGUI. The particles are baked into meshes every frame; their renderers are disabled while this is enabled.

YauiRawImage

An element that draws any texture (a render texture, a video, a texture without a sprite) over its content box, on top of its box. The corner radii of the box also round the image. Textures are never atlased: each one takes a texture slot of the draw.

YauiRaycaster

Plugs a Yaui.YauiPanel into the EventSystem (and so the Input System UI Input Module), like uGUI's GraphicRaycaster. Events go to the GameObject of the topmost hit element and bubble up the hierarchy.

YauiScrollbar

A selectable with a handle whose size is a fraction of its track (the visible part of a scrolled content) and whose position is a value from 0 to 1. Dragging the handle moves it; pressing the track pages toward the pointer. The handle is positioned absolutely in its parent (the track) by the scrollbar.

YauiScrollbar.ScrollEvent

YauiScrollView

Scrolls a content element inside a viewport element by dragging, the scroll wheel and scrollbars, like uGUI's ScrollRect. The content moves by its render transform (Yaui.YauiElement.Translate, driven by the scroll view), so scrolling never lays out again. The content keeps its own layout: typically the viewport clips its children, and the content is its absolutely positioned child at the top-left, as wide as the viewport for vertical scrolling, and as tall as its children.

YauiScrollView.ScrollViewEvent

YauiSelectable

The base of controls: tracks the pointer and the EventSystem's selection, shows the state with a transition on a target element (like uGUI's Selectable), and moves the selection with the navigation events (gamepad, keyboard). Sits next to a Yaui.YauiElement; events on child elements bubble up to it.

YauiSlider

A selectable that picks a value in a range by dragging along a track, or with the navigation keys along its direction. The fill and the handle are positioned absolutely in their parents (the tracks) by the slider: the fill from the start to the value, the handle centered on the value.

YauiSlider.SliderEvent

YauiText

A text element, generated by the Advanced Text Generator (shaping, OS font fallback, line breaking rules and rich text) and drawn as SDF glyphs by the uber shader. Its size is measured by the layout unless set. Child elements are ignored.

YauiTextureAtlas

Settings of the dynamic atlas, which packs small sprites into shared textures so that more images are drawn in one draw call (like UI Toolkit's dynamic atlas). Changes apply to sprites added afterwards.

YauiToggle

A selectable that switches on and off when clicked or submitted, showing Yaui.YauiToggle.Graphic (through its opacity) while on. Toggles of a Yaui.YauiToggleGroup are exclusive.

YauiToggle.ToggleEvent

YauiToggleGroup

Makes its toggles exclusive: switching one on switches the others off (radio buttons).

Structs

BoxStyle

The look of the element's box. Drawn by the uber shader without breaking the batch.

Edges

LayoutStyle

Properties that affect the layout. Changing them re-runs the layout of the panel.

Length

SelectableNavigation

TransformStyle

A 2D transform applied after the layout, without re-running it (CSS transform). Applies to the descendants too.

TransitionColors

TransitionSprites

The sprites of the states besides normal (the target image's own sprite). Null keeps the own sprite.

TransitionTriggers

YauiPrimitive

A quad drawn by the uber shader in the draw call of the elements around it: the content of an element that derives from Yaui.YauiElement (Yaui.YauiElement.SetContent(System.ReadOnlySpan%7bYaui.YauiPrimitive%7d)). Built by the static methods; the With* methods return a modified copy.

YauiSpriteTexture

A sprite as drawn: small sprites are packed into a shared dynamic atlas, the others use their own texture. Every acquisition needs a Yaui.YauiSpriteTexture.Release(), like Yaui.YauiTexture.

YauiTexture

A texture registered for Yaui.YauiPrimitives. Reference counted: every acquisition needs a Yaui.YauiTexture.Release(), after which the value must not be used. Invalid after the stores shut down (domain reload), where releasing does nothing.

Classes​

Structs​

Enums​

Classes

Structs

Enums