DebugText

Internal debug text helper

Index

Constructors

• constructor

Properties

• fontSheet
• size

Accessors

• backgroundColor
• borderColor
• foregroundColor

Methods

• load
• measureText
• write

Constructors

constructor

• DebugText(): DebugText

• Returns DebugText

Properties

publicreadonlyfontSheet

fontSheet: string = debugFont2

base64 font

publicsize

size: number = 16

Accessors

publicbackgroundColor

• get backgroundColor(): Color

• Returns Color

publicborderColor

• get borderColor(): Color

• Returns Color

publicforegroundColor

• get foregroundColor(): Color

• Returns Color

Methods

publicload

• load(): Promise<void>

• Returns Promise<void>

publicmeasureText

• measureText(text: string, scale?: number): BoundingBox

• Measures the pixel dimensions of text as it would be drawn by DebugText.write, accounting for the optional scale factor.

  ---

  Parameters

  • text: string

    Text to measure

  • scale: number = 1

    Glyph scale factor, defaults to 1

  Returns BoundingBox

  BoundingBox whose width/height are the rendered size in pixels (origin Zero)

publicwrite

• write(ctx: ExcaliburGraphicsContext, text: string, pos: Vector, foreground?: Color, background?: Color, scale?: number): void

• Writes debug text using the built in sprint font

  ---

  Parameters

  • ctx: ExcaliburGraphicsContext

  • text: string

  • pos: Vector

  • optionalforeground: Color

    Optional foreground color override

  • optionalbackground: Color

    Optional background color override

  • scale: number = 1

    Optional glyph scale factor, defaults to 1

  Returns void