Render Texture Extraction

10 files changed, 496 insertions, 0 deletions

diff --git a/.cargo/config.toml b/.cargo/config.toml
new file mode 100644
index 0000000..6563c2a
--- /dev/null
+++ b/.cargo/config.toml
@@ -0,0 +1,34 @@
+
+# Add the contents of this file to `config.toml` to enable "fast build" configuration. Please read the notes below.
+
+# NOTE: For maximum performance, build using a nightly compiler
+# If you are using rust stable, remove the "-Zshare-generics=y" below.
+
+[target.x86_64-unknown-linux-gnu]
+linker = "clang"
+rustflags = ["-Clink-arg=-fuse-ld=lld", "-Zshare-generics=y"]
+
+# NOTE: you must install [Mach-O LLD Port](https://lld.llvm.org/MachO/index.html) on mac. you can easily do this by installing llvm which includes lld with the "brew" package manager:
+# `brew install llvm`
+[target.x86_64-apple-darwin]
+rustflags = [
+    "-C",
+    "link-arg=-fuse-ld=/usr/local/opt/llvm/bin/ld64.lld",
+    "-Zshare-generics=y",
+]
+
+[target.aarch64-apple-darwin]
+rustflags = [
+    "-C",
+    "link-arg=-fuse-ld=/opt/homebrew/opt/llvm/bin/ld64.lld",
+    "-Zshare-generics=y",
+]
+
+[target.x86_64-pc-windows-msvc]
+linker = "rust-lld.exe"
+rustflags = ["-Zshare-generics=n"]
+
+# Optional: Uncommenting the following improves compile times, but reduces the amount of debug info to 'line number tables only'
+# In most cases the gains are negligible, but if you are on macos and have slow compile times you should see significant gains.
+#[profile.dev]
+#debug = 1
diff --git a/Cargo.toml b/Cargo.toml
new file mode 100644
index 0000000..84d0dba
--- /dev/null
+++ b/Cargo.toml
@@ -0,0 +1,12 @@
+[package]
+name = "grex_framebuffer_extract"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+oneshot = "0.1.6"
+pollster = "0.3.0"
+
+[dependencies.bevy]
+version = "0.13"
+features = ["dynamic_linking"]
diff --git a/LICENSE-APACHE b/LICENSE-APACHE
new file mode 100644
index 0000000..4b73f05
--- /dev/null
+++ b/LICENSE-APACHE
@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Silas Bartha
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
diff --git a/LICENSE-MIT b/LICENSE-MIT
new file mode 100644
index 0000000..372ea6c
--- /dev/null
+++ b/LICENSE-MIT
@@ -0,0 +1,19 @@
+Copyright (c) 2024 Silas Bartha
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/src/components.rs b/src/components.rs
new file mode 100644
index 0000000..3179f0c
--- /dev/null
+++ b/src/components.rs
@@ -0,0 +1,33 @@
+use std::sync::{Mutex, Arc};
+
+use bevy::{prelude::*, render::extract_component::ExtractComponent, ecs::query::QueryItem};
+
+use crate::render_assets::FramebufferExtractSource;
+
+#[derive(Component, Default, Clone)]
+pub struct FramebufferExtractDestination(pub Arc<Mutex<Image>>);
+
+impl ExtractComponent for FramebufferExtractDestination {
+    type QueryData = (
+        &'static Self,
+        &'static Handle<FramebufferExtractSource>,
+    );
+
+    type QueryFilter = ();
+
+    type Out = (Self, Handle<FramebufferExtractSource>);
+
+    fn extract_component((destination, source_handle): QueryItem<'_, Self::QueryData>) -> Option<Self::Out> {
+        Some((
+            destination.clone(),
+            source_handle.clone(),
+        ))
+    }
+}
+
+#[derive(Bundle)]
+pub struct ExtractFramebufferBundle {
+    pub source: Handle<FramebufferExtractSource>,
+    pub dest: FramebufferExtractDestination,
+}
+
diff --git a/src/lib.rs b/src/lib.rs
new file mode 100644
index 0000000..9c6fb1b
--- /dev/null
+++ b/src/lib.rs
@@ -0,0 +1,41 @@
+use bevy::{prelude::*, render::{render_asset::RenderAssetPlugin, extract_component::ExtractComponentPlugin, RenderApp, Render, RenderSet, render_graph::RenderGraph, graph::CameraDriverLabel}};
+use components::FramebufferExtractDestination;
+use nodes::{FramebufferExtractNode, FramebufferExtractLabel};
+use render_assets::FramebufferExtractSource;
+
+pub mod components;
+mod systems;
+mod nodes;
+pub mod render_assets;
+
+
+pub enum FramebufferExtractSet {
+    Set
+}
+
+pub struct FramebufferExtractPlugin;
+
+impl Plugin for FramebufferExtractPlugin {
+    fn build(&self, app: &mut App) {
+        app
+            .register_type::<FramebufferExtractSource>()
+            .init_asset::<FramebufferExtractSource>()
+            .register_asset_reflect::<FramebufferExtractSource>()
+            .add_plugins((
+                RenderAssetPlugin::<FramebufferExtractSource>::default(),
+                ExtractComponentPlugin::<FramebufferExtractDestination>::default(),
+            ));
+
+        let render_app = app.sub_app_mut(RenderApp);
+        render_app
+            .add_systems(
+                Render,
+                systems::extract_framebuffers
+                    .after(RenderSet::Render)
+                    .before(RenderSet::Cleanup),
+            );
+        let mut graph = render_app.world.resource_mut::<RenderGraph>();
+        graph.add_node(FramebufferExtractLabel, FramebufferExtractNode);
+        graph.add_node_edge(CameraDriverLabel, FramebufferExtractLabel);
+    }
+}
diff --git a/src/nodes.rs b/src/nodes.rs
new file mode 100644
index 0000000..bccd861
--- /dev/null
+++ b/src/nodes.rs
@@ -0,0 +1,38 @@
+use bevy::{prelude::*, render::{render_graph::{Node, RenderGraphContext, NodeRunError, RenderLabel}, renderer::RenderContext, render_asset::RenderAssets, render_resource::{ImageCopyBuffer, ImageDataLayout}}};
+
+use crate::render_assets::FramebufferExtractSource;
+
+#[derive(RenderLabel, Clone, PartialEq, Eq, Debug, Hash)]
+pub struct FramebufferExtractLabel;
+
+#[derive(Default)]
+pub struct FramebufferExtractNode;
+
+impl Node for FramebufferExtractNode {
+    fn run(
+        &self,
+        graph: &mut RenderGraphContext,
+        render_context: &mut RenderContext,
+        world: &World,
+    ) -> Result<(), NodeRunError> {
+        for (_, source) in world.resource::<RenderAssets<FramebufferExtractSource>>().iter() {
+            let Some(gpu_image) = world.resource::<RenderAssets<Image>>().get(&source.source_handle) else {
+                return Ok(())
+            };
+
+            render_context.command_encoder().copy_texture_to_buffer(
+                gpu_image.texture.as_image_copy(),
+                ImageCopyBuffer {
+                    buffer: &source.buffer,
+                    layout: ImageDataLayout {
+                        offset: 0,
+                        bytes_per_row: Some(source.padded_bytes_per_row),
+                        rows_per_image: None,
+                    },
+                },
+                source.source_size,
+            );
+        }
+        Ok(())
+    }
+}
diff --git a/src/render_assets.rs b/src/render_assets.rs
new file mode 100644
index 0000000..1615e01
--- /dev/null
+++ b/src/render_assets.rs
@@ -0,0 +1,52 @@
+use bevy::{prelude::*, render::{render_asset::{RenderAsset, RenderAssets, RenderAssetUsages, PrepareAssetError}, render_resource::{Buffer, Extent3d, BufferUsages, BufferDescriptor, TextureFormat}, renderer::RenderDevice}, ecs::system::{lifetimeless::SRes, SystemParamItem}};
+
+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,
+}
+
+#[derive(Asset, Reflect, Clone, Default)]
+pub struct FramebufferExtractSource(pub Handle<Image>);
+
+impl RenderAsset for FramebufferExtractSource {
+    type PreparedAsset = GpuFramebufferExtractSource;
+    type Param = (SRes<RenderDevice>, SRes<RenderAssets<Image>>);
+
+    fn asset_usage(&self) -> RenderAssetUsages {
+        RenderAssetUsages::default()
+    }
+
+    fn prepare_asset(
+        self,
+        (device, images): &mut SystemParamItem<Self::Param>,
+    ) -> Result<Self::PreparedAsset, PrepareAssetError<Self>> {
+        
+        let Some(gpu_image) = images.get(&self.0) else {
+            warn!("Failed to get GPU image");
+            return Err(PrepareAssetError::RetryNextUpdate(self))
+        };
+
+        let size = gpu_image.texture.size();
+        let format = gpu_image.texture_format;
+        let bytes_per_row = (size.width / format.block_dimensions().0) * format.block_copy_size(None).unwrap();
+        let padded_bytes_per_row = RenderDevice::align_copy_bytes_per_row(bytes_per_row as usize) as u32;
+
+        Ok(GpuFramebufferExtractSource {
+            buffer: device.create_buffer(&BufferDescriptor { 
+                label: Some("framebuffer_extract_buffer"),
+                size: (size.height * padded_bytes_per_row) as u64,
+                usage: BufferUsages::COPY_DST | BufferUsages::MAP_READ,
+                mapped_at_creation: false,
+            }),
+            source_handle: self.0.clone(),
+            source_size: size,
+            bytes_per_row,
+            padded_bytes_per_row,
+            format,
+        })
+    }
+}
diff --git a/src/resources.rs b/src/resources.rs
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/src/resources.rs
diff --git a/src/systems.rs b/src/systems.rs
new file mode 100644
index 0000000..25b25dc
--- /dev/null
+++ b/src/systems.rs
@@ -0,0 +1,65 @@
+use std::time::Duration;
+
+use bevy::{prelude::*, render::{render_asset::{RenderAssets, RenderAssetUsages}, renderer::RenderDevice, render_resource::{MapMode, Maintain, Extent3d, TextureDimension}}};
+
+use pollster::FutureExt;
+
+use crate::{render_assets::FramebufferExtractSource, components::FramebufferExtractDestination};
+
+pub fn extract_framebuffers(
+    mut extract_bundles: Query<(&Handle<FramebufferExtractSource>, &mut FramebufferExtractDestination)>, 
+    sources: Res<RenderAssets<FramebufferExtractSource>>,
+    device: Res<RenderDevice>,
+) {
+    for (source_handle, destination_handle) in extract_bundles.iter_mut() {
+        let Some(gpu_source) = sources.get(source_handle) else {
+            continue;
+        };
+
+        let mut image_bytes = {
+            let slice = gpu_source.buffer.slice(..);
+
+            {
+                let (tx, rx) = oneshot::channel();
+                device.map_buffer(&slice, MapMode::Read, move |res| {
+                    tx.send(res).unwrap();
+                });
+                device.poll(Maintain::Wait);
+                rx.block_on().unwrap().unwrap();
+            }
+             
+            slice.get_mapped_range().to_vec()
+        };
+
+        gpu_source.buffer.unmap();
+
+        let bytes_per_row = gpu_source.bytes_per_row as usize;
+        let padded_bytes_per_row = gpu_source.padded_bytes_per_row as usize;
+        let source_size = gpu_source.source_size;
+        let destination_handle = destination_handle.clone();
+        let source_format = gpu_source.format;
+
+        std::thread::spawn(move || {
+            if bytes_per_row != padded_bytes_per_row {
+                let mut unpadded_bytes = Vec::<u8>::with_capacity(source_size.height as usize * bytes_per_row);
+                for padded_row in image_bytes.chunks(padded_bytes_per_row) {
+                    unpadded_bytes.extend_from_slice(&padded_row[..bytes_per_row]);
+                }
+                image_bytes = unpadded_bytes;
+            }
+
+            *destination_handle.0.lock().unwrap() = Image::new(
+                Extent3d {
+                    width: source_size.width,
+                    height: source_size.height,
+                    depth_or_array_layers: 1,
+                },
+                TextureDimension::D2,
+                image_bytes,
+                source_format,
+                RenderAssetUsages::MAIN_WORLD | RenderAssetUsages::RENDER_WORLD,
+            );
+        });
+    }
+
+}