Expand description
Provides rendering functionality for bevy_ui.
Modules§
- box_
shadow - Box shadows rendering
- graph
- prelude
- shader_
flags - The values here should match the values for the constants in
ui.wgsl - stack_
z_ offsets - Local Z offsets of “extracted nodes” for a given entity. These exist to allow rendering multiple “extracted nodes” for a given source entity (ex: render both a background color and a custom material for a given node).
- ui_
material - ui_
texture_ slice_ pipeline
Structs§
- BoxShadow
Samples - Number of shadow samples. A larger value will result in higher quality shadows. Default is 4, values higher than ~10 offer diminishing returns.
- Draw
UiMaterial Node - Draw
UiNode - Extracted
Glyph - Extracted
UiMaterial Node - Extracted
UiMaterial Nodes - Extracted
UiNode - Extracted
UiNodes - Image
Node Bind Groups - Prepared
UiMaterial - SetMat
UiView Bind Group - SetUi
Material Bind Group - SetUi
Texture Bind Group - SetUi
View Bind Group - Transparent
Ui - UiBatch
- UiCamera
Map - UiCamera
Mapper - Helper for mapping UI target camera entities to their corresponding render entities, with caching to avoid repeated lookups for the same camera.
- UiCamera
View - A render-world component that lives on the main render target view and specifies the corresponding UI view.
- UiDebug
Options bevy_ui_debug - Configuration for the UI debug overlay
- UiMaterial
Batch - UiMaterial
Meta - UiMaterial
Pipeline - Render pipeline data for a given
UiMaterial - UiMaterial
Plugin - Adds the necessary ECS resources and render logic to enable rendering entities using the given
UiMaterialasset type (which includesUiMaterialtypes). - UiMaterial
Vertex - UiMeta
- UiPass
Node - UiPipeline
- UiPipeline
Key - UiRender
Plugin - UiView
Target - A render-world component that lives on the UI view and specifies the corresponding main render target view.
Enums§
- Extracted
UiItem - Node
Type - The type of UI node. This is used to determine how to render the UI node.
- Render
UiSystems - UiAnti
Alias - Marker for controlling whether UI is rendered with or without anti-aliasing in a camera. By default, UI is always anti-aliased.
Functions§
- extract_
text_ background_ colors - extract_
text_ sections - extract_
text_ shadows - extract_
ui_ camera_ view - Extracts all UI elements associated with a camera into the render world.
- extract_
ui_ material_ nodes - extract_
uinode_ background_ colors - extract_
uinode_ borders - extract_
uinode_ images - extract_
viewport_ nodes - init_
ui_ material_ pipeline - init_
ui_ pipeline - prepare_
uimaterial_ nodes - prepare_
uinodes - queue_
ui_ material_ nodes - queue_
uinodes
Type Aliases§
- DrawUi
- Draw
UiMaterial - Render
UiSystem Deprecated - Deprecated alias for
RenderUiSystems.