Module prelude 

The UI prelude.

This includes the most common types in this crate, re-exported for your convenience.

Structs

AngularColorStop

An angular color stop for a conic gradient

BackgroundColor

The background color of the node

BackgroundGradient

A UI node that displays a gradient

BorderColor

The border color of the UI node.

BorderGradient

A UI node border that displays a gradient

BorderRadius

Used to add rounded corners to a UI node. You can set a UI node to have uniformly rounded corners or specify different radii for each corner. If a given radius exceeds half the length of the smallest dimension between the node’s height or width, the radius will calculated as half the smallest dimension.

BorderRect

Defines the extents of the border of a rectangle.

BoxShadow

List of shadows to draw for a Node.

Button

Marker struct for buttons

CalculatedClip

The calculated clip of the node

ColorStop

A color stop for a gradient

ComputedNode

Provides the computed size and layout properties of the node.

ComputedUiRenderTargetInfo

Derived information about the render target for this UI node.

ComputedUiTargetCamera

Derived information about the camera target for this UI node.

ConicGradient

A conic gradient

DefaultUiCamera

GlobalZIndex

GlobalZIndex allows a Node entity anywhere in the UI hierarchy to escape the implicit draw ordering of the UI’s layout tree and be rendered above or below other UI nodes. Nodes with a GlobalZIndex of greater than 0 will be drawn on top of nodes without a GlobalZIndex or nodes with a lower GlobalZIndex. Nodes with a GlobalZIndex of less than 0 will be drawn below nodes without a GlobalZIndex or nodes with a greater GlobalZIndex.

GridPlacement

Represents the position of a grid item in a single axis.

GridTrack

A GridTrack is a Row or Column of a CSS Grid. This struct specifies what size the track should be. See below for the different “track sizing functions” you can specify.

ImageNode

A UI Node that renders an image.

IsDefaultUiCamera

Marker used to identify default cameras, they will have priority over the PrimaryWindow camera.

Label

Marker struct for labels

LayoutConfig

This component can be added to any UI node to modify its layout behavior.

LinearGradient

A linear gradient

Node

The base component for UI entities. It describes UI layout and style properties.

Outline

The Outline component adds an outline outside the edge of a UI node. Outlines do not take up space in the layout.

Overflow

Whether to show or hide overflowing items

OverflowClipMargin

The bounds of the visible area when a UI node is clipped.

OverrideClip

UI node entities with this component will ignore any clipping rect they inherit, the node will not be clipped regardless of its ancestors’ Overflow setting.

RadialGradient

A radial gradient

RepeatedGridTrack

Represents a possibly repeated GridTrack.

ResolvedBorderRadius

Represents the resolved border radius values for a UI node.

ScrollPosition

The scroll position of the node. Values are in logical pixels, increasing from top-left to bottom-right.

ShadowStyle

Text

The top-level UI text component.

TextBackgroundColor

The background color of the text for this section.

TextShadow

Adds a shadow behind text

TextureSlicer

Slices a texture using the 9-slicing technique. This allows to reuse an image at various sizes without needing to prepare multiple assets. The associated texture will be split into nine portions, so that on resize the different portions scale or tile in different ways to keep the texture in proportion.

UiGlobalTransform

Absolute 2D transform for UI nodes

UiPosition

Responsive position relative to a UI node.

UiRect

A type which is commonly used to define margins, paddings and borders.

UiScale

The current scale of the UI.

UiTargetCamera

Indicates that this root Node entity should be rendered to a specific camera.

UiTransform

Relative 2D transform for UI nodes

Val2

A pair of Vals used to represent a 2-dimensional size or offset.

ViewportNode

Component used to render a Camera::target to a node.

ZIndex

Indicates that this Node entity’s front-to-back ordering is not controlled solely by its location in the UI hierarchy. A node with a higher z-index will appear on top of sibling nodes with a lower z-index.

Enums

AlignContent

Used to control how items are distributed.

AlignItems

Used to control how each individual item is aligned by default within the space they’re given.

AlignSelf

Used to control how the specified item is aligned within the space it’s given.

BoxSizing

Which part of a Node’s box length styles like width and height control

Display

Defines the layout model used by this node.

FlexDirection

Defines how flexbox items are ordered within a flexbox

FlexWrap

Defines if flexbox items appear on a single line or on multiple lines

Gradient

GridAutoFlow

Controls whether grid items are placed row-wise or column-wise as well as whether the sparse or dense packing algorithm is used.

GridPlacementError

Errors that occur when setting constraints for a GridPlacement

GridTrackRepetition

How many times to repeat a repeated grid track

Interaction

Describes what type of input interaction has occurred for a UI node.

InterpolationColorSpace

The color space used for interpolation.

JustifyContent

Used to control how items are distributed.

JustifyItems

Used to control how each individual item is aligned by default within the space they’re given.

JustifySelf

Used to control how the specified item is aligned within the space it’s given.

MaxTrackSizingFunction

MinTrackSizingFunction

NodeImageMode

Controls how the image is altered to fit within the layout and how the layout algorithm determines the space in the layout for the image

OverflowAxis

Whether to show or hide overflowing items

OverflowClipBox

Used to determine the bounds of the visible area when a UI node is clipped.

PositionType

The strategy used to position this node

RadialGradientShape

SliceScaleMode

Defines how a texture slice scales when resized

SpriteImageMode

Controls how the image is altered when scaled.

Val

Represents the possible value types for layout properties.

ValArithmeticError

ValParseError

Traits

InColorSpace

Set the color space used for interpolation.

ValNum

All the types that should be able to be used in the Val enum should implement this trait.

Functions

auto

Returns a Val::Auto where the value is automatically determined based on the context and other Node properties.

percent

Returns a Val::Percent representing a percentage of the parent node’s length along a specific axis.

px

Returns a Val::Px representing a value in logical pixels.

vh

Returns a Val::Vh representing a percentage of the viewport height.

vmax

Returns a Val::VMax representing a percentage of the viewport’s larger dimension.

vmin

Returns a Val::VMin representing a percentage of the viewport’s smaller dimension.

vw

Returns a Val::Vw representing a percentage of the viewport width.

Type Aliases

TextUiReader

UI alias for TextReader.

TextUiWriter

UI alias for TextWriter.