Requirements

Requirements, specifications and tests are tracked with sphinx-needs. Each item has an ID, a status and links to the items it refines, implements or verifies.

Type

Prefix

Links

Requirement

REQ_

Specification

SPEC_

implements a requirement

Test

TEST_

verifies a specification or requirement; gtest names the GoogleTest case

Statuses: draft, open, implemented, verified.

Note

This section is at an early stage. The items below are a starting set that shows the structure; they are not a complete specification of the engine.

Overview

ID

Title

Type

Status

Implements

Verifies

REQ_DEPTH_CONTROLS

Independent depth controls

req

implemented

REQ_DEPTH_METHODS

Selectable Gaussian surface estimate

req

implemented

REQ_DEPTH_PATHS

Depth lifetime and paths

req

implemented

REQ_DEPTH_SHARED

Optional shared depth

req

implemented

REQ_GRAPH_CHAIN_ORDER

Ordered execution of compiled graphs

req

implemented

REQ_GRAPH_CHAIN_PATHS

Separate paths in flight

req

implemented

REQ_GRAPH_CHAIN_REPEAT

Repeated graphs

req

implemented

REQ_GRAPH_CHAIN_REUSE

Reusable chains

req

implemented

REQ_GRAPH_CHAIN_SHARED_DATA

Data shared between graphs

req

implemented

REQ_GRAPH_PARALLEL_QUEUES

Parallel execution on several queues

req

open

REQ_GRAPH_PATHS

Multiple execution paths

req

implemented

REQ_GRAPH_PRERECORDED

Compiled before use

req

implemented

REQ_GRAPH_SHARED_OUTPUTS

Outputs shared across queues

req

implemented

REQ_GRAPH_THREADS

Use from several threads

req

implemented

REQ_GSPLAT_BACKENDS

Interchangeable splatting backends

req

implemented

REQ_IMAGE_ALPHA_CONSISTENCY

Consistent transparent image composition

req

open

REQ_IMAGE_CLEAR_COLOR

Configurable clear color

req

implemented

REQ_IMAGE_COMPOSITE

Image composition and placement

req

implemented

REQ_IMAGE_DEFAULT_CLEAR

Default frame contents

req

implemented

REQ_IMAGE_GSPLAT_OVER

Gaussian rendering over a background

req

implemented

REQ_IMAGE_PRESERVE

Preserve existing contents

req

implemented

REQ_IMAGE_PRESERVE_REUSE

Repeated rendering with preserved contents

req

open

REQ_IMAGE_SHARED_PATHS

One image shared by execution paths

req

implemented

SPEC_DEPTH_ATTACHMENT

Native depth attachment and GPU transfers

spec

implemented

REQ_DEPTH_CONTROLS; REQ_DEPTH_PATHS; REQ_DEPTH_SHARED

SPEC_DEPTH_METHODS

Gaussian depth selection

spec

implemented

REQ_DEPTH_METHODS

SPEC_GRAPH_CHAIN_BUFFERS

Reuse shared buffer allocations

spec

implemented

REQ_GRAPH_CHAIN_PATHS; REQ_GRAPH_CHAIN_SHARED_DATA

SPEC_GRAPH_CHAIN_REPEAT

Simultaneous use for repeated graph paths

spec

implemented

REQ_GRAPH_CHAIN_REPEAT

SPEC_GRAPH_CHAIN_SUBMIT

Submit the chain as one batch

spec

implemented

REQ_GRAPH_CHAIN_ORDER; REQ_GRAPH_CHAIN_PATHS; REQ_GRAPH_CHAIN_REUSE; REQ_GRAPH_PRERECORDED

SPEC_GRAPH_ORDER

Topological ordering with Kahn's algorithm

spec

implemented

REQ_GRAPH_PRERECORDED

SPEC_IMAGE_CLEAR

Image clearing

spec

implemented

REQ_IMAGE_CLEAR_COLOR; REQ_IMAGE_DEFAULT_CLEAR; REQ_IMAGE_PRESERVE

SPEC_IMAGE_COMPOSITE

Composite an image

spec

implemented

REQ_IMAGE_COMPOSITE

SPEC_IMAGE_FORWARD

Forward the image and its dependency

spec

implemented

REQ_IMAGE_COMPOSITE; REQ_IMAGE_GSPLAT_OVER

SPEC_IMAGE_GSPLAT_OVER

Render over the target

spec

implemented

REQ_GSPLAT_BACKENDS; REQ_IMAGE_GSPLAT_OVER; REQ_IMAGE_PRESERVE

SPEC_IMAGE_SHARED_PATHS

Shared read-only image

spec

implemented

REQ_IMAGE_SHARED_PATHS

TEST_DEPTH_CONTROLS

Independent test and write controls

test

verified

REQ_DEPTH_CONTROLS; SPEC_DEPTH_ATTACHMENT

