API index#
This table lists every export of @sparkjsdev/radix, sorted by name. Everything is exported from @sparkjsdev/radix; the core/ exports (marked core) also come from @sparkjsdev/radix/core, which has no three.js and runs in workers and Node. Kinds: class, function, value, or type.
| Name | Kind | Layer | What it is |
|---|---|---|---|
AnyGpuSplatReader | type | gpu | any of the three splat readers (Splats) |
AnySplatGenerator | type | gpu | a generator of any data (Generators and modifiers) |
AnySplatObject | type | render | a splat object of any data (Rendering) |
ArrayBundle | type | core | one bundle of a table: def, channels, meta (ArrayData) |
ArrayBundles | type | core | a table's bundles by name |
ArrayChannel | type | core | one channel: { format, data } |
ArrayData | class | core | the table: rows of elements, channels of typed arrays, named bundles (ArrayData) |
ArrayFormat | type | core | a channel format: "uint32x4", "float16x2", ... (ArrayData) |
ArrayFormats | class | core | info(format) and make(scalar, components) |
ArrayOf | type | core | the typed array of a format |
ArrayWriter | type | gpu | what GpuArrays.write runs: a fragment or compute writer (GPU arrays) |
AutoSort | type | render | { distance, angle }: when autoSort re-sorts (Views and CPU orders) |
Axes | class | core | coordinate systems: SYSTEMS, matrix, converter, convert (Splat files) |
AxesConverter | type | core | converts values from one system to another in place: vec, quat, scales, cov, splat, sh |
BundleChannels | type | core | channel names to formats |
BundleDef | type | core | a bundle definition: channels, packing, serialize (ArrayData) |
BundleLike | type | core | anything with named channels of formats |
ByteReader | class | core | bytes taken in order from bytes or a stream (Splat files) |
BytesInput | type | core | bytes, an ArrayBuffer, or a stream |
CallOptions | type | worker | { onProgress? } of a worker call (Workers) |
CameraControls | class | controls | orbit and fly controls for pointer, touch, keys, gamepads, and XR (Camera controls) |
CameraControlsInertia | type | controls | inertia per input, in seconds |
CameraControlsMode | type | controls | "fly" | "orbit" |
CameraControlsSettings | type | controls | all the controls' settings (Camera controls) |
CompressedPlyFile | class | core | SuperSplat compressed PLY write (and read, as PlyFile.read) (Splat files) |
Compression | class | core | gzip, gunzip, byte-transposed gzip, and reading bytes (Splat files) |
ComputeIds | type | wgpu | a kernel body's built-in ids (WebGPU compute) |
CoordinateSystem | type | core | "RUB", "RDF", "RFU", ...: where +x, +y, and +z point (Splat files) |
CopySpan | type | core | one rectangle of a texture copy |
Cov | type | core | a symmetric 3x3 matrix: { xx, yy, zz, xy, xz, yz } |
CovSplat | type | core | a covariance-form splat record (Splats) |
CovSplatModifier | type | gpu | a TSL function of a covariance splat (Generators and modifiers) |
CovSplatNode | type | gpu | the covariance splat struct in TSL (Shaders) |
CovSplats | type | core | a typed covSplats bundle |
createRenderer | function | gpu | an initialized WebGPURenderer with the device baselines (The renderer) |
CreateRendererOptions | type | gpu | its options |
decodeShScale | function | core | packed SH's scale byte to a band's largest value (Spherical harmonics) |
defineBundle | function | core | a bundle definition (ArrayData) |
DispatchSize | type | wgpu | threads, workgroups, or an indirect buffer |
encodeShScale | function | core | a band's largest value to packed SH's scale byte, rounded up (Spherical harmonics) |
Encoding | class | core | the scalar and vector codecs of the splat layouts (Encodings) |
ExtSplat | type | core | a splat record with PBR fields |
ExtSplats | type | core | a typed extSplats bundle |
FormatInfo | type | core | what ArrayFormats.info returns |
FoundSh | type | core | what Sh.find returns: { name, codec, degree } (Spherical harmonics) |
FoundSplats | type | core | { name, layout, bundle } from Splats.find / get |
getGpuCaps | function | gpu | the renderer's backend and limits (The renderer) |
GpuArrayReader | class | gpu | TSL reads of one bundle (GPU arrays) |
GpuArrays | class | gpu | a table in textures (GPU arrays) |
GpuArrayWriter | class | gpu | writes bundles from TSL as a fragment pass (GPU arrays) |
GpuBackend | type | gpu | "webgpu" | "webgpu-gl" |
GpuBundle | type | gpu | one bundle of a GpuArrays |
GpuBundles | type | gpu | its bundles by name |
GpuCaps | type | gpu | what getGpuCaps returns |
GpuChannel | type | gpu | one channel's texture and formats |
GpuCovSplatReader | class | gpu | the covSplats reader |
GpuEncoding | class | gpu | the TSL twin of Encoding (Encodings) |
GpuExtSplatReader | class | gpu | the extSplats reader |
GpuPackedSplatReader | class | gpu | the packedSplats reader |
GpuProfile | type | gpu | GPU and CPU ms per phase |
GpuProfiler | class | gpu | GPU and CPU time per named phase (The renderer) |
GpuSh | class | gpu | spherical harmonics in TSL: evaluate, maxDegree, codec (Spherical harmonics) |
GpuShCodec | type | gpu | a built-in SH codec's TSL decoder: decodeBand (Spherical harmonics) |
GpuShPalette | class | gpu | SH palettes on the GPU: upload, create (Spherical harmonics) |
GpuShReader | class | gpu | reads and evaluates stored SH in any generator: bind, color, apply (Spherical harmonics) |
GpuSortKeys | class | gpu | the TSL twin of SortKeys (Shaders) |
GpuSplatMath | class | gpu | the TSL twin of SplatMath |
GpuSplatReader | class | gpu | splat reads in TSL: for(layout), from(arrays) (Splats) |
GpuSplats | class | gpu | the splat structs and TSL codecs (Splats) |
Hdr | class | gpu | the HDR canvas and headroom tone mapping (The renderer) |
HdrToneMapping | type | gpu | the tone mapping's controls |
LimitRequest | type | gpu | a WebGPU limit to request: a number or "adapter" |
LoadedSplats | type | core | what loadSplatFile and the readers return: { splats, shPalette? } (Splat files) |
loadSplatFile | function | worker | a splat file into { splats, shPalette? }, a palette kept, on a worker (Splat files) |
loadSplats | function | worker | a splat file into its table, a palette expanded per splat, on a worker (Splat files) |
LoadSplatsOptions | type | worker | the options of loadSplats and loadSplatFile (Splat files) |
MappedObject | type | render | { object, offset }: an object in a collection, with its offset |
ModifierSpace | type | render | "view" | "world" | "object" or a Matrix4 (Generators and modifiers) |
PackedEncoding | type | core | the ranges of packed splats' 8-bit codes (Splats) |
PackedSplats | type | core | a typed packedSplats bundle |
Pbr | type | core | normal, roughness, and metallic |
PbrNode | type | gpu | the PBR struct in TSL |
PlyFile | class | core | PLY read (standard or compressed) and write (Splat files) |
Progress | type | core | (fraction, stage) => void |
ProgressStage | type | core | "downloading" | "decoding" | "encoding" | "compressing" |
ProjectionMethod | type | render | "ewa" | "3dgut" | "htgs" | "raygs" (Projection) |
Quat | type | core | { x, y, z, w } |
RadFile | class | core | RAD read and write, clustered SH included |
RadixKeysPerThread | type | wgpu | 8 or 16 |
RdxFile | class | core | RDX files: whole, chunked, over HTTP range requests (RDX files) |
RdxHeader | type | core | an RDX header |
RdxReader | type | core | header and readChunk(chunk, into) |
Rgb | type | core | { r, g, b } |
ScalarType | type | core | the scalar part of a format |
ScanTier | type | wgpu | "portable" | "subgroup" |
Schema | type | core | bundle names to definitions |
Sh | class | core | spherical harmonics on the CPU: codecs, bundles, find, encoders, convert, evaluate (Spherical harmonics) |
ShCodec | type | core | a built-in SH codec (Sh.codec(name)): name, words, channels, encode, decode (Spherical harmonics) |
ShCodecName | type | core | the SH codecs: "ext" | "packed" (Spherical harmonics) |
ShDegree | type | core | 1 | 2 | 3 | 4: the highest SH band (Spherical harmonics) |
ShPalette | class | core | a table of SH entries that splats pick by label (Spherical harmonics) |
ShTarget | type | core | what file readers do with SH: "ext", "packed", or false (Spherical harmonics) |
SortedSplats | type | worker | { ordering, visible, keys } from sortSplatKeys |
SortKeyBits | type | core | 16 | 24 | 32 |
SortKeys | class | core | sort keys: compute, invalid, sort, KEYS (Sorting) |
sortSplatKeys | function | worker | sorts sort keys on a worker or on the current thread (Workers) |
Splat | type | core | a splat record: center, scales, quaternion, rgb, opacity (Splats) |
SplatBindContext | type | gpu | the generator context as three.js values, for bind (Generators and modifiers) |
SplatBundle | type | core | any typed splat bundle |
SplatBundles | type | core | layout names to typed bundles |
SplatCollection | class | render | an immutable, ordered list of splat objects (Rendering) |
SplatData | type | core | a table with a layout's splat bundle |
SplatFiles | class | core | splat files on the current thread (Splat files) |
SplatFormat | type | core | "ply" | "compressed-ply" | "spz" | "rad" | "rdx" |
SplatGenerator | value and type | gpu | makes splat i in TSL; fromSplats, forArrays, indices, context (Generators and modifiers) |
SplatGeneratorContext | type | gpu | what a generator or modifier knows of the object and the view: viewOrigin, ... (Generators and modifiers) |
SplatLayout | type | core | "extSplats" | "covSplats" | "packedSplats" |
SplatLoadOptions | type | core | SplatFiles.decode's options |
SplatMath | class | core | quaternion and covariance math (Encodings) |
SplatModifier | type | gpu | a TSL function of a splat (Generators and modifiers) |
SplatNode | type | gpu | the splat struct in TSL (Shaders) |
SplatObject | type | render | one thing to draw: generator, data, count, matrixWorld, params, release (Rendering) |
SplatObjectParams | type | render | the params each object projects with (Params) |
SplatOrder | type | render | one CPU sort's result (Views and CPU orders) |
SplatProjector | class | render | the program cache: programs, dispose(generator) (Generators and modifiers) |
SplatReadOptions | type | core | a target layout plus progress, sh, and coordinateSystem |
SplatRenderer | class | render | the mesh that draws a collection (Rendering) |
SplatRequestInit | type | core | fetch options for a splat file's URL, loadSplats' request (Splat files) |
SplatRendererOptions | type | render | its options |
Splats | class | core | the splat layouts on the CPU (Splats) |
SplatShOptions | type | gpu | { codec, degree, palette? }: the SH a fromSplats generator adds (Generators and modifiers) |
SplatSource | type | worker | a URL, a Blob or File, or bytes |
SplatTarget | type | core | { layout?, encoding? } |
SplatView | class | render | one viewpoint of a renderer (Views and CPU orders) |
SplatViewOptions | type | render | what viewFor sets |
SplatViewParams | type | render | the params every splat of a render shares (Params) |
SplatWriteOptions | type | core | the writers' options (Splat files) |
SpzExtension | type | core | an SPZ extension record: { type, data } |
SpzFile | class | core | SPZ read, write, and unpack (Splat files) |
SpzUnpacked | type | core | an SPZ file's header and byte columns |
SpzWriteOptions | type | core | the SPZ writer's options |
StoredSplats | type | gpu | { splats, indices?, shPalette? }: the data of a fromSplats object |
StructNode | type | gpu | a typed TSL struct node |
TexelSpan | type | core | one rectangle of texels |
TextureLayout | class | core | elements to texels of a 2D array texture (ArrayData) |
TransferableArrayData | type | core | a table as a plain object, for postMessage |
TSL | value | gpu | three/tsl with loosened node types (Shaders) |
TslNode | type | gpu | any TSL node |
TypedArray | type | core | any typed array a channel can hold |
TypedArrayConstructor | type | core | its constructor |
Vec3 | type | core | { x, y, z } |
WgpuArrayStore | class | wgpu | writes elements at any index from compute (WebGPU compute) |
WgpuArrayWriter | class | wgpu | the compute writer (WebGPU compute) |
WgpuBuffer | class | wgpu | a typed storage buffer (WebGPU compute) |
WgpuCompact | class | wgpu | stream compaction (WebGPU compute) |
WgpuCompute | class | wgpu | a compute kernel (WebGPU compute) |
WgpuComputeBatch | class | wgpu | dispatches in one compute pass |
WgpuRadixSort | class | wgpu | a stable GPU radix sort (WebGPU compute) |
WgpuSplatSorter | class | wgpu | compaction, sort, and draw arguments for projected splats (WebGPU compute) |
WorkerArgs | type | worker | a handler's arguments |
WorkerCall | type | worker | the handler names |
WorkerChoice | type | worker | where a file call runs: boolean, a pool, or a lease (Splat files) |
WorkerLease | class | worker | one worker of a pool, held until release() (Workers) |
WorkerPool | class | worker | up to size workers, made on demand (Workers) |
WorkerResult | type | worker | a handler's result |
WriteItem | type | gpu | a write range plus its writer |
WriteRange | type | gpu | { at?, count, first? } |
WriterFor | type | gpu | the writers that arrays with a given storage setting accept |
WriterOutput | type | gpu | one output channel of a writer |
WriterOutputs | type | gpu | a writer body's out argument |
writeSplats | function | worker | a table to a splat file, on a worker (Splat files) |
XrInput | type | controls | the part of renderer.xr the controls read |
Zstd | class | core | zstd compress and decompress (Splat files) |
Internal (not exported; the tests import them by path): SplatCamera, SplatParams, SplatProjection, projectCollection, programOf, readSortKeys, and the transforms in splatTransform.tsl.ts (Projection).
Source: docs/api.md