Overview
luma.gl is packaged and published as a suite of composable npm modules, so that applications can choose what functionality they need.
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.
| Module | Usage | Description |
|---|---|---|
@luma.gl/core | Required | The "Abstract" Device API (implemented by both the webgpu and webgl modules). |
@luma.gl/webgl | Required * | Device adapter implemented using the WebGPU API. Enables creation of WebGPU resources |
@luma.gl/webgpu | Required * | Device adapter implemented using the WebGL API. Enables creation of WebGL resources. |
@luma.gl/engine | Recommended | A set of WebGPU/WebGL independent core 3D engine style classes built on top of @luma.gl/core. |
@luma.gl/shadertools | Recommended | System for modularizing and composing shader code, shader module system,, shader modules. |
@luma.gl/tables | Optional | GPU-resident table primitives, batching, table-backed rendering, and table-oriented compute. |
@luma.gl/arrow | Optional | Apache Arrow adapters for deriving GPU layouts and building GPU table objects from Arrow data. |
@luma.gl/text | Optional | Experimental GPUVector-based 2D text conversion and renderer models. |
@luma.gl/gltf | Optional | glTF scenegraph loading and instantiation etc. |
@luma.gl/test-utils | Optional | Test setups, in particular support for rendering and comparing images. |
* At least one backend, either WebGL or WebGPU, must be installed to enable GPU resource creation.
Start Here
@luma.gl/engineforModel,AnimationLoop, scenegraph helpers, and compute-oriented utilities.@luma.gl/coreforDevice, buffers, textures, shaders, render passes, andRenderPipeline.@luma.gl/shadertoolsfor shader modules and shader assembly.@luma.gl/tablesforGPUData,GPUVector,GPURecordBatch, andGPUTable.@luma.gl/textfor GPUVector-based 2D text conversion and rendering.@luma.gl/gltffor glTF scenegraph loading and extensions.@luma.gl/webgland@luma.gl/webgpufor backend adapters used by@luma.gl/core.@luma.gl/webgl/constantswhen you need raw numeric WebGL enums.