# sensorCommon (shader module)
What every sensor block shares, in WGSL: reading the `sensor` input (viewer, time, flash blinding, goggles power, sweep angle, gain, heading, infrared illuminator), the live pings, the contact under a pixel with its role, per-pixel sensor grain, and the exit every sensor block returns through. Used by all six sensorBlocks shaders (thermal, nightVision, optics, xray, sweep, spectral) and by any sensor block you write.
| Function | What it gives |
|---|---|
| `sn_contact(uv)` | The contact at uv: x role (0 none, 1 you, 2 ally, 3 enemy, 4 elite or boss, 5 pickup, 6 hazard, 7 objective), y how far inside, z moving, w index. |
| `sn_role_cue(col, uv, c, strength, ink, tint)` | Marks the role so things read apart in one colour: you and allies a steady outline with a slow 1 Hz friend-or-foe blink, enemies a bright outline and diagonal hatching, pickups a slow shimmer, hazards a dashed outline. |
| `sn_role_colour(role)` | A role's accent colour for sensors that show colour. |
| `sn_blind_apply(col, ink, sensitivity)` | The flash wash-out (rate-limited by Sensors). |
| `sn_power_apply(col, uv, ink)` | Goggles switching on: instant, tube warm-up, old monitor or digital boot. |
| `sn_grain(uv, rate, cell)` | Fine per-pixel noise, never a whole-screen flicker. |
| `sn_silhouette(uv, px)` | Where an outline belongs. |
| `sn_finish(uv, src, styled)` | Use instead of `sk_finish`: strength, mask and layer mode as styleKit applies them, without the black-stays-black cap (a sensor makes light where the eye saw none). |
```wgsl
// block.yaml: reads: [frame, depth, normal, albedo, "input:sensor"]
// properties.yaml: - { name: in_sensor, type: texture, default: black }
#include "~styleKit.shaders.skCommon"
#include "~sensorBlocks.shaders.sensorCommon"
```
Include it after styleKit's `skCommon`. With nothing published it falls back to safe values (power on, no pings, no contacts).
## Known limits
- At most 32 contacts and 8 pings are in the input.
- Contact shapes are boxes fitted to bounds, so outlines follow the box edge where the silhouette test finds none.
# sensorBlocks
Make your game look like you are seeing it through a sensor: a thermal camera, night vision goggles, x-ray vision, a sonar ping, radar, echolocation, infrared or UV, as styleKit blocks and whole ready-made looks that stack and swap with every Style Cookbook block.
Use it for a thermal scope or night vision goggles in a military or stealth game, found-footage infrared or echolocation in a horror game, a sci-fi scanner that sees through walls, a submarine sonar screen, an airport baggage x-ray, a blacklight party or an infrared landscape photo. Players, enemies and pickups keep reading apart under every sensor. Heat comes from heatSignatures; goggles a player puts on and takes off come from sensorGoggles.
## Five minutes to a sensor look on your own scene
1. **Install.** Search ZeroMind for `sensorBlocks` (or "thermal vision night vision sensor look") and install the package. It brings styleKit, heatSignatures and starterBlocks with it. For goggles each player wears, also install `sensorGoggles`.
2. **Put a look on.** In any script (or `execute`):
```luau
local Sensors = require("~sensorBlocks.Sensors")
Sensors.use("militaryThermal") -- only your own view
```
It shows on the game view at once. `Sensors.looks()` lists every look, `Sensors.blocks()` every block.
3. **Pick the weather heat sits in.**
```luau
require("~heatSignatures.Heat").setClimate("desertDay")
```
4. **Try another sensor.**
```luau
Sensors.use("gen3NightVision")
Sensors.use("submarineSonar")
Sensors.ping(player.position) -- a sonar ring every player sees
Sensors.use("thermalIronbow") -- a single block, no optic
```
5. **Give every player goggles** (sensorGoggles): add one GogglesRig to the scene. Players press N (d-pad up, or the Goggles button on touch) to put them on and B / V to cycle.
```luau
entity.spawn("Goggles").component.add("sensorGoggles.GogglesRig", { modes = { "gen3NightVision", "militaryThermal" } })
```
6. **For every player at once** (a security camera cutscene, a level that is always thermal): `Sensors.use("securityCamera", { shared = true })`. `Sensors.off()` takes any of it away.
From the shell: `zero styleKit list colour` lists the sensor blocks beside the rest, and `zero styleKit check` checks them.
## What is inside
### Blocks (35)
| Family | Blocks | Slot |
|---|---|---|
| Thermal camera | `thermalWhiteHot`, `thermalBlackHot`, `thermalIronbow`, `thermalRainbow`, `thermalArctic`, `thermalLava`, `thermalMedical`, `thermalThreshold` | Colour |
| Night vision | `nvGen1Green` (grainy, blooming), `nvGen2Green` (visible grain and honeycomb), `nvGen3Green` (clean, halos), `nvAutoGated` (gen 3 that dims itself when a bright light comes into view), `nvWhitePhosphor`, `nvCheapDigital`, `nvSecurityIR` (infrared security camera) | Colour |
| Optics | `opticsMonocular`, `opticsBinocular`, `opticsQuad` (four tubes), `opticsScope` (crosshair) | Medium |
| X-ray | `xrayMedical`, `xrayNegative`, `xrayBaggage` (airport false colours), `xraySciFi` (wall scan), `xrayFluoroscope` | Colour |
| Sweeps | `radarSweep`, `sonarPing`, `echolocation`, `laserScan`, `motionTracker` | Colour |
| Other light | `irFilm`, `colourInfrared`, `uvBlacklight`, `spaceFalseColour`, `depthMap`, `electronMicroscope` | Colour |
Blocks of one family share one shader, so every setting of one works on the others and `StyleKit.swap("sensor", "thermalBlackHot")` changes the palette in one call. Each block's README says what it gives up in motion and how it treats transparent things, particles, sky, fog, characters, foliage and world text.
### Looks (24)
`militaryThermal`, `sniperThermal`, `predatorVision`, `medicalThermal`, `gen3NightVision`, `gen2NightVision`, `gen1NightVision`, `autoGatedNightVision`, `quadNightVision`, `horrorInfrared`, `securityCamera`, `sciFiScanner`, `submarineSonar`, `radarOperator`, `echoHorror`, `motionTrackerLook`, `airportScanner`, `medicalXray`, `blacklightParty`, `infraredLandscape`, `aerochrome`, `deepSpace`, `depthCamera`, `labMicroscope`.
### Runtime and guides
| Asset | What it is |
|---|---|
| `Sensors` module | `Sensors.use`, `off`, `tune`, `current`, `ping`, `flash`, `setLocal`, `localState`, `blocks`, `looks`, `status`. |
| `XrayPass` module | One geometry pass for the x-ray blocks (metal flagged per object in a shader-data lane), published as the `xray` and `xrayMetal` inputs. |
| `sensorField` render feature | Per frame: this machine's sensor state, pings and contacts, published as the `sensor` input. |
| `sensorCommon` shader module | What sensor blocks share: `sn_contact`, `sn_role_cue`, `sn_blind_apply`, `sn_power_apply`, `sn_grain`, `sn_finish`. |
| `xrayLayers` shader | The surface shader the x-ray pass draws with. |
| `sensorInk` shader module | Keeps an ink line drawn by a block beneath a sensor as a clear line over the sensor picture (`sn_keep_ink`). |
| `guides/how-to-make-a-sensor-look.guide` | How to make a sensor look, from install to writing your own sensor block. |
| `guides/night-vision-and-thermal-for-a-stealth-or-horror-game.guide` | A worked stealth level (and a horror variant) built step by step. |
| `workflows/sensorWorld.workflow` | Turns an existing scene into a sensor look in stages. |
## Stacking with Style Cookbook blocks
A sensor look is laid over the scene's own stack, never in place of it. A Cookbook ink line, film grain, paper or vignette already in the scene stays where it is in the slot order, so an ink-comic game in night vision keeps its ink line. styleKit runs the Line slot before the Colour slot and every sensor block replaces all colour, so each sensor block reads the frame as it entered the stack (`reads: rendered`), finds the thin strokes the blocks beneath it drew, and lays them back over its own picture as a distinct line: light on a dark sensor (an x-ray film, a night vision tube), dark on a bright one. A broad wash or tint underneath is not a stroke and does not print. Every sensor block's `keepInk` setting turns it down (0) or keeps it fully (1, the default). Sensor blocks sit in the Colour slot (optics in Medium), so they swap only with each other's slot-mates. Locally (`Sensors.use` without `shared`) the sensor entries are this machine's own; the scene's synced stack is untouched. With `shared = true` the sensor blocks replace the scene's other sensor blocks and keep everything else.
## Multiplayer
- **Per player**: which sensor look is on, its settings, goggles power, battery and blinding. One player in night vision never changes what another sees.
- **Shared**: heat (climate, HeatSource, warm prints), sonar pings (`Sensors.ping`) and flashes (`Sensors.flash`, each player is blinded by how much their own view faces it), and anything put on with `shared = true`.
## Players, enemies and pickups read apart
Every sensor marks roles on top of its picture, so they read apart even in one colour:
- **You and allies**: a steady outline and a slow friend-or-foe blink (1 Hz).
- **Enemies** (and elites, bosses, heavier): a bright outline and diagonal hatching inside.
- **Pickups**: a slow shimmer rising through them.
- **Hazards**: a dashed outline.
Roles come from the scene's players (you, and every other player as an ally), from roles a game gives (`StyleRoles.give(e, "enemy")` or `StyleKit.give(e, "pickup")`), then from names: guard, soldier, zombie, monster read as enemy; pickup, loot, ammo, coin, key, medkit as pickup; hazard, mine, trap, laser, camera as hazard; objective, exit, goal as objective. `roleCue` and `roleTint` on each block set how strong the marks are and whether they take each role's own colour. No cue flashes the screen; flash blinding is capped at three full-screen washes a second.
## What it costs
Measured with the engine's own profiler, never wall-clock time. The test scene is the forest showcase with 2,500 extra objects spawned: rocks, plus 312 crates and 50 guards that the name rules tag as cold metal and as enemies, which makes for a heavily tagged scene. sensorBlocks' `SensorBench` module ran it (`SensorBench.run()`, or the showcase panel's "Measure cost on this device" button). Each figure compares a look switched on against no look, in alternating windows taken back to back, and gives the median of the pairs, so a machine whose load drifts still measures the look. The bench also records, in every thermal window, that heatSignatures's render feature was live and drawing the heat buffer, so a stopped feature cannot flatter a number.
- **CPU**: the engine's own per-frame time in the systems a sensor look runs in: the render-feature tick (heat, sensor contacts, styleKit's stack upkeep) and the post-process layer that records the look's passes.
- **GPU**: the look's own passes (styleKit's per-block passes, its shared capture, the x-ray layers) from GPU timestamp queries. The heat buffer draws only the heat sources' meshes at half resolution.
CPU and GPU run side by side, so each has to fit the budget on its own.
### How thermal stays cheap
Since 1.0.5 heat is drawn on the GPU. heatSignatures's HeatPass draws every heat source's own meshes into a screen "heat buffer" in one geometry pass, each object carrying its temperature, emissivity and edge cooling in a per-instance shader-data lane. The thermal shader reads the buffer where a source is the surface seen, which gives exact outlines and correct occlusion. Scripts no longer read where anything is to draw heat. Temperatures move five times a second, the heat pass regroups its objects at most about three times a second (or when the camera turns), and the sensor runtime packs its contacts every third frame. Name scans, new sources and clean-up are spread over frames, and the climate is cached. The x-ray draws all its layers and its metal layer in one geometry pass.
### Desktop (native app, Linux, 1920x1080, 2,500 extra objects, styleKit 1.8.2)
Measured on sensorBlocks 1.0.7. 1.0.8 and 1.0.9 changed only documentation, so the code these numbers describe is the code in 1.0.9.
`SensorBench.run()`, the way the showcase panel's button runs it. Every look's CPU median below comes from a single run of all six looks with 8 window pairs each; thermal and night vision are also given as the combined median of 23 window pairs across three separate runs, because a single run of 5 to 10 pairs still moves between attempts on this machine (see "About the spread" below).
| Look | CPU added per frame, 8-pair run | CPU, 23-pair combined | GPU, look's passes |
|---|---|---|---|
| Airport scanner (x-ray) | 0.52 ms | - | 0.21 ms |
| Sci-fi scanner (x-ray + laser scan) | 0.62 ms | - | 0.58 ms |
| Gen-3 night vision | 0.64 ms | 0.62 ms | 0.59 ms |
| Submarine sonar | 0.75 ms | - | 0.76 ms |
| Horror infrared | 0.71 ms | - | 0.67 ms |
| Military thermal (heat verified live in every window measured) | 0.94 ms | 1.28 ms | 0.50 ms |
Every look's GPU time, and every look's CPU on a single favourable run, is under 1 ms. Night vision's CPU stays under 1 ms over the larger, combined sample too. **Thermal's does not**: aggregated over 23 window pairs, taken across three separate runs minutes apart, its CPU median is 1.28 ms, a quarter above target on this machine. Thermal costs the most of any look because it keeps temperatures moving and regroups the heat buffer's objects as well as running the stack; its GPU time is still the lowest of the six.
**About the spread.** Desktop CPU timings from `profiler.cost` swing by several times between runs of the same look on an otherwise idle engine (confirmed with `zero client list` showing nothing else running and 36 GB of memory free): thermal's own windows in this session ranged from 0.02 to 2.91 ms, and whole-run medians from 0.94 to 1.31 ms. A measurement taken independently on the same showcase read 0.70 ms for thermal and 0.64 ms for night vision, inside that range but at its low end. This is filed as platform feedback (`zeromind.issue` id 01M7AS1YXJ7NXR5MA410SE2YZS, "profiler.cost per-frame CPU delta swings 5-10x run to run on an otherwise idle engine"); there is no numbered tracked issue to cite yet. Cross-checked with the Luau sampling profiler, summing only this look's own functions over an 8 s window, thermal's attributable script time worked out to about 0.86 ms a frame, consistent with the lower end of the `profiler.cost` runs. Run the bench several times yourself and look at the spread rather than trusting one run, on either side of a close call like thermal's.
The GPU column reads GPU timestamps every few frames through each look's whole window and takes the median; it has read steadily across every run in this session.
### Browser
**This version (1.0.9) has not been measured in a browser, and neither have 1.0.3 to 1.0.8.** The only browser numbers that exist are from **sensorBlocks 1.0.2**, and they describe old code, not this version:
- sensorBlocks 1.0.2, Chrome with WebGPU, 1282x772: about 1.4 ms of CPU for night vision, 2.5 to 3.2 ms for thermal, and 0.02 to 0.19 ms of GPU per look.
- That tab also ran an older styleKit and drew thermal without per-object heat, and every saving made since 1.0.2 (the GPU heat buffer, the single-pass x-ray, the lighter runtime) came after it.
Do not read them as what 1.0.9 costs in a browser. To measure it yourself, open the showcase in a browser, press Play and press the panel's "Measure cost on this device" button; the result shows on every player's screen.
### Flashes
Nothing washes the whole screen more than three times a second. `Sensors.flash` starts at most three new full-screen washes a second, and every flicker in the blocks is per pixel or per band, never the whole frame.
## Known limits
- **Engine bug, custom surface shaders (current engine, @builtin 024ebe5):** a custom surface shader that has to be compiled fresh fails with `#include of unknown shader module "zero::projection"` (reported to the platform: 01M7ASW2G6RQ35N3H1DF9B94ZP, corrected by 01M7AV5R97GJHWXB4019TT3E65). sensorBlocks' x-ray layers (`xrayLayers`) and heatSignatures' heat buffer (`heatObj`) are custom surface shaders. Where the engine already holds their compiled program they draw as described here; where it has to compile them fresh they fail, and then the x-ray looks show no see-through layers and thermal falls back to its soft heat shapes, so warm people and fires still read hot but with softer outlines. Every post-process sensor block is unaffected.
- A world that already holds an older styleKit (from the Style Cookbook) can end up with a second copy pinned for sensorBlocks; the sensor look then shows but heat and contacts stay off. Update the world's styleKit to 1.8.0 and install sensorBlocks again so the two copies collapse into one.
- Heat shapes are boxes or ellipsoids fitted to bounds; at most the 64 nearest heat shapes, 32 contacts and 8 pings are drawn.
- The data textures fall back to rgba16f where the preferred float format is missing.
- Transparent things (glass, water) are not in the depth, so sensors show what is behind them.
- The stack runs on the presented frame after antialiasing: offscreen captures, mirrors and render-to-texture cameras do not show it (capture with `source = "presented"`).
- X-ray counts surfaces along each ray, not real density or thickness.
- Players who join late miss pings, flashes and warm prints sent before they joined.
- Reflectance in infrared and UV is guessed from base colour, not from real material data.
- Looks that use grain, vignette or pixels need starterBlocks installed; a look with a missing block is refused.
## Version history
- **1.0.9**: the browser section says plainly that the only browser numbers are from sensorBlocks 1.0.2 and that this version has not been measured in a browser; Known limits names the engine bug that can keep the x-ray layers from compiling; built against heatSignatures 1.0.8.
- **1.0.8**: What it costs rewritten with an honest spread (a combined, larger sample; where the number moves and why); the run-to-run CPU noise reported to the platform rather than cited to an unverified issue number.
- **1.0.7**: SensorBench keeps asking for GPU timings through every look's window, so its GPU column reports on a fresh run (it often came back empty); What it costs re-measured (every look under 1 ms of CPU and of GPU on desktop) with the run-to-run spread explained; version history without dates.
- **1.0.6**: night vision gains gen 2 green (`nvGen2Green`) and an auto-gated block (`nvAutoGated`, a tube that dims itself when a bright light comes into view; any night vision block can turn on `autoGate`), with the looks `gen2NightVision` and `autoGatedNightVision`; an ink line drawn by a block beneath a sensor (a Style Cookbook line) is kept as a clear line over every sensor block (`sensorInk`, `keepInk`, `reads: rendered`); the x-ray draws all layers and the metal layer in one geometry pass with metal flagged per object in a shader-data lane (airport scanner 1.64 to 0.95 ms CPU on desktop); the sensor runtime packs every third frame; SensorBench reads GPU timings over several frames per window (the GPU column came back empty for most looks); heat comes from heatSignatures (heatKit's new name).
- **1.0.5**: heat drawn on the GPU (heatSignatures's HeatPass: one geometry pass into a heat buffer, each object's heat in a shader-data lane; thermal blocks read `input:heatObj`); scripts keep only soft shapes for prints, radiant warmth and mesh-less sources; heat tick every fourth frame on heatSignatures's own clock; scans, new sources and clean-up spread over frames; climate cached; heatSignatures's render feature restarts itself if the engine stops it; styleKit 1.8.1; SensorBench checks that heat was live in every thermal window.
- **1.0.4**: lighter per-frame work: name scans use the engine's own name search and remember each name stem; moving heat sources and contacts are read from the engine every fourth frame and dead-reckoned in between; the heat tick keeps separate moving and still lists and runs once a second when no look needs heat; 40 heat shapes and 16 contacts drawn (smaller data textures); the climate component no longer runs every frame; SensorBench measures in alternating look-on and look-off windows and reports the median; What it costs updated with desktop and browser numbers.
- **1.0.3**: What it costs adds the browser numbers, measured with SensorBench in a browser tab (two runs), beside the desktop ones.
- **1.0.2**: fixes the gen-3 night vision look, whose look file was damaged in 1.0.1 so styleKit could not read it; heat and contact data are uploaded every other frame; x-ray thickness passes draw at half resolution (the airport scanner went from 4.5 to 0.24 ms of GPU with 2,500 objects); the name scans run every ten seconds; each runtime keeps asking for styleKit until it answers; SensorBench (measure a look's engine CPU and GPU cost on this device); What it costs measured as the engine's own per-system CPU and per-pass GPU time.
- **1.0.1**: a shared clock every machine agrees on for heat prints and pings (ages never step back); per-frame work trimmed (reused arrays, static heat sources updated a slice at a time, only heat shapes in view and worth drawing are packed, lighter night vision shader); `Heat.of` reads player bodies; `Sensors.use(look, { shared = true })` makes the scene's style stack when there is none; What it costs section.
- **1.0.0**: first release. 33 sensor blocks in six families, 22 looks, the Sensors runtime with per-player looks, shared pings and rate-limited flashes, role cues for players, enemies, pickups and hazards, x-ray passes, two guides and the sensorWorld workflow.