Skip to content
fpsr
Esc
navigateopen⌘Jpreview

Renderer

High-level createRenderer, asset sources, and render options.

From @rickyzhangca/fpsr (and @rickyzhangca/fpsr/node for localAssets). The entry’s .d.ts is the complete surface; this table lists the supported core.

Export Kind Description
createRenderer function High-level async renderer (plan + load + paint)
cdnAssets / localAssets function HTTP / filesystem AssetSource
MeasureOptions type Layout-only options for measure
RenderOptions type Public paint options (background, altMode, showCoordinates, …)
TiledPngOptions type Full-resolution PNG options (no profile / canvas / maxOutputSize)
RenderBackground type Discriminated background mode
AssetDensityMismatchError class Thrown when render-db density does not match assetTier
UnknownTerrainBackgroundError class Thrown for unknown background: { type: "terrain", name }
Renderer type { measure, render, renderTiledPng, dispose }

Renderer.dispose() clears renderer-owned icon/silhouette caches only. It does not call AssetSource.dispose() or close atlas images owned by the asset source.

@rickyzhangca/fpsr/node is Node-only (browser export condition throws). Use cdnAssets in browsers.

See Quick start, Assets, and Rendering.

Was this page helpful?