Interface CameraDebugOptions

interface CameraDebugOptions {
    bounds?: { maxX: number; maxY: number; minX: number; minY: number };
    canvas?: string | HTMLCanvasElement;
    enabled?: boolean;
    onCustomRender?: (
        ctx: CanvasRenderingContext2D,
        worldToScreen: (wx: number, wy: number) => { x: number; y: number },
        width: number,
        height: number,
    ) => void;
    showBounds?: boolean;
    showCameraMarkers?: boolean;
    showCenterCrosshair?: boolean;
    showTargetLines?: boolean;
}

Properties

bounds? canvas? enabled? onCustomRender? showBounds? showCameraMarkers? showCenterCrosshair? showTargetLines?

Properties

Optionalbounds

bounds?: { maxX: number; maxY: number; minX: number; minY: number }

World coordinates bounds to visualize when showBounds is enabled

Optionalcanvas

canvas?: string | HTMLCanvasElement

Canvas element or HTML selector to render onto. If not provided, an overlay canvas will be auto-created

Optionalenabled

enabled?: boolean

Whether debug overlay is enabled

OptionalonCustomRender

onCustomRender?: (
    ctx: CanvasRenderingContext2D,
    worldToScreen: (wx: number, wy: number) => { x: number; y: number },
    width: number,
    height: number,
) => void

Optional custom rendering hook to draw application-specific elements (e.g. nameplates, reticles)

OptionalshowBounds

showBounds?: boolean

Whether camera bounds rectangles are rendered

OptionalshowCameraMarkers

showCameraMarkers?: boolean

Whether camera position markers are rendered

OptionalshowCenterCrosshair

showCenterCrosshair?: boolean

Whether screen center crosshair is rendered

OptionalshowTargetLines

showTargetLines?: boolean

Whether dashed target vector lines are rendered

Settings

Member Visibility

On This Page

Properties