concinnity-engine 0.19.119

Runtime engine for Concinnity: ECS schedule, graphics, spawn, streaming
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

// The world's authored lights, packed once at init into the backend's static
// light data.

use concinnity_core::components::{DirectionalLight, PointLight, RectAreaLight, SpotLight};
use concinnity_core::ecs::PipelineContext;
use concinnity_core::gfx::render_types::LightUniforms;
use concinnity_core::render::lights::{self, DirectionalLightSet, LightData};
use concinnity_core::sky::SkyOrientation;

// Pack every light into the local-light buffers and the shared uniforms, whose
// `ambient_intensity` scales each backend's IBL / flat-fallback ambient. Lights
// are read, not drained, so editor tooling can still address them by name.
pub(super) fn gather_lights(
    ctx: &PipelineContext,
    ambient_intensity: f32,
) -> (LightData, LightUniforms) {
    let dir_lights: Vec<DirectionalLight> = ctx.query::<DirectionalLight>().cloned().collect();
    let pt_lights: Vec<PointLight> = ctx.query::<PointLight>().cloned().collect();
    let spot_lights: Vec<SpotLight> = ctx.query::<SpotLight>().cloned().collect();
    let rect_lights: Vec<RectAreaLight> = ctx.query::<RectAreaLight>().cloned().collect();
    let data = lights::build_light_data(&pt_lights, &spot_lights, &rect_lights);
    let uniforms =
        lights::build_light_uniforms(dir_lights, pt_lights, &data.lights, ambient_intensity);
    (data, uniforms)
}

// Every authored direction carried by the sky's current rotation. A
// directional light is at infinity by definition, so it rides the celestial
// sphere and turns with it. Returned inline so the per-frame extraction that
// calls it under a turning sky allocates nothing.
pub(super) fn lights_under_sky<'a>(
    lights: impl Iterator<Item = &'a DirectionalLight>,
    sky: &SkyOrientation,
) -> DirectionalLightSet {
    DirectionalLightSet::collect(lights.map(|light| DirectionalLight {
        direction: sky.rotate(light.direction),
        ..*light
    }))
}

#[cfg(test)]
mod tests {
    use super::*;
    use concinnity_core::ecs::World;

    // The lights stay resident after packing, and the ambient reaches the uniforms.
    #[test]
    fn lights_are_packed_without_being_drained() {
        let mut world = World::new();
        world.push(PointLight::default());
        world.push(DirectionalLight::default());
        let ctx = world.context();

        let (data, uniforms) = gather_lights(&ctx, 0.25);
        assert_eq!(data.lights.len(), 1);
        assert_eq!(uniforms.ambient_intensity, 0.25);
        assert_eq!(ctx.query::<PointLight>().count(), 1);
        assert_eq!(ctx.query::<DirectionalLight>().count(), 1);
    }

    // A turned sky carries every directional light with it, so the light and
    // whatever body is hung on the same rotation keep agreeing.
    #[test]
    fn the_sky_carries_the_directional_lights_round() {
        let authored = DirectionalLight {
            direction: [0.0, 0.0, 1.0],
            ..Default::default()
        };
        let sky = SkyOrientation::new([1.0, 0.0, 0.0], 90.0);
        let turned = lights_under_sky(std::iter::once(&authored), &sky);
        let turned = turned.as_slice();
        assert_eq!(turned.len(), 1);
        let d = turned[0].direction;
        assert!(d[1] > 0.99, "a quarter turn puts it overhead: {d:?}");
        assert_eq!(turned[0].color, authored.color);
        assert_eq!(turned[0].intensity, authored.intensity);
    }

    // A still sky leaves the authored set exactly as it was.
    #[test]
    fn an_unturned_sky_leaves_the_lights_alone() {
        let authored = DirectionalLight {
            direction: [0.35, 0.55, 1.0],
            ..Default::default()
        };
        let same = lights_under_sky(std::iter::once(&authored), &SkyOrientation::default());
        for k in 0..3 {
            assert!((same.as_slice()[0].direction[k] - authored.direction[k]).abs() < 1e-6);
        }
    }
}