Add initial 2d lighting support

Cargo.toml

@@ -343,6 +343,9 @@ bevy_solari = ["bevy_internal/bevy_solari"]
 # Provides sprite functionality
 bevy_sprite = ["bevy_internal/bevy_sprite"]
 
+# Provides 2D lighting
+bevy_sprite_light = ["bevy_internal/bevy_sprite_light"]
+
 # Provides sprite rendering functionality
 bevy_sprite_render = ["bevy_internal/bevy_sprite_render"]
 
@@ -839,6 +842,18 @@ doc-scrape-examples = true
 hidden = true
 
 # 2D Rendering
+[[example]]
+name = "lighting_2d"
+path = "examples/2d/lighting_2d.rs"
+doc-scrape-examples = true
+required-features = ["bevy_sprite_light"]
+
+[package.metadata.example.lighting_2d]
+name = "2D Lighting"
+description = "Illustrates lighting in 2d"
+category = "2D Rendering"
+wasm = true
+
 [[example]]
 name = "bloom_2d"
 path = "examples/2d/bloom_2d.rs"

crates/bevy_internal/Cargo.toml

@@ -280,6 +280,10 @@ bevy_sprite_render = [
   "bevy_core_pipeline",
   "bevy_gizmos_render?/bevy_sprite_render",
 ]
+bevy_sprite_light = [
+  "dep:bevy_sprite_light",
+  "bevy_sprite_render?/bevy_sprite_light",
+]
 bevy_ui_render = ["dep:bevy_ui_render", "bevy_sprite_render", "bevy_ui"]
 # Feathers ships its built-in icons as PNGs, so enable the PNG feature
 bevy_feathers = ["dep:bevy_feathers", "png"]
