aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Silas Bartha <[email protected]>2024-07-24 11:46:40 -0400
committerLibravatar Silas Bartha <[email protected]>2024-07-24 11:47:21 -0400
commitd7e1903369330c5438892c5ddfdbc7c1ef179633 (patch)
tree1913fc25e8d35e8743ea432ec80390f0f23538b2 /README.md
parent52005369648e06cb2e1b36bb5dd7c19445aa4ee4 (diff)
Renamed + Updated to Bevy 0.14 + Added 0BSD Option
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 27 insertions, 15 deletions
diff --git a/README.md b/README.md
index ad6f12b..9de9ea9 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,33 @@
-# bevy_framebuffer_extract
+# bevy_headless_render
+[![Crates](https://img.shields.io/crates/v/bevy_headless_render)](https://crates.io/crates/bevy_headless_render)
![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)
-![Tag](https://img.shields.io/github/v/tag/exvacuum/bevy_framebuffer_extract)
-![Build](https://img.shields.io/github/actions/workflow/status/exvacuum/bevy_framebuffer_extract/rust.yml)
-[![Docs](https://img.shields.io/website?url=https%3A%2F%2Fexvacuum.github.io%2Fbevy_framebuffer_extract%2F&label=docs)](https://exvacuum.github.io/bevy_framebuffer_extract)
+![Tag](https://img.shields.io/github/v/tag/exvacuum/bevy_headless_render)
+![Build](https://img.shields.io/github/actions/workflow/status/exvacuum/bevy_headless_render/rust.yml)
+[![Docs](https://img.shields.io/website?url=https%3A%2F%2Fexvacuum.github.io%2Fbevy_headless_render%2F&label=docs)](https://exvacuum.github.io/bevy_headless_render)
-A plugin for the [Bevy](https://bevyengine.org) engine which allows for exporting framebuffer data from a camera.
+A plugin for the [Bevy](https://bevyengine.org) engine which allows for headless rendering.
-Currently it only supports cameras which render to a render texture.
+Every frame will be copied from `HeadlessRenderSource` render textures into `HeadlessRenderDestination` images each frame.
## Compatibility
| Crate Version | Bevy Version |
|--- |--- |
-| 0.1 | 0.13 |
+| 0.1 | 0.14 |
## Installation
+### crates.io
+```toml
+[dependencies]
+bevy_headless_render = "0.2"
+```
+
### Using git URL in Cargo.toml
```toml
-[dependencies.bevy_framebuffer_extract]
-git = "https://github.com/exvacuum/bevy_framebuffer_extract.git"
+[dependencies.bevy_headless_render]
+git = "https://github.com/exvacuum/bevy_headless_render.git"
```
## Usage
@@ -28,13 +35,13 @@ git = "https://github.com/exvacuum/bevy_framebuffer_extract.git"
In `main.rs`:
```rs
use bevy::prelude::*;
-use bevy_framebuffer_extract;
+use bevy_headless_render;
fn main() {
App::new()
.add_plugins((
DefaultPlugins,
- bevy_framebuffer_extract::FramebufferExtractPlugin,
+ bevy_headless_render::HeadlessRenderPlugin,
))
.run();
}
@@ -76,11 +83,16 @@ commands.spawn((
},
..Default::default()
},
- bevy_framebuffer_extract::ExtractFramebufferBundle {
- source: framebuffer_extract_sources.add(FramebufferExtractSource(image_handle.clone())), // ResMut<Assets<FramebufferExtractSource>>
- destination: FramebufferExtractDestination::default(),
+ bevy_headless_render::HeadlessRenderBundle {
+ source: headless_render_sources.add(HeadlessRenderSource(image_handle.clone())), // ResMut<Assets<HeadlessRenderSource>>
+ destination: HeadlessRenderDestination::default(),
},
));
```
-The FramebufferExtractDestination component will contain the extracted image which can be used or saved for whatever you need.
+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.
+