Skip to content

API Reference

Below is the complete public API of Galavi, auto-generated from the TypeScript source on every docs build.

Top-level entry points

  • createGalavi(config) — async factory that initializes WebGPU, mounts views, and returns a ready Galavi instance.
  • Galavi — orchestrator class. Owns global state and exposes the high-level state-update API.

Extension API

  • registerLayer, registerControl, registerOverlay, registerView — plug your own building blocks into the registries the core uses. See Plugin Development.
  • BaseLayer, BaseControl, BaseOverlay, BaseView — base classes you extend.

Public utilities

For plugin authors writing layers, views, or source adapters:

  • Camera mathclampPitch, cameraDistance, cameraAngles, computePosition, computeForward
  • AxesresolveAxes, AxisIndex, AxisMap
  • GeometryEMPTY_VERTEX_BUFFER, UNIT_CUBE, aabbFromPositions
  • ColormapsgetColormapLUT, COLORMAP_NAMES, APPEARANCE_PRESETS, resolveAppearancePreset, parseHexColor
  • Tiles / pyramidTilePool, TileLoadQueue, TileManager, planTiles, pickPyramidLevel, resolvePyramidLevel, buildTileFetcher, floatToFloat16
  • DOM inputnormalizeWheel, normalizeDrag

Released under the GPL-3.0 License.