Selva Compute API Reference - v2.1.0
    Preparing search index...

    Interface DisplayBatch

    One Display component's payload, ready for Three.js rendering.

    compressedData contains the binary "SLVA" blob (header + metadata JSON + quantized int16 or float32 vertices + uint32 indices), base64-encoded for transit inside the values JSON envelope. The blob is opaque to the outer JSON: a future binary WebSocket frame can drop the base64 step without changing this shape.

    Today this carries only meshes (the binary blob). It is named DisplayBatch rather than MeshBatch because it is the seam through which non-mesh display items (curves, points, and later labels/icons) also travel — those ride as JSON alongside the mesh blob, not inside it.

    interface DisplayBatch {
        compressedData: string;
        groups: MaterialGroup[];
        items?: DisplayItem[];
        materials: SerializableMaterial[];
        sourceComponentId?: string;
    }
    Index

    Properties

    compressedData groups items? materials sourceComponentId?

    Properties

    compressedData: string

    Base64-encoded binary blob (SLVA wire format).

    groups: MaterialGroup[]

    Groups of meshes organized by material

    items?: DisplayItem[]

    Non-mesh display items (curves, points; later labels/icons) — see DisplayItem. Optional: omitted when there are none, so mesh-only batches are unchanged on the wire. These ride as JSON alongside the mesh blob and are parsed by the separate display-items path, not the SLVA mesh parser.

    materials: SerializableMaterial[]

    Array of unique materials

    sourceComponentId?: string

    InstanceGuid of the WebDisplay GH component that produced this batch. Combined with MeshMetadata.originalIndex to backtrack any mesh to its GH source.

    Settings

    Member Visibility

    On This Page

    Properties