excalibur 0.32.0-alpha.1570 → 0.32.0-alpha.1571

package/CHANGELOG.md

@@ -12,9 +12,33 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Deprecated
 
 - Legacy `EasingFunctions.*` are deprecated in favor of the simpler forms
+- Legacy `ex.BoundingBox.draw(..)` is deprecated, use `ex.BoundBox.debug(...)`
 
 ### Added
 
+
+- Added a way to configure general debug settings on text
+  ```typescript
+  class DebugConfig { 
+    ...
+      public settings = {
+        text: {
+          foreground: Color.Black,
+          background: Color.Transparent,
+          border: Color.Transparent
+        },
+        z: {
+          text:  Number.POSITIVE_INFINITY,
+          point: Number.MAX_SAFE_INTEGER - 1,
+          ray:   Number.MAX_SAFE_INTEGER - 1,
+          dashed:Number.MAX_SAFE_INTEGER - 2,
+          solid: Number.MAX_SAFE_INTEGER - 3
+        }
+      }
+    ...
+  }
+  ```
+- Added foreground and background color to `ex.DebugText`
 - Added a convenience parameter to set the initial graphics or material in an Actor
   ```typescript
   const cloudSprite = cloud.toSprite();
@@ -62,6 +86,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Updates
 
+- Perf improvement in debug draw mode
 - When overriding a built-in uniform/graphic there is now a warning in dev excalibur builds 
 - Camera zoom and move now support new easing functions form
 - MoveTo/MoveBy actions now support new easing function form
@@ -71,7 +96,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
--
+- Debug Text Font is switched to the more legible [monogram](https://datagoblin.itch.io/monogram)
 
 <!--------------------------------- DO NOT EDIT BELOW THIS LINE --------------------------------->
 <!--------------------------------- DO NOT EDIT BELOW THIS LINE --------------------------------->

package/build/dist/Collision/BoundingBox.d.ts

@@ -1,8 +1,7 @@
 import { Vector } from '../Math/vector';
 import type { Ray } from '../Math/ray';
-import { Color } from '../Color';
 import { Side } from './Side';
-import type { ExcaliburGraphicsContext } from '../Graphics/Context/ExcaliburGraphicsContext';
+import type { ExcaliburGraphicsContext, RectGraphicsOptions } from '../Graphics/Context/ExcaliburGraphicsContext';
 import type { AffineMatrix } from '../Math/affine-matrix';
 export interface BoundingBoxOptions {
     left: number;
@@ -149,6 +148,13 @@ export declare class BoundingBox {
      * Draw a debug bounding box
      * @param ex
      * @param color
+     * @deprecated
      */
-    draw(ex: ExcaliburGraphicsContext, color?: Color): void;
+    draw(ex: ExcaliburGraphicsContext, options?: RectGraphicsOptions): void;
+    /**
+     * Draw a debug bounding box
+     * @param ex
+     * @param color
+     */
+    debug(ex: ExcaliburGraphicsContext, options?: RectGraphicsOptions): void;
 }

package/build/dist/Debug/DebugConfig.d.ts

@@ -151,6 +151,20 @@ export declare class DebugConfig {
      * Performance statistics
      */
     stats: DebugStats;
+    settings: {
+        text: {
+            foreground: Color;
+            background: Color;
+            border: Color;
+        };
+        z: {
+            text: number;
+            point: number;
+            ray: number;
+            dashed: number;
+            solid: number;
+        };
+    };
     /**
      * Correct or simulate color blindness using {@apilink ColorBlindnessPostProcessor}.
      * @warning Will reduce FPS.
@@ -177,7 +191,6 @@ export declare class DebugConfig {
      */
     transform: {
         showAll: boolean;
-        debugZIndex: number;
         showPosition: boolean;
         showPositionLabel: boolean;
         positionColor: Color;

package/build/dist/Graphics/Context/ExcaliburGraphicsContext.d.ts

@@ -113,9 +113,13 @@ export interface ExcaliburGraphicsContextState {
 }
 export interface LineGraphicsOptions {
     color?: Color;
+    dashed?: boolean;
+    lineWidth?: number;
 }
 export interface RectGraphicsOptions {
     color?: Color;
+    dashed?: boolean;
+    lineWidth?: number;
 }
 export interface PointGraphicsOptions {
     color: Color;
@@ -144,6 +148,15 @@ export interface DebugDraw {
      * @param pointOptions
      */
     drawPoint(point: Vector, pointOptions?: PointGraphicsOptions): void;
+    /**
+     * Draw a circle to the Excalibur Graphics context
+     * @param pos
+     * @param radius
+     * @param color
+     * @param stroke Optionally specify the stroke color
+     * @param thickness
+     */
+    drawCircle(pos: Vector, radius: number, color: Color, stroke?: Color, thickness?: number): void;
     /**
      * Draw debug text
      * @param text

package/build/dist/Graphics/Context/ExcaliburGraphicsContext2DCanvas.d.ts

@@ -3,7 +3,7 @@ import type { Vector } from '../../Math/vector';
 import { Color } from '../../Color';
 import type { Resolution } from '../../Screen';
 import type { PostProcessor } from '../PostProcessor/PostProcessor';
-import type { AffineMatrix } from '../../Math/affine-matrix';
+import { AffineMatrix } from '../../Math/affine-matrix';
 import type { Material, MaterialOptions } from './material';
 declare class ExcaliburGraphicsContext2DCanvasDebug implements DebugDraw {
     private _ex;
@@ -19,6 +19,7 @@ declare class ExcaliburGraphicsContext2DCanvasDebug implements DebugDraw {
     drawRect(x: number, y: number, width: number, height: number): void;
     drawLine(start: Vector, end: Vector, lineOptions?: LineGraphicsOptions): void;
     drawPoint(point: Vector, pointOptions?: PointGraphicsOptions): void;
+    drawCircle(pos: Vector, radius: number, color: Color, stroke?: Color, thickness?: number): void;
     drawText(text: string, pos: Vector): void;
 }
 export interface ExcaliburGraphicsContext2DOptions extends ExcaliburGraphicsContextOptions {

package/build/dist/Graphics/Context/ExcaliburGraphicsContextWebGL.d.ts

@@ -20,7 +20,9 @@ declare class ExcaliburGraphicsContextWebGLDebug implements DebugDraw {
     private _debugText;
     constructor(_webglCtx: ExcaliburGraphicsContextWebGL);
     /**
-     * Draw a debugging rectangle to the context
+     * Draw a debugging rectangle to the graphics context
+     *
+     * Debugging draws are independent of scale/zoom
      * @param x
      * @param y
      * @param width
@@ -28,18 +30,33 @@ declare class ExcaliburGraphicsContextWebGLDebug implements DebugDraw {
      */
     drawRect(x: number, y: number, width: number, height: number, rectOptions?: RectGraphicsOptions): void;
     /**
-     * Draw a debugging line to the context
+     * Draw a debugging line to the graphics context
+     *
+     * Debugging draws are independent of scale/zoom
      * @param start
      * @param end
      * @param lineOptions
      */
     drawLine(start: Vector, end: Vector, lineOptions?: LineGraphicsOptions): void;
     /**
-     * Draw a debugging point to the context
+     * Draw a debugging point to the graphics context
+     *
+     * Debugging draws are independent of scale/zoom
      * @param point
      * @param pointOptions
      */
     drawPoint(point: Vector, pointOptions?: PointGraphicsOptions): void;
+    /**
+     * Draw a debugging circle to the graphics context
+     *
+     * Debugging draws are independent of scale/zoom
+     */
+    drawCircle(pos: Vector, radius: number, color: Color, stroke?: Color, thickness?: number): void;
+    /**
+     * Draw some debugging text to the graphics context
+     *
+     * Debugging draws are independent of scale/zoom
+     */
     drawText(text: string, pos: Vector): void;
 }
 export interface WebGLGraphicsContextInfo {

package/build/dist/Graphics/Context/debug-circle-renderer/debug-circle-renderer.d.ts

@@ -0,0 +1,23 @@
+import { Color } from '../../../Color';
+import type { Vector } from '../../../Math/vector';
+import type { ExcaliburGraphicsContextWebGL } from '../ExcaliburGraphicsContextWebGL';
+import type { RendererPlugin } from '../renderer';
+export declare class DebugCircleRenderer implements RendererPlugin {
+    readonly type = "ex.debug-circle";
+    priority: number;
+    private _maxCircles;
+    private _shader;
+    private _context;
+    private _gl;
+    private _buffer;
+    private _layout;
+    private _quads;
+    private _circleCount;
+    private _vertexIndex;
+    initialize(gl: WebGL2RenderingContext, context: ExcaliburGraphicsContextWebGL): void;
+    dispose(): void;
+    private _isFull;
+    draw(pos: Vector, radius: number, color: Color, stroke?: Color, strokeThickness?: number): void;
+    hasPendingDraws(): boolean;
+    flush(): void;
+}

package/build/dist/Graphics/Context/{line-renderer/line-renderer.d.ts → debug-line-renderer/debug-line-renderer.d.ts}

@@ -2,12 +2,8 @@ import type { Vector } from '../../../Math/vector';
 import type { Color } from '../../../Color';
 import type { ExcaliburGraphicsContextWebGL } from '../ExcaliburGraphicsContextWebGL';
 import type { RendererPlugin } from '../renderer';
-export interface LineOptions {
-    color?: Color;
-    width?: number;
-}
-export declare class LineRenderer implements RendererPlugin {
-    readonly type = "ex.line";
+export declare class DebugLineRenderer implements RendererPlugin {
+    readonly type = "ex.debug-line";
     priority: number;
     private _context;
     private _gl;
@@ -21,7 +17,9 @@ export declare class LineRenderer implements RendererPlugin {
     dispose(): void;
     private _startScratch;
     private _endScratch;
-    draw(start: Vector, end: Vector, color: Color): void;
+    private _lengthSoFar;
+    private _currentlyDashed;
+    draw(start: Vector, end: Vector, color: Color, width?: number, dashed?: boolean): void;
     private _isFull;
     hasPendingDraws(): boolean;
     flush(): void;

package/build/dist/Graphics/Context/{point-renderer/point-renderer.d.ts → debug-point-renderer/debug-point-renderer.d.ts}

@@ -2,8 +2,8 @@ import type { Vector } from '../../../Math/vector';
 import type { Color } from '../../../Color';
 import type { ExcaliburGraphicsContextWebGL } from '../ExcaliburGraphicsContextWebGL';
 import type { RendererPlugin } from '../renderer';
-export declare class PointRenderer implements RendererPlugin {
-    readonly type = "ex.point";
+export declare class DebugPointRenderer implements RendererPlugin {
+    readonly type = "ex.debug-point";
     priority: number;
     private _shader;
     private _maxPoints;

package/build/dist/Graphics/Context/debug-text.d.ts

@@ -1,5 +1,6 @@
 import type { ExcaliburGraphicsContext } from '../Context/ExcaliburGraphicsContext';
 import type { Vector } from '../../Math/vector';
+import type { Color } from '../../Color';
 /**
  * Internal debug text helper
  */
@@ -10,6 +11,9 @@ export declare class DebugText {
      */
     readonly fontSheet: string;
     size: number;
+    foregroundColor: Color;
+    backgroundColor: Color;
+    borderColor: Color;
     private _imageSource;
     private _spriteSheet;
     private _spriteFont;
@@ -20,5 +24,5 @@ export declare class DebugText {
      * @param text
      * @param pos
      */
-    write(ctx: ExcaliburGraphicsContext, text: string, pos: Vector): void;
+    write(ctx: ExcaliburGraphicsContext, text: string, pos: Vector, foreground?: Color, background?: Color): void;
 }

package/build/dist/Graphics/Debug.d.ts

@@ -1,13 +1,15 @@
 import type { Vector } from '../Math/vector';
-import type { ExcaliburGraphicsContext, LineGraphicsOptions, PointGraphicsOptions } from './Context/ExcaliburGraphicsContext';
+import type { ExcaliburGraphicsContext, LineGraphicsOptions, PointGraphicsOptions, RectGraphicsOptions } from './Context/ExcaliburGraphicsContext';
 import { Color } from '../Color';
 import type { Ray } from '../Math/ray';
 import type { BoundingBox } from '../Collision/BoundingBox';
+import type { DebugConfig } from '../Debug';
 export declare class Debug {
     static _drawCalls: ((ctx: ExcaliburGraphicsContext) => void)[];
     static _ctx: ExcaliburGraphicsContext;
     static z: number;
-    static registerGraphicsContext(ctx: ExcaliburGraphicsContext): void;
+    static config: DebugConfig;
+    static registerDebugConfig(config: DebugConfig): void;
     static draw(debugDrawCall: (ctx: ExcaliburGraphicsContext) => void): void;
     static drawPoint(point: Vector, options?: PointGraphicsOptions): void;
     static drawLine(start: Vector, end: Vector, options?: LineGraphicsOptions): void;
@@ -21,9 +23,7 @@ export declare class Debug {
         strokeColor?: Color;
         width?: number;
     }): void;
-    static drawBounds(boundingBox: BoundingBox, options?: {
-        color?: Color;
-    }): void;
+    static drawBounds(boundingBox: BoundingBox, options?: RectGraphicsOptions): void;
     static drawRay(ray: Ray, options?: {
         distance?: number;
         color?: Color;