Skip to content
Merged
Show file tree
Hide file tree
Changes from 84 commits
Commits
Show all changes
93 commits
Select commit Hold shift + click to select a range
e28c8c8
WIP
JMS55 Mar 27, 2025
f42c25b
Add logo
JMS55 Mar 27, 2025
58507ba
Guard extra buffer usages behind a cargo feature
JMS55 Mar 30, 2025
fdf123f
Better pattern to contain RT buffer usages entirely within bevy_solari
JMS55 Mar 30, 2025
f9e5aa2
Add extra mesh allocator buffer usages instead of overwriting
JMS55 Mar 30, 2025
cfb1ba2
Merge commit '301f61845a26107ab36f83d2702f471642be25b1' into solari6
JMS55 Mar 31, 2025
92997a0
Add BLAS creation code
JMS55 Mar 31, 2025
7224fcd
WIP scene bindings
JMS55 Mar 31, 2025
e7b9aa5
Add binding array helpers
JMS55 Apr 2, 2025
c9dd3ab
WIP scene binder
JMS55 Apr 2, 2025
c635e31
WIP scene binding
JMS55 Apr 4, 2025
182e88b
WIP example setup
JMS55 Apr 4, 2025
27abb14
Misc
JMS55 Apr 5, 2025
135bcb4
Bugfix
JMS55 Apr 5, 2025
e9ea256
WIP pathtracer
JMS55 Apr 5, 2025
324f1be
Fix?
JMS55 Apr 5, 2025
491effd
Switch to uploading geometry slices instead of descriptors
JMS55 Apr 6, 2025
60d86b3
Fixes
JMS55 Apr 6, 2025
e60addf
Use patched naga_oil
JMS55 Apr 7, 2025
e387883
Scene binder WIP
JMS55 Apr 8, 2025
231ca08
Simplify code
JMS55 Apr 8, 2025
0b0db2c
Add material bindings
JMS55 Apr 9, 2025
5ff7c4d
Misc reorder
JMS55 Apr 9, 2025
7ebea4a
Fix mesh binding array shader types
JMS55 Apr 9, 2025
45bd908
Merge commit '73f03327c234f935ba7328220f6a25e3b33e1899' into solari6
JMS55 Apr 10, 2025
f0e13b2
Note down some bugs
JMS55 Apr 10, 2025
f2873c0
Note that RaytracingMesh3d cannot be used standalone
JMS55 Apr 10, 2025
c8eddb3
Add missing import
JMS55 Apr 12, 2025
6e78a94
Reset pathtracer accumulation on view
JMS55 Apr 13, 2025
d4e4dba
Hide modules
JMS55 Apr 13, 2025
5959cdd
Add light source data to the scene
JMS55 Apr 13, 2025
6804f61
Add missing bindings
JMS55 Apr 14, 2025
757c1e5
Add enable_raytracing flag to Mesh, misc other changes
JMS55 Apr 19, 2025
f89e2f7
Merge commit '18e1bf1c3ddf6b102a416b4886b40c025e800cd6' into solari6
JMS55 Apr 19, 2025
4f5a2ec
Fix merge
JMS55 Apr 19, 2025
18cb7fc
Remove Mesh3d to skip raster rendering when pathtracer is on
JMS55 Apr 20, 2025
305c015
Basic pathtracer
JMS55 Apr 20, 2025
4354944
Misc
JMS55 Apr 23, 2025
123628a
Add emissive mesh sampling utilities
JMS55 Apr 26, 2025
63272d1
Bugfixes
JMS55 Apr 26, 2025
1f051f8
Add NEE for emissive meshes
JMS55 Apr 27, 2025
4005334
Implement support for directional lights (seems too dim though)
JMS55 Apr 30, 2025
7bc608f
Rename irradiance to radiance in the path tracer, since it's a single…
JMS55 Apr 30, 2025
b9134ee
Adjust RAY_T_MIN
JMS55 Apr 30, 2025
5f79f7a
Fix directional light units
JMS55 Apr 30, 2025
4c6abfe
Misc
JMS55 Apr 30, 2025
49166b1
Rename directional light color to illuminance
JMS55 Apr 30, 2025
a4ef1f0
Merge commit 'cd67bac544a874f668c706b837c8b3093dfb9545' into solari6
JMS55 May 3, 2025
044474a
Make sun size configurable
JMS55 May 3, 2025
f26e0c1
Fix incorrect throughput calculation, add comments
JMS55 May 4, 2025
7dc5458
Remove russian roulette bias
JMS55 May 4, 2025
d25d52e
Change example clear color for raster
JMS55 May 4, 2025
9adcdd0
Misc
JMS55 May 4, 2025
2dc2589
Add release notes
JMS55 May 4, 2025
eb48343
Fix release notes
JMS55 May 4, 2025
d80f376
Fix overflows with high sample counts
JMS55 May 4, 2025
7753735
Specify commit of forked naga_oil
JMS55 May 4, 2025
51c5f56
Update crates/bevy_solari/src/pathtracer/node.rs
JMS55 May 9, 2025
86f2aa2
Add more docs to Mesh::enable_raytracing
JMS55 May 9, 2025
c5e178a
Merge commit '45ba5b9f0347710d0b84979631fae6f690434d62' into solari6
JMS55 May 18, 2025
a31e549
Misc
JMS55 May 18, 2025
f83a666
CI fixes
JMS55 May 19, 2025
e070d7b
Doc fmt
JMS55 May 19, 2025
569b85d
CI fixes
JMS55 May 19, 2025
45bcffd
Update to naga_oil 0.17.1
JMS55 May 20, 2025
1f21410
Misc rename
JMS55 May 22, 2025
8ab295a
Simplify BGL code
JMS55 May 22, 2025
948dfa9
Misc rename
JMS55 May 22, 2025
a3f9edb
Merge commit '523600133d92ee55f94d8184636787fd33845dd3' into solari6
JMS55 May 26, 2025
01465b5
Fix HDR usage after rebase
JMS55 May 26, 2025
3c18ea2
Use new embedded shader asset APIs
JMS55 May 26, 2025
bee4d51
New sampling APIs
JMS55 May 28, 2025
def2300
Misc
JMS55 May 29, 2025
ef1f736
Misc
JMS55 May 29, 2025
31f7a49
Emissive mesh bugfixes
JMS55 Jun 2, 2025
a700bd3
Add back cos_theta_light clamp
JMS55 Jun 4, 2025
87d8d30
Misc
JMS55 Jun 4, 2025
af4c61e
Update release-content/release-notes/bevy_solari.md
JMS55 Jun 9, 2025
f631771
Merge commit '56f26cfb022433ad16f7078e9f0a8de5f5cbcc3b' into solari6
JMS55 Jun 9, 2025
057c2f7
Merge branch 'main' into solari6
JMS55 Jun 9, 2025
0bbd643
Fix rebase
JMS55 Jun 10, 2025
4abdd78
Doc improvement
JMS55 Jun 10, 2025
78ff61d
Merge branch 'main' into solari6
JMS55 Jun 10, 2025
c3ed106
Merge branch 'main' into solari6
JMS55 Jun 11, 2025
36c5f99
Rename RaytracingScene -> SolariScene
JMS55 Jun 11, 2025
30cb322
Remove extra stuff in svg
JMS55 Jun 11, 2025
433a29a
Add some docs
JMS55 Jun 11, 2025
3309e33
Use the existing cornell box scene
JMS55 Jun 11, 2025
9043d58
Misc
JMS55 Jun 11, 2025
4c8ce14
Fix doc
JMS55 Jun 11, 2025
04b426c
Merge remote-tracking branch 'origin/main' into pr/JMS55/19058
cart Jun 12, 2025
fc7defe
Trigger -> On
cart Jun 12, 2025
8e6a076
"solari scene" -> "raytracing scene"
cart Jun 12, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,15 @@ bevy_render = ["bevy_internal/bevy_render", "bevy_color"]
# Provides scene functionality
bevy_scene = ["bevy_internal/bevy_scene", "bevy_asset"]

