@esengine/nova-ecs-render-core - v1.0.1
    Preparing search index...

    Interface IDebugRenderer

    Debug renderer interface extending base renderer 扩展基础渲染器的调试渲染器接口

    interface IDebugRenderer {
        beginFrame(): void;
        clear(_color?: Color): void;
        clearPerformanceMeasurements(): void;
        debugLog(message: string, color?: Color): void;
        dispose(): void;
        drawArrow(
            start: FixedVector2,
            end: FixedVector2,
            color: Color,
            headSize?: Fixed,
        ): void;
        drawAxis(origin: FixedVector2, scale: Fixed): void;
        drawBounds(bounds: FixedRect, color: Color): void;
        drawCircle(_center: FixedVector2, _radius: Fixed, _style: ShapeStyle): void;
        drawCrosshair(position: FixedVector2, size: Fixed, color: Color): void;
        drawDebugOverlay(info: DebugInfo): void;
        drawDebugText(text: string, position: FixedVector2, color?: Color): void;
        drawDebugTextScreen(
            text: string,
            x: number,
            y: number,
            color?: Color,
        ): void;
        drawEllipse(_bounds: FixedRect, _style: ShapeStyle): void;
        drawGrid(spacing: Fixed, style: GridStyle): void;
        drawLine(_start: FixedVector2, _end: FixedVector2, _style: LineStyle): void;
        drawPerformanceStats(stats: PerformanceStats): void;
        drawPolygon(_vertices: FixedVector2[], _style: ShapeStyle): void;
        drawRect(_bounds: FixedRect, _style: ShapeStyle): void;
        drawText(_text: string, _position: FixedVector2, _style: TextStyle): void;
        drawTexture(
            _texture: ITexture,
            _position: FixedVector2,
            _style?: TextureStyle,
        ): void;
        drawTextureRegion(
            _texture: ITexture,
            _sourceRect: FixedRect,
            _destRect: FixedRect,
            _style?: TextureStyle,
        ): void;
        endFrame(): void;
        endPerformanceMeasure(name: string): void;
        getCurrentTransform(): Transform2D;
        getDebugConfig(): DebugConfig;
        getDebugMode(): DebugMode;
        getPerformanceMeasurements(): Map<string, number>;
        getRendererInfo(): {
            capabilities: string[];
            name: string;
            vendor?: string;
            version: string;
        };
        getRenderState(): RenderState;
        getRenderTarget(): unknown;
        getStatistics(): RenderStatistics;
        getViewport(): Viewport;
        measureText(_text: string, _style: TextStyle): FixedVector2;
        popRenderState(): void;
        popTransform(): void;
        pushRenderState(): void;
        pushTransform(_transform: Transform2D): void;
        resetStatistics(): void;
        setDebugConfig(config: Partial<DebugConfig>): void;
        setDebugLogging(enabled: boolean): void;
        setDebugMode(mode: DebugMode): void;
        setRenderState(_state: RenderState): void;
        setRenderTarget(_target: unknown): void;
        setViewMatrix(_matrix: FixedMatrix2x2): void;
        setViewport(_viewport: Viewport): void;
        startPerformanceMeasure(name: string): void;
        supportsFeature(_feature: string): boolean;
        takeScreenshot(): Promise<null | Blob>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    beginFrame clear clearPerformanceMeasurements debugLog dispose drawArrow drawAxis drawBounds drawCircle drawCrosshair drawDebugOverlay drawDebugText drawDebugTextScreen drawEllipse drawGrid drawLine drawPerformanceStats drawPolygon drawRect drawText drawTexture drawTextureRegion endFrame endPerformanceMeasure getCurrentTransform getDebugConfig getDebugMode getPerformanceMeasurements getRendererInfo getRenderState getRenderTarget getStatistics getViewport measureText popRenderState popTransform pushRenderState pushTransform resetStatistics setDebugConfig setDebugLogging setDebugMode setRenderState setRenderTarget setViewMatrix setViewport startPerformanceMeasure supportsFeature takeScreenshot

    Methods

    • Log debug message with optional color 记录带可选颜色的调试消息

      Parameters

      • message: string
      • Optionalcolor: Color

      Returns void

    • Draw an arrow from start to end point 从起点到终点绘制箭头

      Parameters

      • start: FixedVector2
      • end: FixedVector2
      • color: Color
      • OptionalheadSize: Fixed

      Returns void

    • Draw coordinate axes at origin 在原点绘制坐标轴

      Parameters

      • origin: FixedVector2
      • scale: Fixed

      Returns void

    • Draw a cross-hair at the specified position 在指定位置绘制十字线

      Parameters

      • position: FixedVector2
      • size: Fixed
      • color: Color

      Returns void

    • Draw debug text at world position 在世界位置绘制调试文本

      Parameters

      • text: string
      • position: FixedVector2
      • Optionalcolor: Color

      Returns void

    • Draw debug text at screen position 在屏幕位置绘制调试文本

      Parameters

      • text: string
      • x: number
      • y: number
      • Optionalcolor: Color

      Returns void

    • End measuring performance for a named operation 结束测量命名操作的性能

      Parameters

      • name: string

      Returns void

    • Get performance measurements 获取性能测量结果

      Returns Map<string, number>

    • Get renderer information 获取渲染器信息

      Returns { capabilities: string[]; name: string; vendor?: string; version: string }

    • Enable/disable debug logging 启用/禁用调试日志

      Parameters

      • enabled: boolean

      Returns void

    • Set the view matrix for camera transformation 设置用于相机变换的视图矩阵

      Parameters

      • _matrix: FixedMatrix2x2

      Returns void

    • Start measuring performance for a named operation 开始测量命名操作的性能

      Parameters

      • name: string

      Returns void

    • Take a screenshot of the current frame 截取当前帧的屏幕截图

      Returns Promise<null | Blob>

    Settings

    Member Visibility

    On This Page

    Methods