MeshField

240,000 solids across a foggy plain, culled on the GPU per copy (MeshField/drawMeshField; flip the parameter to see what culling saves)

Run

swift run --package-path Examples Example-Rendering-MeshField

Source

Examples/Rendering/MeshField/Sketch.swift

import Ollin

/// A quarter of a million solids in ONE call a frame. `setup()` scatters five
/// kinds of mesh across a wide plain and places every copy into a `MeshField`;
/// `draw()` just says `drawMeshField(field)`. The GPU tests each copy against
/// the camera every frame and draws only what the low, flying viewpoint can
/// see, so the far side of the plain costs (almost) nothing. Fog swallows the
/// horizon, and every visible copy still drops a real shadow.
///
/// Flip the **culling** parameter off to make the GPU draw all 240,000 copies
/// regardless, and watch the frame rate: that gap is everything the camera
/// couldn't see. The picture itself must not change, which is the whole point:
/// culling skips only what was invisible anyway.
@main
final class MeshFieldSketch: Sketch {

    @Param var culling = true

    private let field = MeshField()

    override func setup() {
        seed(4_242)
        let reach = 280.0

        func scatter(_ count: Int, make: (Double, Double) -> MeshInstance) -> [MeshInstance] {
            var copies: [MeshInstance] = []
            copies.reserveCapacity(count)
            for _ in 0 ..< count {
                copies.append(make(random(-reach, reach), random(-reach, reach)))
            }
            return copies
        }

        let stoneGray = Color(hue: 0.08, saturation: 0.08, brightness: 0.62)
        let mossGreen = Color(hue: 0.32, saturation: 0.45, brightness: 0.5)
        let pineGreen = Color(hue: 0.36, saturation: 0.55, brightness: 0.42)

        // Low stones, everywhere.
        field.place(Mesh.box(width: 0.5, height: 0.35, depth: 0.5),
                    at: scatter(90_000) { x, z in
            MeshInstance(position: Vector3(x, 0.17, z),
                         rotation: Vector3(0, random(.tau), 0),
                         scale: random(0.5, 1.6),
                         color: Color.mix(stoneGray, mossGreen, random(0.5)))
        })
        // Shrubs.
        field.place(Mesh.sphere(radius: 0.3, segments: 10, rings: 6),
                    at: scatter(80_000) { x, z in
            MeshInstance(position: Vector3(x, 0.24, z),
                         scale: Vector3(random(0.7, 1.4), random(0.5, 0.9), random(0.7, 1.4)),
                         color: Color.mix(mossGreen, pineGreen, random(1)))
        })
        // Pines.
        field.place(Mesh.cone(radius: 0.55, height: 2.2, segments: 10),
                    at: scatter(50_000) { x, z in
            MeshInstance(position: Vector3(x, 1.1, z),
                         scale: Vector3(1, random(0.7, 1.8), 1),
                         color: Color.mix(pineGreen, mossGreen, random(0.6)))
        })
        // Boulders.
        field.place(Mesh.sphere(radius: 0.7, segments: 12, rings: 8),
                    at: scatter(15_000) { x, z in
            MeshInstance(position: Vector3(x, 0.45, z),
                         scale: Vector3(random(0.8, 1.6), random(0.6, 1.1), random(0.8, 1.6)),
                         color: stoneGray)
        })
        // Standing stones, rare and tall.
        field.place(Mesh.box(width: 0.45, height: 3.2, depth: 0.3),
                    at: scatter(5_000) { x, z in
            MeshInstance(position: Vector3(x, 1.6, z),
                         rotation: Vector3(random(-0.05, 0.05), random(.tau), random(-0.05, 0.05)),
                         scale: random(0.7, 1.3),
                         color: Color.mix(stoneGray, Color(white: 0.7), random(0.5)))
        })
    }

    override func draw() {
        background(Color(hex: 0x0D1017))
        field.isCullingEnabled = culling

        // A low circuit over the plain: forward along the path, looking ahead,
        // with a near horizon the fog closes.
        let t = time * 0.05
        let eye = Vector3(cos(t * .tau) * 130, 4.2, sin(t * .tau) * 130)
        let ahead = Vector3(cos(t * .tau + 0.12) * 128, 1.4, sin(t * .tau + 0.12) * 128)
        camera(Camera3D(eye: eye, target: ahead, far: 110))

        ambientLight(Color(white: 0.16))
        directionalLight(Color(hue: 0.09, saturation: 0.2, brightness: 1.0),
                         direction: Vector3(-0.45, -0.8, -0.4), intensity: 1.0)
        directionalLight(Color(white: 0.45), direction: Vector3(0.5, 0.35, 0.55), intensity: 0.25,
                         castsShadow: false)   // a fill: one shadow pass, not two
        castShadows()
        fog(Color(hex: 0x0D1017), density: 0.042)

        withState {
            fill(Color(hue: 0.3, saturation: 0.2, brightness: 0.32))
            specular(0.03)
            drawPlane(width: 580, depth: 580)
        }

        specular(0.12)
        specularSharpness(24)
        drawMeshField(field)

        drawCaption("MeshField: 240,000 solids, one call, GPU-culled")
    }
}