Skip to content

Initial raytraced lighting progress (bevy_solari) #19058

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 65 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
65 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
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 @@ -245,6 +245,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 @@ -1245,6 +1254,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 @@ -414,6 +414,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 @@ -60,6 +60,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
13 changes: 13 additions & 0 deletions crates/bevy_mesh/src/mesh.rs
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,18 @@ 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 setting it to true for low resolution proxy meshes you want to use for raytracing,
/// and false for higher resolution versions of the mesh that you want to use for raster.
///
/// 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 +215,7 @@ impl Mesh {
morph_targets: None,
morph_target_names: None,
asset_usage,
enable_raytracing: true,
Copy link
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
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
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: 2 additions & 2 deletions crates/bevy_render/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -117,15 +117,15 @@ wesl = { version = "0.1.2", optional = true }

[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
# Omit the `glsl` feature in non-WebAssembly by default.
naga_oil = { version = "0.17", default-features = false, features = [
naga_oil = { version = "0.17.1", default-features = false, features = [
"test_shader",
] }

[dev-dependencies]
proptest = "1"

[target.'cfg(target_arch = "wasm32")'.dependencies]
naga_oil = "0.17"
naga_oil = "0.17.1"
js-sys = "0.3"
web-sys = { version = "0.3.67", features = [
'Blob',
Expand Down
8 changes: 8 additions & 0 deletions crates/bevy_render/src/camera/camera.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1064,6 +1064,7 @@ pub fn camera_system(
#[reflect(opaque)]
#[reflect(Component, Default, Clone)]
pub struct CameraMainTextureUsages(pub TextureUsages);

impl Default for CameraMainTextureUsages {
fn default() -> Self {
Self(
Expand All @@ -1074,6 +1075,13 @@ impl Default for CameraMainTextureUsages {
}
}

impl CameraMainTextureUsages {
pub fn with(mut self, usages: TextureUsages) -> Self {
self.0 |= usages;
self
}
}

#[derive(Component, Debug)]
pub struct ExtractedCamera {
pub target: Option<NormalizedRenderTarget>,
Expand Down
8 changes: 6 additions & 2 deletions crates/bevy_render/src/mesh/allocator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ pub struct MeshAllocator {
/// WebGL 2. On this platform, we must give each vertex array its own
/// buffer, because we can't adjust the first vertex when we perform a draw.
general_vertex_slabs_supported: bool,

/// Additional buffer usages to add to any vertex or index buffers created.
pub extra_buffer_usages: BufferUsages,
}

/// Tunable parameters that customize the behavior of the allocator.
Expand Down Expand Up @@ -348,6 +351,7 @@ impl FromWorld for MeshAllocator {
mesh_id_to_index_slab: HashMap::default(),
next_slab_id: default(),
general_vertex_slabs_supported,
extra_buffer_usages: BufferUsages::empty(),
}
}
}
Expand Down Expand Up @@ -598,7 +602,7 @@ impl MeshAllocator {
buffer_usages_to_str(buffer_usages)
)),
size: len as u64,
usage: buffer_usages | BufferUsages::COPY_DST,
usage: buffer_usages | BufferUsages::COPY_DST | self.extra_buffer_usages,
mapped_at_creation: true,
});
{
Expand Down Expand Up @@ -835,7 +839,7 @@ impl MeshAllocator {
buffer_usages_to_str(buffer_usages)
)),
size: slab.current_slot_capacity as u64 * slab.element_layout.slot_size(),
usage: buffer_usages,
usage: buffer_usages | self.extra_buffer_usages,
mapped_at_creation: false,
});

Expand Down
21 changes: 21 additions & 0 deletions crates/bevy_render/src/render_resource/bind_group_entries.rs
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,13 @@ impl<'a> IntoBinding<'a> for &'a TextureView {
}
}

impl<'a> IntoBinding<'a> for &'a wgpu::TextureView {
#[inline]
fn into_binding(self) -> BindingResource<'a> {
BindingResource::TextureView(self)
}
}

impl<'a> IntoBinding<'a> for &'a [&'a wgpu::TextureView] {
#[inline]
fn into_binding(self) -> BindingResource<'a> {
Expand All @@ -161,6 +168,13 @@ impl<'a> IntoBinding<'a> for &'a Sampler {
}
}

impl<'a> IntoBinding<'a> for &'a [&'a wgpu::Sampler] {
#[inline]
fn into_binding(self) -> BindingResource<'a> {
BindingResource::SamplerArray(self)
}
}

impl<'a> IntoBinding<'a> for BindingResource<'a> {
#[inline]
fn into_binding(self) -> BindingResource<'a> {
Expand All @@ -175,6 +189,13 @@ impl<'a> IntoBinding<'a> for wgpu::BufferBinding<'a> {
}
}

