Class ColumnSAB

SharedArrayBuffer-based column implementation 基于SharedArrayBuffer的列实现

Implements

IColumn

Index

Constructors

Methods

buildSliceDescriptor capacity clearChangeTracking drainWrittenRows ensureCapacity getRowEpochs getWriteMask length markWrittenRange pushDefault readToObject swapRemove viewOf writeFromObject

Constructors

constructor

new ColumnSAB(schema: ComponentSchema, initialCap?: number): ColumnSAB
Parameters
- schema: ComponentSchema
- initialCap: number = 256
Returns ColumnSAB
- Defined in sab/ColumnSAB.ts:50

Methods

buildSliceDescriptor

buildSliceDescriptor(
    start: number,
    end: number,
): {
    fields: Record<
        string,
        {
            buffer: SharedArrayBuffer;
            byteOffset: number;
            length: number;
            type: string;
        },
    >;
    writeMask: {
        buffer: SharedArrayBuffer;
        byteOffset: number;
        length: number;
    };
}
Zero-copy slice descriptor for Worker to rebuild TypedArray views 零拷贝切片描述，发给Worker重建TypedArray视图即可
Parameters
- start: number
- end: number
Returns {
    fields: Record<
        string,
        {
            buffer: SharedArrayBuffer;
            byteOffset: number;
            length: number;
            type: string;
        },
    >;
    writeMask: {
        buffer: SharedArrayBuffer;
        byteOffset: number;
        length: number;
    };
}
Implementation of IColumn.buildSliceDescriptor
- Defined in sab/ColumnSAB.ts:152

capacity

capacity(): number
Capacity in rows 容量（行）

Returns number
Implementation of IColumn.capacity
- Defined in sab/ColumnSAB.ts:56

clearChangeTracking

clearChangeTracking(): void
Clear write mask for new frame 清理写掩码开始新帧

Returns void
Implementation of IColumn.clearChangeTracking
- Defined in sab/ColumnSAB.ts:235

drainWrittenRows

drainWrittenRows(): number[]
Main thread reads and clears write mask (returns written row indices) 主线程读取并清空写掩码（返回被写行号）

Returns number[]
- Defined in sab/ColumnSAB.ts:191

ensureCapacity

ensureCapacity(rows: number): void
Ensure capacity 确保容量
Parameters
- rows: number
Returns void
Implementation of IColumn.ensureCapacity
- Defined in sab/ColumnSAB.ts:89

getRowEpochs

getRowEpochs(): null | Uint32Array
Get per-row epochs - not supported for SAB backend, use writeMask instead 获取每行时代 - SAB后端不支持，使用writeMask替代

Returns null | Uint32Array
Implementation of IColumn.getRowEpochs
- Defined in sab/ColumnSAB.ts:227

getWriteMask

getWriteMask(): null | Uint8Array
Get write mask for change detection (read-only, doesn't clear) 获取写掩码用于变更检测（只读，不清空）

Returns null | Uint8Array
Implementation of IColumn.getWriteMask
- Defined in sab/ColumnSAB.ts:219

length

length(): number
Current number of rows 当前行数

Returns number
Implementation of IColumn.length
- Defined in sab/ColumnSAB.ts:55

markWrittenRange

markWrittenRange(start: number, end: number): void
(Main thread) Mark certain rows in this column as written, for changed() （主线程）标记这一列某些行被写，用于changed()
Parameters
- start: number
- end: number
Returns void
Implementation of IColumn.markWrittenRange
- Defined in sab/ColumnSAB.ts:179

pushDefault

pushDefault(): number
Add new row with default value at end, return row index 在末尾新增一行默认值，返回行号

Returns number
Implementation of IColumn.pushDefault
- Defined in sab/ColumnSAB.ts:93

readToObject

readToObject(
row: number,
out?: Record<string, unknown>,
): Record<string, unknown>
Read to object (for debugging/serialization) 读取为对象（调试/序列化用）
Parameters
- row: number
- out: Record<string, unknown> = {}
Returns Record<string, unknown>
Implementation of IColumn.readToObject
- Defined in sab/ColumnSAB.ts:133

swapRemove

swapRemove(row: number): void
Swap-remove a row (for archetype migration) 交换删除一行（用于archetype迁移）
Parameters
- row: number
Returns void
Implementation of IColumn.swapRemove
- Defined in sab/ColumnSAB.ts:100

viewOf

viewOf(
    name: string,
):
    | Uint32Array
    | Uint8Array
    | Int32Array
    | Float32Array
    | Float64Array
    | Int16Array
    | Uint16Array
    | Int8Array
Convenience: get specific field view (for main thread local use) 便捷：拿到具体字段的视图（主线程本地用）
Parameters
- name: string
Returns
    | Uint32Array
    | Uint8Array
    | Int32Array
    | Float32Array
    | Float64Array
    | Int16Array
    | Uint16Array
    | Int8Array
- Defined in sab/ColumnSAB.ts:213

writeFromObject

writeFromObject(row: number, obj: Record<string, unknown>): void
Write from object to specified row (for addInstance/serde) 从对象写入指定行（用于addInstance/序列化）
Parameters
- row: number
- obj: Record<string, unknown>
Returns void
Implementation of IColumn.writeFromObject
- Defined in sab/ColumnSAB.ts:116

Class ColumnSAB

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ColumnSAB

Methods

buildSliceDescriptor

Parameters

Returns { fields: Record< string, { buffer: SharedArrayBuffer; byteOffset: number; length: number; type: string; }, >; writeMask: { buffer: SharedArrayBuffer; byteOffset: number; length: number; };}

capacity

Returns number

clearChangeTracking

Returns void

drainWrittenRows

Returns number[]

ensureCapacity

Parameters

Returns void

getRowEpochs

Returns null | Uint32Array

getWriteMask

Returns null | Uint8Array

length

Returns number

markWrittenRange

Parameters

Returns void

pushDefault

Returns number

readToObject

Parameters

Returns Record<string, unknown>

swapRemove

Parameters

Returns void

viewOf

Parameters

Returns | Uint32Array | Uint8Array | Int32Array | Float32Array | Float64Array | Int16Array | Uint16Array | Int8Array

writeFromObject

Parameters

Returns void

Settings

On This Page

Returns {
fields: Record<
string,
{
buffer: SharedArrayBuffer;
byteOffset: number;
length: number;
type: string;
},
>;
writeMask: {
buffer: SharedArrayBuffer;
byteOffset: number;
length: number;
};
}

Returns
| Uint32Array
| Uint8Array
| Int32Array
| Float32Array
| Float64Array
| Int16Array
| Uint16Array
| Int8Array