Table of Contents

Namespace MLEM.Ui

Classes

RootElement

A root element is a wrapper around an Element that contains additional data. Root elements are only used for the element in each element tree that doesn't have a Parent To create a new root element, use Add(string, Element)

UiAnimation

A ui animation is a simple timed event that an Element in a UiSystem can use to play a visual or other type of animation. Ui animations use StepAnimator<TObject> as their underlying animation player. To use ui animations, you can use PlayAnimation(UiAnimation), or one of the built-in style properties like MouseEnterAnimation or MouseExitAnimation.

UiControls

UiControls holds and manages all of the controls for a UiSystem. UiControls supports keyboard, mouse, gamepad and touch input using an underlying InputHandler.

UiLayouter

Generic tools and utilities for layouting ILayoutItem objects for automatic positioning and sizing. For the recommended ui system implementation that uses this layouter, see UiSystem and specifically Element.

UiSystem

A ui system is the central location for the updating and rendering of all ui Elements. Each element added to the root of the ui system is assigned a RootElement that has additional data like a transformation matrix. For more information on how ui systems work, check out https://mlem.ellpeck.de/articles/ui.html.

Structs

UiMetrics

A snapshot of update and rendering statistics from Metrics to be used for runtime debugging and profiling.

Interfaces

ILayoutItem

A layout item is an object that can be layouted automatically using UiLayouter. The layoug item system is used by the UiSystem, specifically the Element class.

Enums

Anchor

Represents a location for an Element to attach to within its parent (or within the screen's viewport if it is the RootElement).

UiControls.NavigationType

An enumeration type that represents the possible types of navigation that a UiControls instance supports. This is used by NavType, which stores the most recently used navigation type for a UiSystem.

Delegates

UiSystem.RootCallback

A delegate used for callbacks that involve a RootElement