├── .github └── workflows │ └── release.yml ├── .gitignore ├── Cargo.toml ├── LICENSE ├── README.md ├── examples ├── bloom.rs ├── scalar.png ├── wave.png └── wave.rs ├── flake.lock ├── flake.nix └── src ├── clipping_planes.rs ├── cuboids.rs ├── lib.rs ├── material.rs ├── vertex_pulling.rs └── vertex_pulling ├── buffers.rs ├── cuboid_cache.rs ├── draw.rs ├── extract.rs ├── index_buffer.rs ├── pipeline.rs ├── plugin.rs ├── prepare.rs ├── queue.rs └── vertex_pulling.wgsl /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release Pipeline 2 | 3 | on: 4 | pull_request: 5 | push: 6 | branches: 7 | - main 8 | workflow_dispatch: 9 | inputs: 10 | publish: 11 | type: boolean 12 | required: false 13 | description: Trigger with publish 14 | 15 | jobs: 16 | publish: 17 | uses: ForesightMiningSoftwareCorporation/github/.github/workflows/rust-build.yml@v1 18 | with: 19 | skip-test: ${{ github.event_name == 'push' && 'true' || (github.event_name == 'workflow_dispatch' && inputs.publish) }} 20 | publish: ${{ (github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && inputs.publish)) && 'true' || 'false' }} 21 | publish_public_registry: true 22 | secrets: inherit 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /Cargo.lock 3 | /.idea 4 | /.vscode -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "bevy-aabb-instancing" 3 | version = "0.11.0" 4 | edition = "2021" 5 | description = "Render millions of AABB instances in Bevy." 6 | authors = [ 7 | "Duncan Fairbanks ", 8 | "Zhixing Zhang ", 9 | ] 10 | keywords = ["bevy", "aabb", "cube", "instancing", "render"] 11 | license = "Apache-2.0" 12 | repository = "https://github.com/ForesightMiningSoftwareCorporation/bevy-aabb-instancing/" 13 | 14 | [features] 15 | trace = ["bevy/trace_chrome"] 16 | 17 | [dependencies.bevy] 18 | version = "0.12.1" 19 | default-features = false 20 | features = ["bevy_asset", "bevy_core_pipeline", "bevy_render", "x11"] 21 | 22 | [dev-dependencies] 23 | rand = "0.8" 24 | smooth-bevy-cameras = "0.10" 25 | 26 | [[example]] 27 | name = "wave" 28 | path = "examples/wave.rs" 29 | 30 | [[example]] 31 | name = "bloom" 32 | path = "examples/bloom.rs" 33 | required-features = ["bevy/ktx2", "bevy/tonemapping_luts", "bevy/zstd"] 34 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2022 Duncan Fairbanks and Foresight Mining Software Corporation 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # bevy-aabb-instancing 2 | 3 | [![crates.io](https://img.shields.io/crates/v/bevy-aabb-instancing)](https://crates.io/crates/bevy-aabb-instancing) 4 | [![docs.rs](https://docs.rs/bevy-aabb-instancing/badge.svg)](https://docs.rs/bevy-aabb-instancing) 5 | 6 | Render millions of AABBs every frame with an instancing renderer. 7 | 8 | ![Example](https://raw.githubusercontent.com/ForesightMiningSoftwareCorporation/bevy-aabb-instancing/main/examples/scalar.png) 9 | 10 | ## Demo 11 | 12 | ```sh 13 | cargo run --example wave --release 14 | ``` 15 | 16 | ## Features 17 | 18 | - vertex pulling renderer 19 | - cuboid edge shading 20 | - edge-only wireframes 21 | - clipping planes 22 | - multiple color modes: RGB and Linear-Range Scalar 23 | - depth jitter to counteract z-fighting of coplanar cuboids 24 | 25 | ## License 26 | 27 | Licensed under the Apache License Version 2.0 by copyright holders Duncan 28 | Fairbanks and Foresight Mining Software Corporation. 29 | 30 | ### Sponsors 31 | 32 | The creation and maintenance of `bevy_aabb_instancing` is sponsored by 33 | Foresight Mining Software Corporation. 34 | 35 | Foresight Mining Software Corporation 38 | 39 | License: Apache-2.0 40 | -------------------------------------------------------------------------------- /examples/bloom.rs: -------------------------------------------------------------------------------- 1 | use bevy::{ 2 | core_pipeline::{ 3 | bloom::{BloomCompositeMode, BloomPrefilterSettings, BloomSettings}, 4 | tonemapping::Tonemapping, 5 | }, 6 | input::mouse, 7 | prelude::*, 8 | }; 9 | use bevy_aabb_instancing::{Cuboid, CuboidMaterialId, Cuboids, VertexPullingRenderPlugin}; 10 | use smooth_bevy_cameras::{controllers::fps::*, LookTransformPlugin}; 11 | 12 | fn main() { 13 | App::new() 14 | .add_plugins(DefaultPlugins) 15 | .insert_resource(ClearColor(Color::BLACK)) 16 | .insert_resource(Msaa::Off) 17 | .add_plugins(( 18 | VertexPullingRenderPlugin { outlines: true }, 19 | LookTransformPlugin, 20 | FpsCameraPlugin::default(), 21 | )) 22 | .add_systems(Startup, setup) 23 | .add_systems(Update, toggle_fps_controller) 24 | .run(); 25 | } 26 | 27 | fn setup(mut commands: Commands) { 28 | let colors = [ 29 | Color::RED, 30 | Color::GREEN, 31 | Color::BLUE, 32 | Color::YELLOW, 33 | Color::PURPLE, 34 | ]; 35 | 36 | let mut cuboids = Vec::new(); 37 | for x in 0..10 { 38 | for y in 0..10 { 39 | let min = Vec3::new(x as f32 - 5.0, 0.0, y as f32 - 5.0); 40 | let max = min + Vec3::ONE; 41 | let color = colors[(x + y) % colors.len()].as_rgba_u32(); 42 | let mut cuboid = Cuboid::new(min, max, color); 43 | if min.length() < 3.0 { 44 | cuboid.make_emissive(); 45 | } 46 | cuboids.push(cuboid); 47 | } 48 | } 49 | 50 | let cuboids = Cuboids::new(cuboids); 51 | let aabb = cuboids.aabb(); 52 | commands 53 | .spawn(SpatialBundle::default()) 54 | .insert((cuboids, aabb, CuboidMaterialId(0))); 55 | 56 | commands 57 | .spawn(( 58 | Camera3dBundle { 59 | camera: Camera { 60 | hdr: true, 61 | ..default() 62 | }, 63 | tonemapping: Tonemapping::TonyMcMapface, 64 | ..default() 65 | }, 66 | BloomSettings { 67 | intensity: 0.2, 68 | high_pass_frequency: 1.0, 69 | low_frequency_boost: 0.8, 70 | low_frequency_boost_curvature: 0.7, 71 | prefilter_settings: BloomPrefilterSettings { 72 | threshold: 0.0, 73 | threshold_softness: 0.0, 74 | }, 75 | composite_mode: BloomCompositeMode::EnergyConserving, 76 | }, 77 | )) 78 | .insert(FpsCameraBundle::new( 79 | FpsCameraController { 80 | translate_sensitivity: 10.0, 81 | enabled: false, 82 | ..Default::default() 83 | }, 84 | Vec3::splat(10.0), 85 | Vec3::ZERO, 86 | Vec3::Y, 87 | )); 88 | } 89 | 90 | fn toggle_fps_controller( 91 | mouse_button_input: Res>, 92 | mut controller: Query<&mut FpsCameraController>, 93 | ) { 94 | if mouse_button_input.just_pressed(MouseButton::Left) { 95 | controller.single_mut().enabled = true; 96 | } 97 | } 98 | -------------------------------------------------------------------------------- /examples/scalar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ForesightMiningSoftwareCorporation/bevy_aabb_instancing/3cec8316c0024420c5cedbb0df7be960b0ef1122/examples/scalar.png -------------------------------------------------------------------------------- /examples/wave.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ForesightMiningSoftwareCorporation/bevy_aabb_instancing/3cec8316c0024420c5cedbb0df7be960b0ef1122/examples/wave.png -------------------------------------------------------------------------------- /examples/wave.rs: -------------------------------------------------------------------------------- 1 | use bevy::prelude::*; 2 | use bevy_aabb_instancing::{ 3 | Cuboid, CuboidMaterial, CuboidMaterialId, CuboidMaterialMap, Cuboids, 4 | VertexPullingRenderPlugin, COLOR_MODE_SCALAR_HUE, 5 | }; 6 | use smooth_bevy_cameras::{controllers::fps::*, LookTransformPlugin}; 7 | 8 | fn main() { 9 | App::new() 10 | .add_plugins(DefaultPlugins) 11 | .insert_resource(Msaa::Off) 12 | .add_plugins(( 13 | VertexPullingRenderPlugin { outlines: true }, 14 | LookTransformPlugin, 15 | FpsCameraPlugin::default(), 16 | )) 17 | .add_systems(Startup, setup) 18 | .add_systems(Update, (update_scalar_hue_options, toggle_fps_controller)) 19 | .run(); 20 | } 21 | 22 | fn setup(mut commands: Commands, mut material_map: ResMut) { 23 | let material_id = material_map.push(CuboidMaterial { 24 | color_mode: COLOR_MODE_SCALAR_HUE, 25 | ..default() 26 | }); 27 | 28 | const PATCHES_PER_DIM: usize = 20; 29 | const PATCH_SIZE: usize = 150; 30 | const SCENE_RADIUS: f32 = 1500.0; 31 | 32 | for x_batch in 0..PATCHES_PER_DIM { 33 | for z_batch in 0..PATCHES_PER_DIM { 34 | let mut instances = Vec::with_capacity(PATCH_SIZE * PATCH_SIZE); 35 | for x in 0..PATCH_SIZE { 36 | for z in 0..PATCH_SIZE { 37 | let x = (x_batch * PATCH_SIZE) as f32 + x as f32 - SCENE_RADIUS; 38 | let z = (z_batch * PATCH_SIZE) as f32 + z as f32 - SCENE_RADIUS; 39 | let d = (x * x + z * z).sqrt(); 40 | let amp = 0.2 * d; 41 | let y = amp * ((0.05 * x).cos() * (0.05 * z).sin()); 42 | let c = Vec3::new(x, y, z); 43 | let h = 0.01 * d; 44 | let min = c - Vec3::new(0.5, h, 0.5); 45 | let max = c + Vec3::new(0.5, h, 0.5); 46 | let scalar_color = u32::from_le_bytes(d.to_le_bytes()); 47 | let mut cuboid = Cuboid::new(min, max, scalar_color); 48 | cuboid.set_depth_bias(0); 49 | instances.push(cuboid); 50 | } 51 | } 52 | let cuboids = Cuboids::new(instances); 53 | let aabb = cuboids.aabb(); 54 | commands 55 | .spawn(SpatialBundle::default()) 56 | .insert((cuboids, aabb, material_id)); 57 | } 58 | } 59 | 60 | commands 61 | .spawn(Camera3dBundle::default()) 62 | .insert(FpsCameraBundle::new( 63 | FpsCameraController { 64 | translate_sensitivity: 200.0, 65 | enabled: false, 66 | ..Default::default() 67 | }, 68 | Vec3::new(0.0, 100.0, 0.0), 69 | Vec3::new(100.0, 0.0, 100.0), 70 | Vec3::Y, 71 | )); 72 | } 73 | 74 | fn update_scalar_hue_options(time: Res