aboutsummaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
authorLibravatar Silas Bartha <[email protected]>2024-06-03 22:00:19 -0400
committerLibravatar Silas Bartha <[email protected]>2024-06-03 22:00:19 -0400
commit5560d5d092a4849cfe1ce63d85cef57c07ce8d8b (patch)
tree9c3f9f6c72c437b5ef10d4428dfdfbfd6e12c51c /src/lib.rs
parentef6c2954156b2b0cf4abfe583d8faaf546f4e7c4 (diff)
Added docs + renamed
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs11
1 files changed, 10 insertions, 1 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 05f387d..29a5896 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,3 +1,8 @@
+#![warn(missing_docs)]
+
+//! Plugin for the Bevy game engine which provides the ability to extract the frambuffer image after rendering
+//! to use for whatever you want.
+
use bevy::{
prelude::*,
render::{
@@ -9,11 +14,15 @@ use components::FramebufferExtractDestination;
use nodes::{FramebufferExtractLabel, FramebufferExtractNode};
use render_assets::FramebufferExtractSource;
+/// Components used by this plugin.
pub mod components;
-mod nodes;
+/// Render assets used by this plugin.
pub mod render_assets;
+
+mod nodes;
mod systems;
+/// Plugin which handles framebuffer extraction.
pub struct FramebufferExtractPlugin;
impl Plugin for FramebufferExtractPlugin {