splat-transform API Reference - v1.0.0
    Preparing search index...

    Function readFile

    • Reads a Gaussian splat file and returns its data as one or more DataTables.

      Supports multiple input formats including PLY, splat, ksplat, spz, SOG, and LCC. Some formats (like LCC) may return multiple DataTables for different LOD levels.

      Parameters

      • readFileOptions: ReadFileOptions

        Options specifying the file to read and how to read it.

      Returns Promise<DataTable[]>

      Promise resolving to an array of DataTables containing the splat data.

      import { readFile, getInputFormat, UrlReadFileSystem } from '@playcanvas/splat-transform';

      const filename = 'scene.ply';
      const fileSystem = new UrlReadFileSystem('https://example.com/');
      const tables = await readFile({
      filename,
      inputFormat: getInputFormat(filename),
      options: {},
      params: [],
      fileSystem
      });