ComputeNode

Runs your own WGSL compute shader on the GPU to generate data — vertex positions, particle state, a simulation step — that the rest of the scene reads.

Declarative element: <sk-compute-node>

Global: available as sk.ComputeNode inside a scene <script>.

Remarks

The compute node is the concrete member of the AbstractComputeNodecompute-and-custom-WGSL family: it runs its own compute dispatch on the GPU timeline — its own command buffer, possibly multi-step (steps-per-frame) and stateful / self-re-arming (continuous) — decoupled from any consumer. Consumers read its TYPED outputs by key (output.0 …) via a compute-node="#id" reference on a compute-buffer-* source.

The element owns the binding ABI (group 0): the record-typed output storage array, the 32-byte params uniform (time/progress/output_size/output_count/output_stride), and the packed named-uniform block (<sk-wgsl-uniform> children, read via the generated skUniform_<name>() accessors). The author supplies ONLY the @compute @workgroup_size(…) fn main kernel — declaring bindings in author WGSL is a validation error.

Outputs are slices of one shared buffer, padded so each slice starts on a 256-byte boundary (minStorageBufferOffsetAlignment); records for output i live at [i * output_stride, i * output_stride + output_size).

A kernel writes its OWN slice through output (invocation-owned, so race-free), but reads any SIBLING slice through previous — a per-step snapshot of output the scaffold also binds at group 0. Cross-slice reads through output race the sibling invocation's own write and are undefined per the WGSL spec; previous holds the committed previous-step state, so a neighbour-reading continuous sim (e.g. n-body) evolves deterministically regardless of GPU invocation order.

Constructor

constructor(config?: { wgsl?: string; src?: string; outputKind?: ComputeNodeOutputKind; outputCount?: number; outputSize?: number; stepsPerFrame?: number; continuous?: boolean; id?: string; x?: number; y?: number; z?: number; h?: number; p?: number; b?: number; quaternion?: Quaternion; sx?: number; sy?: number; sz?: number; s?: number; class?: string; style?: string })

Inherited from: SceneNode, SkenraAnimatable — see those pages for inherited members.

Properties

Config Properties

Other Properties

Methods

Example

const sim = new ComputeNode({
    id: 'sim',
    outputSize: 256,
    wgsl: `
        @compute @workgroup_size(64)
        fn main(@builtin(global_invocation_id) gid: vec3u) {
            let i = gid.x;
            if (i >= params.output_size) { return; }
            let t = f32(i) / f32(params.output_size - 1u) * 6.283185;
            output[i] = SplineVertex(sin(5.0 * t), cos(3.0 * t), cos(t), 1.0);
        }
    `,
});
scene.appendChild(sim);

↑ Documentation home · ← All classes