Crate amethyst_ui[−][src]
Provides components and systems to create an in game user interface.
Structs
DrawUi |
Draw Ui elements. UI won't display without this. It's recommended this be your last pass. |
FontAsset |
A loaded set of fonts from a file. |
MouseReactive |
A component that tags an entity as reactive to ui events. Will only work if the entity has a UiTransform component attached to it. Without this, the ui element will not generate events. |
OnUiActionImage |
When this component is added to a UI element with a |
OnUiActionSound |
When this component is added to a UI element
it will play sounds based on mouse interaction.
Requires |
ResizeSystem |
This system rearranges UI elements whenever the screen is resized using their |
TextEditing |
If this component is attached to an entity with a UiText then that UiText is editable. This component also controls how that editing works. |
TtfFormat |
Loads font files, supports TrueType and some OpenType files. |
UiBundle |
UI bundle |
UiButton |
A clickable button, this must be paired with a |
UiButtonBuilder |
Convenience structure for building a button |
UiButtonBuilderResources |
Container for all the resources the builder needs to make a new UiButton. |
UiButtonSystem |
This system manages button mouse events. It changes images and text colors, as well as playing audio when necessary. |
UiCreator |
Ui Creator, wrapper around loading and creating a UI directly. |
UiEvent |
A ui event instance. |
UiFinder |
Utility |
UiFocused |
This resource stores the currently focused UI element. |
UiFormat |
Ui format. |
UiImage |
A component with the texture to display in this entity's |
UiImageBuilder |
Loadable |
UiKeyboardSystem |
This system processes the underlying UI data as needed. |
UiLoader |
Specialised UI loader |
UiMouseSystem |
The system that generates events for |
UiResize |
Whenever the window is resized the function in this component will be called on this entity's UiTransform, along with the new width and height of the window. |
UiText |
A component used to display text in this entity's UiTransform |
UiTextBuilder |
Loadable |
UiTransform |
The UiTransform represents the transformation of a ui element. Values are in pixel and the position is calculated from the top left of the screen to the center of the ui element's area. |
UiTransformBuilder |
Loadable |
UiTransformSystem |
Manages the |
Enums
Anchor |
Indicated where the anchor is, relative to the parent (or to the screen, if there is no parent). Follow a normal english Y,X naming. |
FontFormat |
Wrapper format for all core supported Font formats |
ScaleMode |
Indicates if the position and margins should be calculated in pixel or relative to their parent size. |
Stretch |
Indicates if a component should be stretched. |
UiEventType |
The type of ui event. Click happens if you start and stop clicking on the same ui element. |
UiWidget |
Loadable ui components |
Type Definitions
FontHandle |
A handle to font data stored with |
OtfFormat |
Identical to TtfFormat. |
UiLoaderSystem |
Prefab loader system for UI |
UiPrefab |
Ui prefab |