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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
# bevy_headless_render
[](https://crates.io/crates/bevy_headless_render)
[](https://exvacuum.github.io/bevy_headless_render)
A plugin for the [Bevy](https://bevyengine.org) engine which allows for headless rendering.
Every frame will be copied from `HeadlessRenderSource` render textures into `HeadlessRenderDestination` images each frame.
## Compatibility
| Crate Version | Bevy Version |
|--- |--- |
| 0.1 | 0.14 |
| 0.2 | 0.15 |
## Installation
### crates.io
```toml
[dependencies]
bevy_headless_render = "0.2"
```
### Using git URL in Cargo.toml
```toml
[dependencies.bevy_headless_render]
git = "https://git.exvacuum.dev/bevy_headless_render"
```
## Usage
In `main.rs`:
```rs
use bevy::prelude::*;
use bevy_headless_render;
fn main() {
App::new()
.add_plugins((
DefaultPlugins
bevy_headless_render::HeadlessRenderPlugin,
))
.run();
}
```
When spawning a camera:
```rs
let size = Extent3d {
width: 640,
height: 480,
depth_or_array_layers: 1,
};
let mut image = Image {
texture_descriptor: TextureDescriptor {
label: None,
size,
dimension: TextureDimension::D2,
format: TextureFormat::Rgba8UnormSrgb,
mip_level_count: 1,
sample_count: 1,
usage: TextureUsages::TEXTURE_BINDING
| TextureUsages::COPY_SRC
| TextureUsages::RENDER_ATTACHMENT,
view_formats: &[],
},
..default()
};
image.resize(size);
let image_handle = asset_server.add(image);
commands.spawn((
HeadlessRenderSource::new(&asset_server, image_handle.clone()),
Camera3d::default(),
Camera {
target: image_handle.into(),
..Default::default()
},
));
```
The HeadlessRenderDestination component will contain the extracted image which can be used or saved for whatever you need.
## License
This crate is licensed under your choice of 0BSD, Apache-2.0, or MIT license.
|
