Drive the visual styles, bloom and sharpen through the effects port

VisualEffects defines each preset on the renderer and keeps its own
records of intensities and parameters, written through to the port, so
crossfades, the anime sky fade, bloom and sharpen behave as before. The
renderer animates the animated styles. Sensor picks read the style
records instead of the renderer's stages. The application renderer now
has the effects port and its capabilities.
This commit is contained in:
Sameh Khamis committed 2026-11-06 16:32:49 -08:00
1 parent bbda6dd0a1
commit 6a7905fc49
18 files changed
+375 -186

No files matched your search

+119 -28
View File
@@ -1,6 +1,8 @@
import assert from 'node:assert/strict';
import test from 'node:test';
import { VisualEffects } from './visualEffects.js';
import { createCesiumEffects } from '../render/cesium/effects.js';
import { styleStagesOf } from '../styles/styleStages.js';
import { MILKY_WAY_INTENSITY, StarrySky } from '../sky/starrySky.js';
import {
GLOBAL_POST_DEFAULTS,
@@ -14,9 +16,10 @@ function fixture() {
const frames = new Map();
const stages = new Set();
const holds = new Set();
const portHolds = new Set();
const requests = [];
const bloom = {
enabled: true,
enabled: false,
uniforms: {
glowOnly: true,
contrast: 3,
@@ -36,10 +39,33 @@ function fixture() {
return stages.delete(stage);
},
};
const effects = new VisualEffects({
viewer: {
scene: { postProcessStages: pipeline, skyBox: { milkyWayVisibility: 1 } },
const scene = {
postProcessStages: pipeline,
skyBox: { milkyWayVisibility: 1 },
};
const preRender = new Set();
const renderer = createCesiumEffects(scene, {
capabilities: new Set(['styles', 'bloom', 'sharpen']),
frame: {
on(phase, cb) {
preRender.add(cb);
return () => preRender.delete(cb);
},
holdContinuous(reason) {
const hold = {};
portHolds.add(hold);
return () => portHolds.delete(hold);
},
requestRender() {},
},
report: (error) => {
throw error;
},
createStage: (options) => ({ ...options, enabled: true }),
});
const effects = new VisualEffects({
effects: renderer.port,
viewer: { scene },
requestRender: (reason) => requests.push(reason),
holdRender: (reason) => holds.add(reason),
releaseRender: (reason) => holds.delete(reason),
@@ -50,8 +76,6 @@ function fixture() {
},
cancelFrame: (id) => frames.delete(id),
now: () => time,
wallNow: () => 10_000 + time,
createStage: (options) => ({ ...options, enabled: true }),
});
function tick(value) {
time = value;
@@ -59,11 +83,20 @@ function fixture() {
frames.clear();
for (const callback of pending) callback();
}
/** The renderer's stage for a style, or sharpen. */
const stage = (name) =>
[...stages].find(
(s) => s.name === `effects_style_${name}` || s.name === `effects_${name}`,
);
return {
effects,
renderer,
frames,
stages,
stage,
holds,
portHolds,
preRender,
requests,
bloom,
originalBloom,
@@ -86,7 +119,10 @@ test('construction is inert and initialization creates one owned pipeline', () =
f.effects.initStyles();
f.effects.initPostProcess();
assert.equal(f.stages.size, 6);
assert.ok([...f.stages].every((stage) => !stage.enabled));
assert.equal(styleStagesOf(f.effects.viewer.scene), f.effects.stages);
f.effects.destroy();
assert.equal(styleStagesOf(f.effects.viewer.scene), null);
});
test('crossfade uses the established 500ms easing and settles without idle frames', () => {
@@ -104,6 +140,8 @@ test('crossfade uses the established 500ms easing and settles without idle frame
assert.equal(f.effects.stages.noir.uniforms.intensity, 0.125);
f.tick(250);
assert.equal(f.effects.stages.noir.uniforms.intensity, 0.5);
assert.equal(f.stage('noir').uniforms.intensity, 0.5);
assert.equal(f.stage('noir').enabled, true);
f.tick(500);
assert.equal(f.effects.stages.noir.uniforms.intensity, 1);
assert.equal(f.effects.transitions.size, 0);
@@ -132,32 +170,82 @@ test('a superseding transition starts from the current rendered intensity', () =
f.effects.destroy();
});
test('only visible animated stages keep the animation clock and render hold alive', () => {
test('only visible animated stages keep the renderer’s clock and hold alive', () => {
const f = fixture();
f.effects.initStyles();
const animated = f.effects.stages.retro;
assert.notEqual(animated.uniforms.time, undefined);
f.effects.setStageIntensity(animated, 1);
f.tick(1000);
assert.equal(animated.uniforms.time, 1);
assert.equal(f.frames.size, 1);
assert.equal(f.holds.size, 1);
assert.equal(f.portHolds.size, 1);
for (const cb of f.preRender) cb({ now: performance.now() + 1000 });
assert.ok(f.stage('retro').uniforms.time > 0.9);
assert.equal(f.frames.size, 0, 'no frames of its own');
f.effects.setStageIntensity(animated, 0);
f.tick(1100);
assert.equal(f.frames.size, 0);
assert.equal(f.portHolds.size, 0);
assert.equal(f.holds.size, 0);
f.effects.destroy();
});
test('a crossfade draws both styles until the old one reaches 0', () => {
const f = fixture();
f.effects.initStyles();
f.effects.setStageIntensity(f.effects.stages.noir, 1);
f.effects.startTransition('noir', 1, 0);
f.effects.startTransition('thermal', 0, 1);
f.tick(250);
assert.equal(f.stage('noir').enabled, true);
assert.equal(f.stage('thermal').enabled, true);
assert.equal(f.stage('noir').uniforms.intensity, 0.5);
assert.equal(f.stage('thermal').uniforms.intensity, 0.5);
f.tick(500);
assert.equal(f.stage('noir').enabled, false);
assert.equal(f.stage('thermal').enabled, true);
// Back again before the first fade-in ends: all three may draw at once.
f.effects.startTransition('thermal', 1, 0);
f.effects.startTransition('noir', 0, 1);
f.tick(600);
f.effects.startTransition('retro', 0, 1);
f.tick(700);
assert.deepEqual(
['retro', 'thermal', 'noir'].map((name) => f.stage(name).enabled),
[true, true, true],
);
f.tick(1300);
assert.deepEqual(
Object.entries(f.effects.stages)
.filter(([, stage]) => stage.enabled)
.map(([name]) => name)
.sort(),
['noir', 'retro'],
);
assert.deepEqual(
['retro', 'thermal', 'noir'].map((name) => f.stage(name).enabled),
[true, false, true],
);
f.effects.destroy();
});
test('style parameters are written through to the renderer', () => {
const f = fixture();
f.effects.initStyles();
assert.equal(f.effects.stages.thermal.uniforms.pixelation, 1.5);
f.effects.stages.thermal.uniforms.pixelation = 4;
assert.equal(f.stage('thermal').uniforms.pixelation, 4);
assert.equal(f.effects.stages.thermal.uniforms.pixelation, 4);
assert.equal(f.effects.stages.thermal.uniforms.unknown, undefined);
f.effects.destroy();
});
test('direct Cockpit intensity writes are reconciled before rendering', () => {
const f = fixture();
f.effects.initStyles();
f.effects.stages.thermal.uniforms.intensity = 1;
f.effects.syncStagesEnabledFromIntensity();
assert.equal(f.effects.stages.thermal.enabled, true);
assert.equal(f.stage('thermal').enabled, true);
f.effects.stages.thermal.uniforms.intensity = 0;
f.effects.syncStagesEnabledFromIntensity();
assert.equal(f.effects.stages.thermal.enabled, false);
assert.equal(f.stage('thermal').enabled, false);
f.effects.destroy();
});
@@ -199,8 +287,11 @@ test('bloom retains its dead zone, normalized intensity and independent toggle',
f.effects.setBloomEnabled(true);
f.effects.applyBloomIntensity(0);
assert.equal(f.bloom.enabled, false);
f.effects.applyBloomIntensity(12);
assert.equal(f.bloom.enabled, false, 'the dead zone');
f.effects.applyBloomIntensity(200);
assert.equal(f.bloom.enabled, true);
assert.equal(f.bloom.uniforms.glowOnly, false);
assert.equal(f.bloom.uniforms.contrast, 87);
f.effects.setBloomEnabled(false);
assert.equal(f.effects.bloomIntensity, 200);
@@ -213,14 +304,14 @@ test('bloom retains its dead zone, normalized intensity and independent toggle',
test('sharpen uses the existing uniform scale and keeps values while disabled', () => {
const f = fixture();
f.effects.initPostProcess(0.49);
assert.equal(f.effects.sharpenStage.uniforms.amount, 1.08);
assert.equal(f.stage('sharpen').uniforms.amount, 1.08);
f.effects.applySharpenIntensity(1);
f.effects.setSharpenEnabled(true);
assert.equal(f.effects.sharpenStage.uniforms.amount, 2.1);
assert.equal(f.effects.sharpenStage.enabled, true);
assert.equal(f.stage('sharpen').uniforms.amount, 2.1);
assert.equal(f.stage('sharpen').enabled, true);
f.effects.setSharpenEnabled(false);
assert.equal(f.effects.sharpenIntensity, 1);
assert.equal(f.effects.sharpenStage.enabled, false);
assert.equal(f.stage('sharpen').enabled, false);
f.effects.destroy();
});
@@ -228,17 +319,13 @@ test('sharpen at 0 runs no pass, and comes back with the slider', () => {
const f = fixture();
f.effects.initPostProcess(0.49);
f.effects.setSharpenEnabled(true);
assert.equal(f.effects.sharpenStage.enabled, true);
assert.equal(f.stage('sharpen').enabled, true);
f.effects.applySharpenIntensity(0);
assert.equal(
f.effects.sharpenStage.enabled,
false,
'no residual sharpen at 0',
);
assert.equal(f.stage('sharpen').enabled, false, 'no residual sharpen at 0');
f.effects.setSharpenEnabled(true);
assert.equal(f.effects.sharpenStage.enabled, false, 'on at 0 is still off');
assert.equal(f.stage('sharpen').enabled, false, 'on at 0 is still off');
f.effects.applySharpenIntensity(0.2);
assert.equal(f.effects.sharpenStage.enabled, true);
assert.equal(f.stage('sharpen').enabled, true);
f.effects.destroy();
});
@@ -262,13 +349,17 @@ test('stop revokes pending work immediately but retains stages until final destr
assert.equal(f.frames.size, 0);
assert.equal(f.effects.stages.retro.uniforms.intensity, intensity);
f.effects.destroy();
assert.equal(f.stages.size, 1, 'the styles go; sharpen is the renderer’s');
assert.equal(f.stage('sharpen').enabled, false);
assert.equal(f.bloom.enabled, false);
f.effects.destroy();
f.renderer.dispose();
assert.equal(f.stages.size, 0);
assert.deepEqual(
f.bloom,
f.originalBloom,
'borrowed bloom configuration is restored',
'the renderer gives the bloom configuration back',
);
f.effects.destroy();
});
test('destroying one instance does not remove another pipeline or clock', () => {