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/render_assets.rs | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

(limited to 'src/render_assets.rs')

diff --git a/src/render_assets.rs b/src/render_assets.rs
index 0e2cd4d..e5277d7 100644
--- a/src/render_assets.rs
+++ b/src/render_assets.rs
@@ -8,15 +8,18 @@ use bevy::{
     },
 };
 
+/// Render-world version of FramebufferExtractSource
 pub struct GpuFramebufferExtractSource {
-    pub buffer: Buffer,
-    pub source_handle: Handle<Image>,
-    pub source_size: Extent3d,
-    pub bytes_per_row: u32,
-    pub padded_bytes_per_row: u32,
-    pub format: TextureFormat,
+    pub(crate) buffer: Buffer,
+    pub(crate) source_handle: Handle<Image>,
+    pub(crate) source_size: Extent3d,
+    pub(crate) bytes_per_row: u32,
+    pub(crate) padded_bytes_per_row: u32,
+    pub(crate) format: TextureFormat,
 }
 
+/// Framebuffer extraction source. Contains a handle to the render texture which will be extracted
+/// from.
 #[derive(Asset, Reflect, Clone, Default)]
 pub struct FramebufferExtractSource(pub Handle<Image>);
 
-- 
cgit v1.2.3