impl<'a> IntoBinding<'a> for &'a [wgpu::BufferBinding<'a>] {
#[inline]
fn into_binding(self) -> BindingResource<'a> {
BindingResource::BufferArray(self)
}
}

pub trait IntoBindingArray<'b, const N: usize> {
fn into_array(self) -> [BindingResource<'b>; N];
}
Expand Down
24 changes: 14 additions & 10 deletions crates/bevy_render/src/render_resource/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,27 +38,31 @@ pub use wgpu::{
BufferInitDescriptor, DispatchIndirectArgs, DrawIndexedIndirectArgs, DrawIndirectArgs,
TextureDataOrder,
},
AdapterInfo as WgpuAdapterInfo, AddressMode, AstcBlock, AstcChannel, BindGroupDescriptor,
BindGroupEntry, BindGroupLayoutDescriptor, BindGroupLayoutEntry, BindingResource, BindingType,
AccelerationStructureFlags, AccelerationStructureGeometryFlags,
AccelerationStructureUpdateMode, AdapterInfo as WgpuAdapterInfo, AddressMode, AstcBlock,
AstcChannel, BindGroupDescriptor, BindGroupEntry, BindGroupLayoutDescriptor,
BindGroupLayoutEntry, BindingResource, BindingType, Blas, BlasBuildEntry, BlasGeometries,
BlasGeometrySizeDescriptors, BlasTriangleGeometry, BlasTriangleGeometrySizeDescriptor,
BlendComponent, BlendFactor, BlendOperation, BlendState, BufferAddress, BufferAsyncError,
BufferBinding, BufferBindingType, BufferDescriptor, BufferSize, BufferUsages, ColorTargetState,
ColorWrites, CommandEncoder, CommandEncoderDescriptor, CompareFunction, ComputePass,
ComputePassDescriptor, ComputePipelineDescriptor as RawComputePipelineDescriptor,
DepthBiasState, DepthStencilState, DownlevelFlags, Extent3d, Face, Features as WgpuFeatures,
FilterMode, FragmentState as RawFragmentState, FrontFace, ImageSubresourceRange, IndexFormat,
Limits as WgpuLimits, LoadOp, Maintain, MapMode, MultisampleState, Operations, Origin3d,
PipelineCompilationOptions, PipelineLayout, PipelineLayoutDescriptor, PolygonMode,
PrimitiveState, PrimitiveTopology, PushConstantRange, RenderPassColorAttachment,
RenderPassDepthStencilAttachment, RenderPassDescriptor,
CreateBlasDescriptor, CreateTlasDescriptor, DepthBiasState, DepthStencilState, DownlevelFlags,
Extent3d, Face, Features as WgpuFeatures, FilterMode, FragmentState as RawFragmentState,
FrontFace, ImageSubresourceRange, IndexFormat, Limits as WgpuLimits, LoadOp, Maintain, MapMode,
MultisampleState, Operations, Origin3d, PipelineCompilationOptions, PipelineLayout,
PipelineLayoutDescriptor, PolygonMode, PrimitiveState, PrimitiveTopology, PushConstantRange,
RenderPassColorAttachment, RenderPassDepthStencilAttachment, RenderPassDescriptor,
RenderPipelineDescriptor as RawRenderPipelineDescriptor, Sampler as WgpuSampler,
SamplerBindingType, SamplerBindingType as WgpuSamplerBindingType, SamplerDescriptor,
ShaderModule, ShaderModuleDescriptor, ShaderSource, ShaderStages, StencilFaceState,
StencilOperation, StencilState, StorageTextureAccess, StoreOp, TexelCopyBufferInfo,
TexelCopyBufferLayout, TexelCopyTextureInfo, TextureAspect, TextureDescriptor,
TextureDimension, TextureFormat, TextureFormatFeatureFlags, TextureFormatFeatures,
TextureSampleType, TextureUsages, TextureView as WgpuTextureView, TextureViewDescriptor,
TextureViewDimension, VertexAttribute, VertexBufferLayout as RawVertexBufferLayout,
VertexFormat, VertexState as RawVertexState, VertexStepMode, COPY_BUFFER_ALIGNMENT,
TextureViewDimension, Tlas, TlasInstance, TlasPackage, VertexAttribute,
VertexBufferLayout as RawVertexBufferLayout, VertexFormat, VertexState as RawVertexState,
VertexStepMode, COPY_BUFFER_ALIGNMENT,
};

pub use crate::mesh::VertexBufferLayout;
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 @@ -219,12 +219,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" } # TODO: Ideally remove this dependency
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
Loading