GPURecordBatch

GPURecordBatch represents one immutable preserved GPU batch. It owns one batch-local GPUData chunk per selected column, GPUSchema metadata, and buffer-layout metadata.

Usage

import {GPURecordBatch} from '@luma.gl/tables';

const batch = new GPURecordBatch({
  gpuData: {
    positions: positions.data[0],
    colors: colors.data[0]
  }
});

When the source is an Arrow RecordBatch, prefer makeGPURecordBatchFromArrowRecordBatch() from @luma.gl/arrow.

Constructor

new GPURecordBatch(props)

Prop	Type	Default	Meaning
gpuData	Record<string, GPUData>	Required	One batch-local GPU data chunk keyed by selected column name.
bufferLayout	BufferLayout[]	Derived	Precomputed batch buffer layouts.
fields	GPUField[]	Derived	Selected schema fields.
numRows	number	Derived	Explicit row count for intentionally data-less batches.
metadata	Map<string, string>	undefined	Batch-level schema metadata.
nullCount	number	0	Number of null rows retained in batch metadata.

Properties

Property	Type	Meaning
schema	GPUSchema	GPU-facing schema for selected columns.
numRows	number	Number of logical rows in the batch.
numCols	number	Number of selected GPU columns.
nullCount	number	Number of null rows retained in metadata.
bufferLayout	BufferLayout[]	Buffer layouts derived by the producing adapter.
gpuData	Record<string, GPUData>	Batch-local data chunks keyed by shader/table column name.

Reserved Draw Columns

gpuData.indices is reserved for batch-local indexed rendering. It is a vertex-list<uint32> chunk whose flattened valueLength is the index count for this batch. The chunk remains part of gpuData and schema, but it is not emitted as an attribute buffer layout; its single GPUData buffer must be created with Buffer.INDEX usage so GPUTableModel can bind it as the model index buffer.

Methods

destroy(): void

Destroys every retained GPUData chunk. Each chunk destroys its buffer only when it owns that buffer.

Notes

GPURecordBatch mirrors Arrow RecordBatch: each selected column contributes one batch-local data chunk. Multi-chunk logical columns are table-level GPUVector views built by GPUTable.