@@ -603,6 +607,7 @@ bevy_world_serialization = { path = "../bevy_world_serialization", optional = tr
 bevy_scene = { path = "../bevy_scene", optional = true, version = "0.20.0-dev" }
 bevy_solari = { path = "../bevy_solari", optional = true, version = "0.20.0-dev" }
 bevy_sprite = { path = "../bevy_sprite", optional = true, version = "0.20.0-dev" }
+bevy_sprite_light = { path = "../bevy_sprite_light", optional = true, version = "0.20.0-dev" }
 bevy_sprite_render = { path = "../bevy_sprite_render", optional = true, version = "0.20.0-dev" }
 bevy_state = { path = "../bevy_state", optional = true, version = "0.20.0-dev", default-features = false, features = [
   "bevy_app",

crates/bevy_internal/src/lib.rs

@@ -95,6 +95,8 @@ pub use bevy_shape as shape;
 pub use bevy_solari as solari;
 #[cfg(feature = "bevy_sprite")]
 pub use bevy_sprite as sprite;
+#[cfg(feature = "bevy_sprite_light")]
+pub use bevy_sprite_light as sprite_light;
 #[cfg(feature = "bevy_sprite_render")]
 pub use bevy_sprite_render as sprite_render;
 #[cfg(feature = "bevy_state")]

crates/bevy_internal/src/prelude.rs

@@ -83,6 +83,10 @@ pub use crate::sprite::prelude::*;
 #[cfg(feature = "bevy_sprite_render")]
 pub use crate::sprite_render::prelude::*;
 
+#[doc(hidden)]
+#[cfg(feature = "bevy_sprite_light")]
+pub use crate::sprite_light::prelude::*;
+
 #[doc(hidden)]
 #[cfg(feature = "bevy_text")]
 pub use crate::text::prelude::*;

crates/bevy_sprite_light/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "bevy_sprite_light"
+version = "0.20.0-dev"
+edition = "2024"
+description = "Provides 2d lighting for Bevy Engine"
+homepage = "https://bevy.org"
+repository = "https://github.com/bevyengine/bevy"
+license = "MIT OR Apache-2.0"
+keywords = ["bevy"]
+rust-version = "1.94.0"
+
+[dependencies]
+bevy_camera = { path = "../bevy_camera", version = "0.20.0-dev" }
+bevy_color = { path = "../bevy_color", version = "0.20.0-dev" }
+bevy_ecs = { path = "../bevy_ecs", version = "0.20.0-dev" }
+bevy_reflect = { path = "../bevy_reflect", version = "0.20.0-dev" }
+bevy_transform = { path = "../bevy_transform", version = "0.20.0-dev" }
+
+[lints]
+workspace = true

crates/bevy_sprite_light/LICENSE-APACHE

@@ -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

crates/bevy_sprite_light/LICENSE-MIT

@@ -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.

crates/bevy_sprite_light/src/ambient_light.rs

@@ -0,0 +1,26 @@
+use bevy_color::Color;
+use bevy_ecs::prelude::*;
+use bevy_reflect::prelude::*;
+
+/// Light applied to every 2d entity.
+///
+/// The default is white at full brightness, so the brightness needs to be turned down in order
+/// for other light sources to take effect.
+#[derive(Resource, Clone, Debug, Reflect)]
+#[reflect(Resource, Debug, Default, Clone)]
+pub struct GlobalAmbientLight2d {
+    /// The color of the ambient light.
+    pub color: Color,
+    /// The brightness of the ambient light. `1.0` is full brightness. `0.0` will result in a
+    /// completely dark scene.
+    pub brightness: f32,
+}
+
+impl Default for GlobalAmbientLight2d {
+    fn default() -> Self {
+        Self {
+            color: Color::WHITE,
+            brightness: 1.0,
+        }
+    }
+}

crates/bevy_sprite_light/src/lib.rs

@@ -0,0 +1,22 @@
+#![forbid(unsafe_code)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+#![doc(
+    html_logo_url = "https://bevy.org/assets/icon.png",
+    html_favicon_url = "https://bevy.org/assets/icon.png"
+)]
+
+//! This crate provides 2d lighting support for the Bevy game engine.
+
+mod ambient_light;
+mod point_light;
+
+pub use ambient_light::GlobalAmbientLight2d;
+pub use point_light::PointLight2d;
+
+/// The 2d lighting prelude.
+///
+/// This includes the most common types in this crate, re-exported for your convenience.
+pub mod prelude {
+    #[doc(hidden)]
+    pub use crate::{GlobalAmbientLight2d, PointLight2d};
+}

crates/bevy_sprite_light/src/point_light.rs

@@ -0,0 +1,32 @@
+use bevy_camera::visibility::Visibility;
+use bevy_color::Color;
+use bevy_ecs::prelude::*;
+use bevy_reflect::prelude::*;
+use bevy_transform::components::Transform;
+
+/// A light that provides illumination in all directions.
+#[derive(Component, Debug, Clone, Copy, Reflect)]
+#[reflect(Component, Default, Debug, Clone)]
+#[require(Transform, Visibility)]
+pub struct PointLight2d {
+    /// The color of the light.
+    pub color: Color,
+    /// The intensity of the light. Higher values make the light brighter.
+    pub intensity: f32,
+    /// The range of the light. Illumination will only occur within the light's range.
+    pub range: f32,
+    /// How quickly illumination from the light should deteriorate over distance.
+    /// A higher falloff value will result in less illumination at the light's maximum radius.
+    pub falloff: f32,
+}
+
+impl Default for PointLight2d {
+    fn default() -> Self {
+        Self {
+            color: Color::WHITE,
+            intensity: 1.0,
+            range: 100.0,
+            falloff: 0.0,
+        }
+    }
+}

crates/bevy_sprite_render/Cargo.toml

@@ -12,6 +12,7 @@ keywords = ["bevy"]
 webgl = []
 webgpu = []
 bevy_text = ["dep:bevy_text", "bevy_sprite/bevy_text"]
+bevy_sprite_light = ["dep:bevy_sprite_light"]
 
 [dependencies]
 # bevy
@@ -29,6 +30,7 @@ bevy_shape = { path = "../bevy_shape", version = "0.20.0-dev" }
 bevy_shader = { path = "../bevy_shader", version = "0.20.0-dev" }
 bevy_material = { path = "../bevy_material", version = "0.20.0-dev" }
 bevy_sprite = { path = "../bevy_sprite", version = "0.20.0-dev" }
+bevy_sprite_light = { path = "../bevy_sprite_light", version = "0.20.0-dev", optional = true }
 bevy_text = { path = "../bevy_text", version = "0.20.0-dev", optional = true }
 bevy_reflect = { path = "../bevy_reflect", version = "0.20.0-dev" }
 bevy_render = { path = "../bevy_render", version = "0.20.0-dev" }