s2maps-gpu/dist/workers/source/spriteSource.d.ts

S2 Maps GPU - An open source, high-performance, and GPU-accelerated map engine for rendering large-scale, interactive maps.

import ImageSource from './imageSource.js';
import type { ImageSourceMetadata } from './imageSource.js';
/** Sprite Metadata */
export interface SpriteMetadata {
    id: number;
    width: number;
    height: number;
    x: number;
    y: number;
    pixelRatio: number;
}
/** Collection of Sprites Metadata */
export type SpritesMetadata = Record<string, SpriteMetadata>;
/**
 * # SpriteSource
 *
 * A collection of images relating to a single source
 */
export default class SpriteSource extends ImageSource {
    /**
     * Build the image source metadata
     * @param mapID - the id of the map to build for
     * @returns the image metadata
     */
    build(mapID: string): Promise<undefined | ImageSourceMetadata>;
}