Crate bevy_ui

This crate contains Bevy’s UI system, which can be used to create UI for both 2D and 3D games

Basic usage

Spawn UI elements with node_bundles::ButtonBundle, node_bundles::ImageBundle, node_bundles::TextBundle and node_bundles::NodeBundle This UI is laid out with the Flexbox and CSS Grid layout models (see https://cssreference.io/flexbox/)

Re-exports

• pub use measurement::*;
• pub use ui_material::*;

Modules

• debug
• graph
• measurement
• node_bundles
  This module contains basic node bundles used to build UIs
• ui_material
• update
  This module contains systems that update the UI when something changes
• widget
  This module contains the basic building blocks of Bevy’s UI

Structs

• BackgroundColor
  The background color of the node
• BorderColor
  The border color of the UI node.
• CalculatedClip
  The calculated clip of the node
• DefaultCameraView
• DefaultUiCamera
• DrawUiMaterialNode
• DrawUiNode
• ExtractedUiMaterialNode
• ExtractedUiMaterialNodes
• ExtractedUiMaterials
• ExtractedUiNode
• ExtractedUiNodes
• 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.
• IsDefaultUiCamera
  Marker used to identify default cameras, they will have priority over the PrimaryWindow camera.
• LayoutContext
• Node
  Base component for a UI node, which also provides the computed size of the node.
• NodeQuery
  Main query for ui_focus_system
• NodeQueryItem
  Automatically generated [WorldQuery] item type for NodeQuery, returned when iterating over query results.
• NodeQueryReadOnly
  Automatically generated [WorldQuery] type for a read-only variant of NodeQuery.
• NodeQueryReadOnlyItem
  Automatically generated [WorldQuery] item type for NodeQueryReadOnly, returned when iterating over query results.
• 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
• PrepareNextFrameMaterials
• PreparedUiMaterial
• RelativeCursorPosition
  A component storing the position of the mouse relative to the node, (0., 0.) being the top-left corner and (1., 1.) being the bottom-right If the mouse is not over the node, the value will go beyond the range of (0., 0.) to (1., 1.)
• RenderUiMaterials
• RepeatedGridTrack
  Represents a possibly repeated GridTrack.
• SetMatUiViewBindGroup
• SetUiMaterialBindGroup
• SetUiTextureBindGroup
• SetUiViewBindGroup
• Style
  Describes the style of a UI container node
• TargetCamera
  Indicates that this root Node entity should be rendered to a specific camera. UI then will be layed out respecting the camera’s viewport and scale factor, and rendered to this camera’s bevy_render::camera::RenderTarget.
• TransparentUi
• UiBatch
• UiImage
  The 2D texture displayed for this UI node
• UiImageBindGroups
• UiMaterialBatch
• UiMaterialMeta
• UiMaterialPipeline
  Render pipeline data for a given UiMaterial
• UiMaterialPlugin
  Adds the necessary ECS resources and render logic to enable rendering entities using the given UiMaterial asset type (which includes UiMaterial types).
• UiMaterialVertex
• UiMeta
• UiPassNode
• UiPipeline
• UiPipelineKey
• UiPlugin
  The basic plugin for Bevy UI
• UiRect
  A type which is commonly used to define margins, paddings and borders.
• UiScale
  The current scale of the UI.
• UiStack
  The current UI stack, which contains all UI nodes ordered by their depth (back-to-front).
• UiSurface

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.
• Direction
  Defines the text direction.
• 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
• FocusPolicy
  Describes whether the node should block interactions with lower nodes
• 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.
• 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.
• LayoutError
• MaxTrackSizingFunction
• MinTrackSizingFunction
• OverflowAxis
  Whether to show or hide overflowing items
• PositionType
  The strategy used to position this node
• RenderUiSystem
• UiSystem
  The label enum labeling the types of systems in the Bevy UI
• Val
  Represents the possible value types for layout properties.
• ValArithmeticError
• 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 other nodes with a lower z-index.

Constants

• UI_MATERIAL_SHADER_HANDLE
• UI_SHADER_HANDLE

Functions

• build_ui_render
• extract_default_ui_camera_view
• extract_text_uinodes
• extract_ui_material_nodes
• extract_ui_materials
• extract_uinode_borders
• extract_uinode_outlines
• extract_uinodes
• prepare_ui_materials
• prepare_uimaterial_nodes
• prepare_uinodes
• queue_ui_material_nodes
• queue_uinodes
• resolve_outlines_system
  Resolve and update the widths of Node outlines
• ui_focus_system
  The system that sets Interaction for all UI elements based on the mouse cursor activity
• ui_layout_system
  Updates the UI’s layout tree, computes the new layout geometry and then updates the sizes and transforms of all the UI nodes.

Type Aliases

• DrawUi
• DrawUiMaterial