From 5560d5d092a4849cfe1ce63d85cef57c07ce8d8b Mon Sep 17 00:00:00 2001
From: Silas Bartha <silas@exvacuum.dev>
Date: Mon, 3 Jun 2024 22:00:19 -0400
Subject: Added docs + renamed

---
 src/components.rs | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src/components.rs')

diff --git a/src/components.rs b/src/components.rs
index c1122d0..f9fe912 100644
--- a/src/components.rs
+++ b/src/components.rs
@@ -4,6 +4,7 @@ use bevy::{ecs::query::QueryItem, prelude::*, render::extract_component::Extract
 
 use crate::render_assets::FramebufferExtractSource;
 
+/// Framebuffer extraction destination. Contains the image which the framebuffer is extracted to.
 #[derive(Component, Default, Clone)]
 pub struct FramebufferExtractDestination(pub Arc<Mutex<Image>>);
 
@@ -21,8 +22,11 @@ impl ExtractComponent for FramebufferExtractDestination {
     }
 }
 
+/// Bundle containing both a source and destination for framebuffer extraction.
 #[derive(Bundle)]
 pub struct ExtractFramebufferBundle {
+    /// Source
     pub source: Handle<FramebufferExtractSource>,
+    /// Destination
     pub dest: FramebufferExtractDestination,
 }
-- 
cgit v1.2.3