# Provides raytraced lighting (do not use, not yet ready for users)
bevy_solari = [
"bevy_internal/bevy_solari",
"bevy_asset",
"bevy_core_pipeline",
"bevy_pbr",
"bevy_render",
]

# Provides sprite functionality
bevy_sprite = [
"bevy_internal/bevy_sprite",
Expand Down Expand Up @@ -1261,6 +1270,18 @@ description = "Load a cubemap texture onto a cube like a skybox and cycle throug
category = "3D Rendering"
wasm = false

[[example]]
name = "solari"
path = "examples/3d/solari.rs"
doc-scrape-examples = true
required-features = ["bevy_solari"]

[package.metadata.example.solari]
name = "Solari"
description = "Demonstrates realtime dynamic global illumination rendering using Bevy Solari."
category = "3D Rendering"
wasm = false

[[example]]
name = "spherical_area_lights"
path = "examples/3d/spherical_area_lights.rs"
Expand Down
303 changes: 303 additions & 0 deletions assets/branding/bevy_solari.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/models/CornellBox/box_modified.glb
Binary file not shown.
1 change: 1 addition & 0 deletions crates/bevy_internal/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,7 @@ bevy_picking = { path = "../bevy_picking", optional = true, version = "0.16.0-de
bevy_remote = { path = "../bevy_remote", optional = true, version = "0.16.0-dev" }
bevy_render = { path = "../bevy_render", optional = true, version = "0.16.0-dev" }
bevy_scene = { path = "../bevy_scene", optional = true, version = "0.16.0-dev" }
bevy_solari = { path = "../bevy_solari", optional = true, version = "0.16.0-dev" }
bevy_sprite = { path = "../bevy_sprite", optional = true, version = "0.16.0-dev" }
bevy_state = { path = "../bevy_state", optional = true, version = "0.16.0-dev", default-features = false, features = [
"bevy_app",
Expand Down
2 changes: 2 additions & 0 deletions crates/bevy_internal/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ pub use bevy_remote as remote;
pub use bevy_render as render;
#[cfg(feature = "bevy_scene")]
pub use bevy_scene as scene;
#[cfg(feature = "bevy_solari")]
pub use bevy_solari as solari;
#[cfg(feature = "bevy_sprite")]
pub use bevy_sprite as sprite;
#[cfg(feature = "bevy_state")]
Expand Down
16 changes: 16 additions & 0 deletions crates/bevy_mesh/src/mesh.rs
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,21 @@ pub struct Mesh {
morph_targets: Option<Handle<Image>>,
morph_target_names: Option<Vec<String>>,
pub asset_usage: RenderAssetUsages,
/// Whether or not to build a BLAS for use with `bevy_solari` raytracing.
///
/// Note that this is _not_ whether the mesh is _compatible_ with `bevy_solari` raytracing.
/// This field just controls whether or not a BLAS gets built for this mesh, assuming that
/// the mesh is compatible.
///
/// The use case for this field is using lower-resolution proxy meshes for raytracing (to save on BLAS memory usage),
/// while using higher-resolution meshes for raster. You can set this field to true for the lower-resolution proxy mesh,
/// and to false for the high-resolution raster mesh.
///
/// Alternatively, you can use the same mesh for both raster and raytracing, with this field set to true.
///
/// Does nothing if not used with `bevy_solari`, or if the mesh is not compatible
/// with `bevy_solari` (see `bevy_solari`'s docs).
pub enable_raytracing: bool,
}

impl Mesh {
Expand Down Expand Up @@ -203,6 +218,7 @@ impl Mesh {
morph_targets: None,
morph_target_names: None,
asset_usage,
enable_raytracing: true,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this being true mean its building a BLAS for all meshes even when bevy_solari is not in use?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about instead, defaulting to false, and having a method on Mesh which checks the set of vertex attributes is {{POSITION, NORMAL, UV_0, TANGENT}} before setting the bool to true, and returns an error otherwise?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this being true mean its building a BLAS for all meshes even when bevy_solari is not in use?

Depends by what you mean by "not in use". If the solari scene plugin is added to the app, your GPU supports RT, and the mesh is compatible and has enable_raytracing: true, then yes the mesh will get a BLAS built.

If the plugin is not loaded (it's not part of default apps) / your GPU does not support RT, or the mesh is not compatible or has RT off, then no a BLAS won't be built.

How about instead, defaulting to false, and having a method on Mesh which checks the set of vertex attributes is {{POSITION, NORMAL, UV_0, TANGENT}} before setting the bool to true, and returns an error otherwise?

The raytracing_enabled field is not meant to be "whether or not the mesh is compatible for RT". The field is meant for cases where you don't want to build a BLAS for a mesh even if it's compatible. E.g. for higher level LODs if you're using exclusively lower level LODs for RT to reduce BLAS and traversal cost. I'll update the docs to make this explicit.

}
}

Expand Down
4 changes: 4 additions & 0 deletions crates/bevy_render/src/render_resource/pipeline_cache.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1197,6 +1197,10 @@ fn get_capabilities(features: Features, downlevel: DownlevelFlags) -> Capabiliti
Capabilities::MULTISAMPLED_SHADING,
downlevel.contains(DownlevelFlags::MULTISAMPLED_SHADING),
);
capabilities.set(
Capabilities::RAY_QUERY,
features.contains(Features::EXPERIMENTAL_RAY_QUERY),
);
capabilities.set(
Capabilities::DUAL_SOURCE_BLENDING,
features.contains(Features::DUAL_SOURCE_BLENDING),
Expand Down
6 changes: 0 additions & 6 deletions crates/bevy_render/src/renderer/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -180,12 +180,6 @@ pub async fn initialize_renderer(
features -= wgpu::Features::MAPPABLE_PRIMARY_BUFFERS;
}

// RAY_QUERY and RAY_TRACING_ACCELERATION STRUCTURE will sometimes cause DeviceLost failures on platforms
// that report them as supported:
// <https://github.com/gfx-rs/wgpu/issues/5488>
features -= wgpu::Features::EXPERIMENTAL_RAY_QUERY;
features -= wgpu::Features::EXPERIMENTAL_RAY_TRACING_ACCELERATION_STRUCTURE;

limits = adapter.limits();
}

Expand Down
38 changes: 38 additions & 0 deletions crates/bevy_solari/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
[package]
name = "bevy_solari"
version = "0.16.0-dev"
edition = "2024"
description = "Provides raytraced lighting for Bevy Engine"
homepage = "https://bevyengine.org"
repository = "https://github.com/bevyengine/bevy"
license = "MIT OR Apache-2.0"
keywords = ["bevy"]

[dependencies]
# bevy
bevy_app = { path = "../bevy_app", version = "0.16.0-dev" }
bevy_asset = { path = "../bevy_asset", version = "0.16.0-dev" }
bevy_color = { path = "../bevy_color", version = "0.16.0-dev" }
bevy_core_pipeline = { path = "../bevy_core_pipeline", version = "0.16.0-dev" }
bevy_derive = { path = "../bevy_derive", version = "0.16.0-dev" }
bevy_ecs = { path = "../bevy_ecs", version = "0.16.0-dev" }
bevy_math = { path = "../bevy_math", version = "0.16.0-dev" }
bevy_mesh = { path = "../bevy_mesh", version = "0.16.0-dev" }
bevy_pbr = { path = "../bevy_pbr", version = "0.16.0-dev" }
bevy_platform = { path = "../bevy_platform", version = "0.16.0-dev", default-features = false, features = [
"std",
] }
bevy_reflect = { path = "../bevy_reflect", version = "0.16.0-dev" }
bevy_render = { path = "../bevy_render", version = "0.16.0-dev" }
bevy_transform = { path = "../bevy_transform", version = "0.16.0-dev" }

# other
tracing = { version = "0.1", default-features = false, features = ["std"] }
derive_more = { version = "1", default-features = false, features = ["from"] }

[lints]
workspace = true

[package.metadata.docs.rs]
rustdoc-args = ["-Zunstable-options", "--generate-link-to-definition"]
all-features = true
176 changes: 176 additions & 0 deletions crates/bevy_solari/LICENSE-APACHE
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
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
19 changes: 19 additions & 0 deletions crates/bevy_solari/LICENSE-MIT
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
MIT License

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.
9 changes: 9 additions & 0 deletions crates/bevy_solari/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Bevy Solari

[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license)
[![Crates.io](https://img.shields.io/crates/v/bevy_solari.svg)](https://crates.io/crates/bevy_solari)
[![Downloads](https://img.shields.io/crates/d/bevy_solari.svg)](https://crates.io/crates/bevy_solari)
[![Docs](https://docs.rs/bevy_solari/badge.svg)](https://docs.rs/bevy_solari/latest/bevy_solari/)
[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy)

![Logo](../../assets/branding/bevy_solari.svg)
42 changes: 42 additions & 0 deletions crates/bevy_solari/src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
#![expect(missing_docs, reason = "Not all docs are written yet, see #3492.")]

//! Provides raytraced lighting.
//!
//! ![`bevy_solari` logo](https://raw.githubusercontent.com/bevyengine/bevy/assets/branding/bevy_solari.svg)
pub mod pathtracer;
pub mod scene;

/// The solari prelude.
///
/// This includes the most common types in this crate, re-exported for your convenience.
pub mod prelude {
pub use super::SolariPlugin;
pub use crate::pathtracer::Pathtracer;
pub use crate::scene::RaytracingMesh3d;
}

use bevy_app::{App, Plugin};
use bevy_render::settings::WgpuFeatures;
use pathtracer::PathtracingPlugin;
use scene::RaytracingScenePlugin;

pub struct SolariPlugin;

impl Plugin for SolariPlugin {
fn build(&self, app: &mut App) {
app.add_plugins((RaytracingScenePlugin, PathtracingPlugin));
}
}

impl SolariPlugin {
/// [`WgpuFeatures`] required for this plugin to function.
pub fn required_wgpu_features() -> WgpuFeatures {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(unrelated) we're really overdue for structured plugins. this is the kind of thing that should be centralized by a trait and collected at initialization to request the minimal feature set.

WgpuFeatures::EXPERIMENTAL_RAY_TRACING_ACCELERATION_STRUCTURE
| WgpuFeatures::EXPERIMENTAL_RAY_QUERY
| WgpuFeatures::BUFFER_BINDING_ARRAY
| WgpuFeatures::TEXTURE_BINDING_ARRAY
| WgpuFeatures::UNIFORM_BUFFER_AND_STORAGE_TEXTURE_ARRAY_NON_UNIFORM_INDEXING
| WgpuFeatures::SAMPLED_TEXTURE_AND_STORAGE_BUFFER_ARRAY_NON_UNIFORM_INDEXING
| WgpuFeatures::PARTIALLY_BOUND_BINDING_ARRAY
}
}
Loading
Loading