TEST_DEPTH_METHODS

Both methods on both backends

test

verified

REQ_DEPTH_METHODS; SPEC_DEPTH_METHODS

TEST_DEPTH_ORDER

Raster and Gaussian rendering order

test

verified

REQ_DEPTH_SHARED; SPEC_DEPTH_ATTACHMENT

TEST_DEPTH_PATHS

Clearing, reuse and separate paths

test

verified

REQ_DEPTH_PATHS; SPEC_DEPTH_ATTACHMENT

TEST_GRAPH_BACKGROUND_BESIDE_FRAMES

Background graph beside the frames

test

verified

REQ_GRAPH_SHARED_OUTPUTS; REQ_GRAPH_THREADS

TEST_GRAPH_CHAIN_ORDER

Links execute in chain order

test

verified

REQ_GRAPH_CHAIN_ORDER; REQ_GRAPH_CHAIN_SHARED_DATA; SPEC_GRAPH_CHAIN_SUBMIT

TEST_GRAPH_CHAIN_PATHS

Paths in flight keep separate data

test

verified

REQ_GRAPH_CHAIN_PATHS; SPEC_GRAPH_CHAIN_BUFFERS; SPEC_GRAPH_CHAIN_SUBMIT

TEST_GRAPH_CHAIN_REPEAT_EXECUTES

Every occurrence of a graph executes

test

verified

REQ_GRAPH_CHAIN_REPEAT; SPEC_GRAPH_CHAIN_REPEAT

TEST_GRAPH_CHAIN_REPEAT_GUARD

Repeated graph paths require simultaneous use

test

verified

SPEC_GRAPH_CHAIN_REPEAT

TEST_GRAPH_CHAIN_REUSE

Reuse a chain across frames

test

verified

REQ_GRAPH_CHAIN_REUSE; SPEC_GRAPH_CHAIN_SUBMIT

TEST_GRAPH_CHAIN_SHARED_BUFFERS

Shared buffers are allocated once

test

verified

REQ_GRAPH_CHAIN_SHARED_DATA; SPEC_GRAPH_CHAIN_BUFFERS

TEST_GRAPH_CHAIN_SINGLE_LINK

One graph in a chain

test

verified

SPEC_GRAPH_CHAIN_SUBMIT

TEST_GRAPH_HEADLESS_SUBMIT

Headless submit and wait

test

verified

REQ_GRAPH_PATHS; SPEC_GRAPH_ORDER

TEST_GSPLAT_BACKENDS_AGREE

Both backends agree on the lantern scene

test

verified

REQ_GSPLAT_BACKENDS

TEST_IMAGE_CLEAR_COLOR

Configurable clear color

test

verified

REQ_IMAGE_CLEAR_COLOR; SPEC_IMAGE_CLEAR; SPEC_IMAGE_FORWARD

TEST_IMAGE_COMPOSITE

Composition modes

test

verified

REQ_IMAGE_COMPOSITE; SPEC_IMAGE_COMPOSITE

TEST_IMAGE_DEFAULT_CLEAR

Default opaque black

test

verified

REQ_IMAGE_DEFAULT_CLEAR; SPEC_IMAGE_CLEAR

TEST_IMAGE_FILL_PATTERN

Fill crops the centre of the source

test

verified

REQ_IMAGE_COMPOSITE; SPEC_IMAGE_COMPOSITE

TEST_IMAGE_FILTER_PATTERN

Opaque bilinear interpolation

test

verified

SPEC_IMAGE_COMPOSITE

TEST_IMAGE_FIT_PATTERN

Fit preserves the source pattern

test

verified

REQ_IMAGE_COMPOSITE; SPEC_IMAGE_COMPOSITE

TEST_IMAGE_GSPLAT_OVER

Gaussian backends over opaque backgrounds

test

verified

REQ_IMAGE_GSPLAT_OVER; SPEC_IMAGE_GSPLAT_OVER

TEST_IMAGE_PRESERVE

Preserve an image source's contents

test

verified

REQ_IMAGE_PRESERVE; SPEC_IMAGE_CLEAR

TEST_IMAGE_SHARED_PATHS

Shared image across paths and updates

test

verified

REQ_IMAGE_SHARED_PATHS; SPEC_IMAGE_FORWARD; SPEC_IMAGE_SHARED_PATHS

Gaussian splatting

Requirement: Interchangeable splatting backends REQ_GSPLAT_BACKENDS
status: implemented
is implemented by: SPEC_IMAGE_GSPLAT_OVER

The compute and the raster Gaussian splatting backends shall take the same inputs, so that switching the backend does not change the surrounding graph.

Test: Both backends agree on the lantern scene TEST_GSPLAT_BACKENDS_AGREE
status: verified
gtest: GaussianSplattingFactory.bothBackendsAgreeOnLanternScene

Renders the lantern scene with both backends and compares the colour channels of the images.