bevy_fast_light 0.9.0

Simple 2D lighting for Bevy focused on performance over features.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

//! Different occluders and modules for rendering.
//!
//! This renders to a scalable texture that uses the red channel for determining if an occluder exists and the green channel for its z-level.
//!
//! This is the second render stage of [`FastLightPlugin`](crate::prelude::FastLightPlugin).

mod node;
mod phase;
mod pipeline;
mod plugin;
mod prepare;

pub(super) mod prelude {
    pub(crate) use super::MeshOccluder;
    pub(super) use super::node::OccluderNode;
    pub(super) use super::phase::DrawOccluder;
    pub(crate) use super::phase::OccluderPhase;
    pub(super) use super::pipeline::OccluderPipeline;
    pub(crate) use super::plugin::{OccluderLabel, OccluderPlugin, OccluderSet};
    pub(crate) use super::prepare::OccluderTextures;
}

use bevy::{ecs::component::Component, render::extract_component::ExtractComponent};

/// Light occluder for 2D environments.
///
/// This is meant to be added to a [`Mesh2d`](bevy::mesh::Mesh2d) which will determine the occluded shape.
///
/// Currently this will occlude all non-ambient light.
///
/// ## Special Case
///
/// This will render [`Sprite`](bevy::sprite::Sprite)s on top of the occluder if they are on the same or a higher z-level which allows the usage as a 2d shadow.
#[derive(Component, ExtractComponent, Clone, Copy, Default)]
pub struct MeshOccluder;