Merge branch 'main' into debug-draw

Author: tim-blackbird

.github/contributing/example_style_guide.md

@@ -38,7 +38,7 @@ For more advice on writing examples, see the [relevant section](../../CONTRIBUTI
 4. In Queries, prefer `With<T>` filters over actually fetching unused data with `&T`.
 5. Prefer disjoint queries using `With` and `Without` over param sets when you need more than one query in a single system.
 6. Prefer structs with named fields over tuple structs except in the case of single-field wrapper types.
-7. Use enum-labels over string-labels for system / schedule / etc. labels.
+7. Use enum-labels over string-labels for app / schedule / etc. labels.
 
 ## "Feature" examples
 

CONTRIBUTING.md

@@ -81,6 +81,15 @@ Our merge strategy relies on the classification of PRs on two axes:
 * How controversial are the design decisions
 * How complex is the implementation
 
+Each [label](https://github.com/bevyengine/bevy/labels) has a prefix denoting its category:
+
+* A: Area (e.g. A-Animation, A-ECS, A-Rendering)
+* C: Category (e.g. C-Breaking-Change, C-Code-Quality, C-Docs)
+* D: Difficulty (e.g. D-Complex, D-Good-First-Issue)
+* O: Operating System (e.g. O-Linux, O-Web, O-Windows)
+* P: Priority (e.g. P-Critical, P-High)
+* S: Status (e.g. S-Blocked, S-Controversial, S-Needs-Design)
+
 PRs with non-trivial design decisions are given the [`S-Controversial`] label. This indicates that
 the PR needs more thorough design review or an [RFC](https://github.com/bevyengine/rfcs), if complex enough.
 

Cargo.toml

@@ -13,7 +13,11 @@ repository = "https://github.com/bevyengine/bevy"
 rust-version = "1.67.0"
 
 [workspace]
-exclude = ["benches", "crates/bevy_ecs_compile_fail_tests", "crates/bevy_reflect_compile_fail_tests"]
+exclude = [
+  "benches",
+  "crates/bevy_ecs_compile_fail_tests",
+  "crates/bevy_reflect_compile_fail_tests",
+]
 members = [
   "crates/*",
   "examples/mobile",
@@ -40,11 +44,14 @@ default = [
   "bevy_ui",
   "png",
   "hdr",
+  "ktx2",
+  "zstd",
   "vorbis",
   "x11",
   "filesystem_watcher",
   "bevy_gizmos",
   "android_shared_stdcxx",
+  "tonemapping_luts"
 ]
 
 # Force dynamic linking, which improves iterative compile times
@@ -74,6 +81,7 @@ trace = ["bevy_internal/trace"]
 wgpu_trace = ["bevy_internal/wgpu_trace"]
 
 # Image format support for texture loading (PNG and HDR are enabled by default)
+exr = ["bevy_internal/exr"]
 hdr = ["bevy_internal/hdr"]
 png = ["bevy_internal/png"]
 tga = ["bevy_internal/tga"]
@@ -123,6 +131,13 @@ animation = ["bevy_internal/animation"]
 # Enable using a shared stdlib for cxx on Android.
 android_shared_stdcxx = ["bevy_internal/android_shared_stdcxx"]
 
+# Enable detailed trace event logging.
+# These trace events are expensive even when off, thus they require compile time opt-in.
+detailed_trace = ["bevy_internal/detailed_trace"]
+
+# Include tonemapping LUT KTX2 files.
+tonemapping_luts = ["bevy_internal/tonemapping_luts"]
+
 [dependencies]
 bevy_dylib = { path = "crates/bevy_dylib", version = "0.9.0", default-features = false, optional = true }
 bevy_internal = { path = "crates/bevy_internal", version = "0.9.0", default-features = false }
@@ -401,6 +416,17 @@ description = "Loads and renders a glTF file as a scene"
 category = "3D Rendering"
 wasm = true
 
+[[example]]
+name = "tonemapping"
+path = "examples/3d/tonemapping.rs"
+required-features = ["ktx2", "zstd"]
+
+[package.metadata.example.tonemapping]
+name = "Tonemapping"
+description = "Compares tonemapping options"
+category = "3D Rendering"
+wasm = true
+
 [[example]]
 name = "fxaa"
 path = "examples/3d/fxaa.rs"
@@ -484,7 +510,6 @@ wasm = true
 [[example]]
 name = "skybox"
 path = "examples/3d/skybox.rs"
-required-features = ["ktx2", "zstd"]
 
 [package.metadata.example.skybox]
 name = "Skybox"
@@ -827,6 +852,26 @@ description = "Shows how to create and register a custom audio source by impleme
 category = "Audio"
 wasm = true
 
+[[example]]
+name = "spatial_audio_2d"
+path = "examples/audio/spatial_audio_2d.rs"
+
+[package.metadata.example.spatial_audio_2d]
+name = "Spatial Audio 2D"
+description = "Shows how to play spatial audio, and moving the emitter in 2D"
+category = "Audio"
+wasm = true
+
+[[example]]
+name = "spatial_audio_3d"
+path = "examples/audio/spatial_audio_3d.rs"
+
+[package.metadata.example.spatial_audio_3d]
+name = "Spatial Audio 3D"
+description = "Shows how to play spatial audio, and moving the emitter in 3D"
+category = "Audio"
+wasm = true
+
 # Diagnostics
 [[example]]
 name = "log_diagnostics"
@@ -949,6 +994,16 @@ description = "Query for entities that had a specific component removed earlier
 category = "ECS (Entity Component System)"
 wasm = false
 
+[[example]]
+name = "run_conditions"
+path = "examples/ecs/run_conditions.rs"
+
+[package.metadata.example.run_conditions]
+name = "Run Conditions"
+description = "Run systems only when one or multiple conditions are met"
+category = "ECS (Entity Component System)"
+wasm = false
+
 [[example]]
 name = "startup_system"
 path = "examples/ecs/startup_system.rs"

assets/environment_maps/info.txt

@@ -0,0 +1,6 @@
+The pisa_*.ktx2 files were generated from https://github.com/KhronosGroup/glTF-Sample-Environments/blob/master/pisa.hdr using the following tools and commands:
+- IBL environment map prefiltering to cubemaps: https://github.com/KhronosGroup/glTF-IBL-Sampler
+  - Diffuse: ./cli -inputPath pisa.hdr -outCubeMap pisa_diffuse.ktx2 -distribution Lambertian -cubeMapResolution 32
+  - Specular: ./cli -inputPath pisa.hdr -outCubeMap pisa_specular.ktx2 -distribution GGX -cubeMapResolution 512
+- Converting to rgb9e5 format with zstd 'supercompression': https://github.com/DGriffin91/bevy_mod_environment_map_tools
+  - cargo run --release -- --inputs pisa_diffuse.ktx2,pisa_specular.ktx2 --outputs pisa_diffuse_rgb9e5_zstd.ktx2,pisa_specular_rgb9e5_zstd.ktx2

assets/environment_maps/pisa_diffuse_rgb9e5_zstd.ktx2

@@ -8,6 +8,7 @@
 #import bevy_pbr::shadows
 #import bevy_pbr::fog
 #import bevy_pbr::pbr_functions
+#import bevy_pbr::pbr_ambient
 
 @group(1) @binding(0)
 var my_array_texture: texture_2d_array<f32>;

assets/environment_maps/pisa_specular_rgb9e5_zstd.ktx2

@@ -0,0 +1,64 @@
+#import bevy_pbr::mesh_view_bindings
+#import bevy_pbr::mesh_bindings
+#import bevy_pbr::utils
+
+#ifdef TONEMAP_IN_SHADER
+#import bevy_core_pipeline::tonemapping
+#endif
+
+struct FragmentInput {
+    @builtin(front_facing) is_front: bool,
+    @builtin(position) frag_coord: vec4<f32>,
+    #import bevy_pbr::mesh_vertex_output
+};
+
+// Sweep across hues on y axis with value from 0.0 to +15EV across x axis 
+// quantized into 24 steps for both axis.
+fn color_sweep(uv: vec2<f32>) -> vec3<f32> {
+    var uv = uv;
+    let steps = 24.0;
+    uv.y = uv.y * (1.0 + 1.0 / steps);
+    let ratio = 2.0;
+    
+    let h = PI * 2.0 * floor(1.0 + steps * uv.y) / steps;
+    let L = floor(uv.x * steps * ratio) / (steps * ratio) - 0.5;
+    
+    var color = vec3(0.0);
+    if uv.y < 1.0 { 
+        color = cos(h + vec3(0.0, 1.0, 2.0) * PI * 2.0 / 3.0);
+        let maxRGB = max(color.r, max(color.g, color.b));
+        let minRGB = min(color.r, min(color.g, color.b));
+        color = exp(15.0 * L) * (color - minRGB) / (maxRGB - minRGB);
+    } else {
+        color = vec3(exp(15.0 * L));
+    }
+    return color;
+}
+
+fn hsv_to_srgb(c: vec3<f32>) -> vec3<f32> {
+    let K = vec4(1.0, 2.0 / 3.0, 1.0 / 3.0, 3.0);
+    let p = abs(fract(c.xxx + K.xyz) * 6.0 - K.www);
+    return c.z * mix(K.xxx, clamp(p - K.xxx, vec3(0.0), vec3(1.0)), c.y);
+}
+
+// Generates a continuous sRGB sweep.
+fn continuous_hue(uv: vec2<f32>) -> vec3<f32> {
+    return hsv_to_srgb(vec3(uv.x, 1.0, 1.0)) * max(0.0, exp2(uv.y * 9.0) - 1.0);
+}
+
+@fragment
+fn fragment(in: FragmentInput) -> @location(0) vec4<f32> {
+    var uv = in.uv;
+    var out = vec3(0.0);
+    if uv.y > 0.5 {
+        uv.y = 1.0 - uv.y;
+        out = color_sweep(vec2(uv.x, uv.y * 2.0));
+    } else {
+        out = continuous_hue(vec2(uv.y * 2.0, uv.x));
+    }
+    var color = vec4(out, 1.0);
+#ifdef TONEMAP_IN_SHADER
+    color = tone_mapping(color);
+#endif
+    return color;
+}

assets/shaders/array_texture.wgsl

@@ -16,6 +16,7 @@ bevy_ecs = { path = "../crates/bevy_ecs" }
 bevy_reflect = { path = "../crates/bevy_reflect" }
 bevy_tasks = { path = "../crates/bevy_tasks" }
 bevy_utils = { path = "../crates/bevy_utils" }
+bevy_math = { path = "../crates/bevy_math" }
 
 [profile.release]
 opt-level = 3
@@ -50,3 +51,8 @@ harness = false
 name = "iter"
 path = "benches/bevy_tasks/iter.rs"
 harness = false
+
+[[bench]]
+name = "bezier"
+path = "benches/bevy_math/bezier.rs"
+harness = false

assets/shaders/tonemapping_test_patterns.wgsl

@@ -1,19 +1,19 @@
 use criterion::criterion_group;
 
-mod run_criteria;
+mod run_condition;
 mod running_systems;
 mod schedule;
 
-use run_criteria::*;
+use run_condition::*;
 use running_systems::*;
 use schedule::*;
 
 criterion_group!(
     scheduling_benches,
-    run_criteria_yes,
-    run_criteria_no,
-    run_criteria_yes_with_query,
-    run_criteria_yes_with_resource,
+    run_condition_yes,
+    run_condition_no,
+    run_condition_yes_with_query,
+    run_condition_yes_with_resource,
     empty_systems,
     busy_systems,
     contrived,