bevy_world_space_ui 0.19.0

Make building world space UIs easier in Bevy game engine.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

# `bevy_world_space_ui`

[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/Katsutoshii/bevy_world_space_ui#license)
[![Crates.io](https://img.shields.io/crates/v/bevy_world_space_ui.svg)](https://crates.io/crates/bevy_world_space_ui)
[![Docs](https://docs.rs/bevy_world_space_ui/badge.svg)](https://docs.rs/bevy_world_space_ui/latest/bevy_world_space_ui/)

Make building world space UIs easier in Bevy game engine.

Based on the official example [render-ui-to-texture](https://bevy.org/examples/ui-user-interface/render-ui-to-texture/).

## Usage

```rs
use bevy_world_space_ui::{WorldSpaceUiPlugin, WorldSpaceUiRoot, WorldSpaceUiSurface};

// Generate your own pointer ID.
const WORLD_SPACE_UI_POINTER: PointerId = PointerId::Custom(Uuid::from_u128(123));

fn main() {
    App::new()
        .add_plugins((DefaultPlugins, WorldSpaceUiPlugin))
        .add_systems(Startup, setup)
        .run();
}

fn setup(
    mut commands: Commands,
    mut meshes: ResMut<Assets<Mesh>>,
    mut images: ResMut<Assets<Image>>,
) {
    // Create the texture to be rendered to.
    let resolution = Extent3d {
        width: 512,
        height: 512,
        ..default()
    };
    let image_handle = images.add(WorldSpaceUiRoot::get_ui_texture(resolution));

    // Spawn your UI with `WorldSpaceUiRoot`.
    let root = commands
        .spawn((
            WorldSpaceUiRoot {
                texture: image_handle.clone(),
            },
            // Spawn your UI tree...
        ))
        .id();

    // Spawn a quad to render the UI on.
    commands.spawn((
        Mesh3d(meshes.add(Rectangle::default())),
        WorldSpaceUiSurface {
            root,
            texture: image_handle.clone(),
            pointer_id: WORLD_SPACE_UI_POINTER,
            ..default()
        },
        Transform::from_xyz(0.0, 0.0, 1.5).with_rotation(Quat::from_axis_angle(Vec3::X, PI / 8.)),
    ));

    // Setup cameras and lights as you normally would.
    // ...
}

```

See `examples` for a working demo.

## Bevy support table

| bevy | bevy_world_space_ui  |
| ---- | -------------------- |
| 0.19 | 0.19.0               |
| 0.18 | 0.18.0               |
| 0.17 | 0.2.0                |
| 0.16 | 0.1.3                |