Skip to main content

Overview

Explore the packages for a visual overview of primary packages, smaller packages, and exploratory modules.

luma.gl provides published, composable npm modules with stable and experimental APIs, alongside optional Arrow adapters and private deck.gl adapters under active development. Applications can choose the rendering, compute, and visualization functionality they need while checking the maturity of each package.

Use the API reference when you want the class-by-class reference pages for a specific module. If you are looking for conceptual guides or an introduction to how the pieces fit together, start in the API Guide and then come back here for the detailed type and method docs.

If you are looking for Model, start with @luma.gl/engine. The Model class lives in the engine module and is one of the main entry points for rendering in luma.gl.

ModuleUsageDescription
@luma.gl/coreRequiredThe portable Device API, shader types, and WebGPU and WebGL2 implementations.
@luma.gl/core/webglCore subpathDevice adapter implemented using the WebGL API. Enables creation of WebGL resources.
@luma.gl/core/webgpuCore subpathDevice adapter implemented using the WebGPU API. Enables creation of WebGPU resources.
@luma.gl/engineRecommendedA set of WebGPU/WebGL independent core 3D engine style classes built on top of @luma.gl/core.
@luma.gl/anariExperimentalANARI-inspired retained scene objects, instanced rendering, lights, materials, and HDR.
@luma.gl/shadersRecommendedReusable shader modules, portable shader assembly, and application-defined shader hooks.
@luma.gl/shaders/glslOptionalGLSL assembler and assembly helpers.
@luma.gl/shaders/wgslOptionalWGSL assembler, assembly helpers and interface scanning.
@luma.gl/slangExperimental (v10)Optional TypeScript transpilation of a documented Slang shader subset to GLSL and WGSL.
@luma.gl/engine/effectsOptionalComposable post-processing effects, screen-space lighting, and reusable shader-pass pipelines.
@luma.gl/graph/gpu-simple-graphOptionalPortable GPU evaluation.
@luma.gl/graphExperimental (v10)GPU execution graphs, programs, and graph-based processing through explicit subpaths.
@luma.gl/graph/arrowOptional / ExperimentalArrow vector and table conversion, upload, readback, analytics and geospatial preparation.
@luma.gl/engine/arrowOptional / ExperimentalArrow geometry, rendering, text and splat adapters.
@luma.gl/engine/textExperimentalTextRenderer facade and caller-owned GPU text data.
@luma.gl/engine/splatsExperimentalGaussian splat rendering and caller-owned prepared GPU splat data.
@luma.gl/engine/gltfOptionalStandards-first glTF assets, physical materials, character animation, and lossless interchange.
@luma.gl/core/test-utilsOptionalTest devices, null backend, and resource assertions.

Select at least one adapter from the core backend subpaths when creating a device.

Start Here​