hex-world
    Preparing search index...

    Interface MapImageTransform

    The world ↔ image mapping a map image uses, plus the pixel size it needs.

    Build one with getMapImageTransform (or take the one drawMapImage returns) to place overlays — a camera viewport rectangle, unit pins, a cursor ring — on top of a rendered minimap, and to turn minimap clicks back into world positions.

    interface MapImageTransform {
        width: number;
        height: number;
        scale: number;
        padding: number;
        bounds: MapWorldBounds;
        worldToImage(
            x: number,
            z: number,
            out?: { x: number; y: number },
        ): { x: number; y: number };
        imageToWorld(
            px: number,
            py: number,
            out?: { x: number; z: number },
        ): { x: number; z: number };
    }
    Index

    Properties

    width height scale padding bounds

    Methods

    worldToImage imageToWorld

    Properties

    width: number

    Image width in pixels, padding included.

    height: number

    Image height in pixels, padding included.

    scale: number
    padding: number
    bounds: MapWorldBounds

    Methods

    • World XZ → image pixel. Pass out to avoid an allocation.

      Parameters

      • x: number
      • z: number
      • Optionalout: { x: number; y: number }

      Returns { x: number; y: number }

    • Image pixel → world XZ. Pass out to avoid an allocation.

      Parameters

      • px: number
      • py: number
      • Optionalout: { x: number; z: number }

      Returns { x: number; z: number }

    Settings

    Member Visibility

    On This Page

    Properties
    Methods