Contract and docs text describe the ports and the Cesium renderer only

This commit is contained in:
Sameh Khamis committed 2026-11-15 19:08:46 -08:00
1 parent 1fdf52198d
commit 9862b2a165
31 files changed
+80 -85

No files matched your search

+2 -2
View File
@@ -370,8 +370,8 @@ export interface NativeCamera {
}
/**
* A camera controller, as an application hands one to a renderer without a
* camera of its own (or in place of its own): given the native camera, the
* A camera controller, handed to a renderer in place of its own camera:
* given the native camera, the
* input port's pointer events and the page's keys, it makes the camera port.
* The renderer runs `frame.beforeUpdate` before its `preUpdate` listeners
* and `frame.afterUpdate` after them, each tick, drawn or not.
+1 -1
View File
@@ -219,7 +219,7 @@ test('a draw set’s events: ready with the id, loadFailed with the id and why',
});
test('members added to version 0 later are optional, each behind its capability', () => {
// A renderer written before an addition still conforms without it.
// A renderer conforms without them.
assert.equal(PORTS.globe.isGlobeVisible, 'globeVisibility');
assert.equal(PORTS.camera.followFrame, 'followFrame');
// Item fields added later are optional too.
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* Full-screen effects: visual styles, bloom, sharpen and screen modulation.
* Each style is a plain full-screen pass over the frame's colour. The
* Each style is a plain full-screen pass over the frame's colour. The application owns
* application owns the styles and defines them on the renderer
* renderer runs the same set; a renderer's own styles are extra ones.
*/
+1 -2
View File
@@ -285,8 +285,7 @@ export interface LoadProgress {
/**
* `surface`: what `against: 'surface'` heights answer from has loaded what
* is in view: the terrain while the globe is shown, otherwise the drawn
* tiles; false when neither is drawn. A renderer that predates it answers
* as `base`.
* tiles; false when neither is drawn.
*/
export type SettleKind = 'base' | 'tiles' | 'terrain' | 'imagery' | 'surface';
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* The renderer contract: what the application asks of a renderer, typed
* than the default one can draw the same application.
* one file per port.
*/
export * from './common';
export * from './renderer';
+2 -2
View File
@@ -173,8 +173,8 @@ export interface Renderer {
releaseUnused(): void;
on(event: 'error', cb: (error: Error) => void): Off;
/**
* The drawing context was lost, or came back. Where the renderer cannot
* restore its context it never sends `contextRestored`; the application
* The drawing context was lost, or came back. A renderer that cannot restore its context
* never sends `contextRestored`; the application then makes
* a new renderer.
*/
on(event: 'contextLost' | 'contextRestored', cb: () => void): Off;