bevy_fast_light 0.8.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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

/*
 * Heavily inspired by:
 * - https://bevy.org/examples/shaders/custom-post-processing/
 */

//! [`Plugin`] for rendering lights to the screen texture.

use bevy::{
    app::{App, Plugin},
    asset::embedded_asset,
    core_pipeline::core_2d::graph::Core2d,
    ecs::schedule::IntoScheduleConfigs as _,
    render::{
        ExtractSchedule, Render, RenderApp, RenderDebugFlags, RenderStartup, RenderSystems,
        batching::no_gpu_preprocessing::batch_and_prepare_sorted_render_phase,
        extract_component::UniformComponentPlugin,
        extract_resource::ExtractResourcePlugin,
        render_graph::{RenderGraphExt, RenderLabel, ViewNodeRunner},
        render_phase::{
            AddRenderCommand as _, DrawFunctions, SortedRenderPhasePlugin, ViewSortedRenderPhases,
            sort_phase_system,
        },
        render_resource::SpecializedMeshPipelines,
    },
    shader::load_shader_library,
    sprite_render::{Mesh2dPipeline, init_mesh_2d_pipeline},
};

use crate::{light::prelude::*, plugin::prelude::*};

/// [`Plugin`] for rendering lights to the screen texture.
pub(crate) struct Light2dPlugin;
impl Plugin for Light2dPlugin {
    fn build(&self, app: &mut App) {
        load_shader_library!(app, "types.wgsl");
        embedded_asset!(app, "light_2d.wgsl");
        embedded_asset!(app, "light_2d_composite.wgsl");

        app.add_plugins((
            SortedRenderPhasePlugin::<Light2dPhase, Mesh2dPipeline>::new(
                RenderDebugFlags::default(),
            ),
            ExtractResourcePlugin::<FastLightSettings>::default(),
            UniformComponentPlugin::<ExtractedAmbientLight2d>::default(),
        ));

        let Some(render_app) = app.get_sub_app_mut(RenderApp) else {
            return;
        };

        render_app
            .init_resource::<DrawFunctions<Light2dPhase>>()
            .init_resource::<SpecializedMeshPipelines<Light2dPipeline>>()
            .init_resource::<ViewSortedRenderPhases<Light2dPhase>>()
            .init_resource::<Light2dTextures>()
            .init_resource::<Light2dFragmentBindGroups>()
            .init_resource::<Light2dUniformBuffers>();

        render_app.add_render_command::<Light2dPhase, DrawLight2d>();

        render_app.add_systems(
            RenderStartup,
            (
                super::pipeline::init_light_2d_pipeline.after(init_mesh_2d_pipeline),
                super::pipeline::init_light_2d_composite_pipeline,
            ),
        );

        render_app.add_systems(
            ExtractSchedule,
            (
                super::extract::extract_light_2d_view_entities,
                super::extract::extract_ambient_light,
                super::extract::extract_mesh_lights,
            ),
        );

        render_app.add_systems(
            Render,
            (
                super::phase::queue_light_2ds.in_set(RenderSystems::Queue),
                sort_phase_system::<Light2dPhase>.in_set(RenderSystems::PhaseSort),
                (
                    batch_and_prepare_sorted_render_phase::<Light2dPhase, Light2dPipeline>,
                    super::prepare::prepare_light_2d_texture,
                    (
                        super::prepare::prepare_light_2d_buffers,
                        super::prepare::prepare_light_2d_fragment_bind_groups,
                    )
                        .chain(),
                )
                    .in_set(RenderSystems::PrepareResources),
            ),
        );

        render_app
            .add_render_graph_node::<ViewNodeRunner<Light2dNode>>(Core2d, Light2dLabel)
            .add_render_graph_node::<ViewNodeRunner<Light2dCompositeNode>>(
                Core2d,
                Light2dCompositeLabel,
            );
    }
}

/// Label for render graph edges for [`Light2dNode`].
#[derive(Debug, Hash, PartialEq, Eq, Clone, RenderLabel)]
pub(crate) struct Light2dLabel;

/// Label for render graph edges for [`Light2dCompositeNode`].
#[derive(Debug, Hash, PartialEq, Eq, Clone, RenderLabel)]
pub(crate) struct Light2dCompositeLabel;