DebugDraw

Index

Methods

• drawCircle
• drawLine
• drawPoint
• drawRect
• drawText
• measureText

Methods

drawCircle

• drawCircle(pos: Vector, radius: number, color: Color, stroke?: Color, thickness?: number): void

• Draw a circle to the Excalibur Graphics context

  ---

  Parameters

  • pos: Vector

  • radius: number

  • color: Color

  • optionalstroke: Color

    Optionally specify the stroke color

  • optionalthickness: number

  Returns void

drawLine

• drawLine(start: Vector, end: Vector, lineOptions?: LineGraphicsOptions): void

• Draw a debugging line to the screen

  ---

  Parameters

  • start: Vector

    '

  • end: Vector

  • optionallineOptions: LineGraphicsOptions

  Returns void

drawPoint

• drawPoint(point: Vector, pointOptions?: PointGraphicsOptions): void

• Draw a debugging point to the screen

  ---

  Parameters

  • point: Vector

  • optionalpointOptions: PointGraphicsOptions

  Returns void

drawRect

• drawRect(x: number, y: number, width: number, height: number, rectOptions?: RectGraphicsOptions): void

• Draw a debugging rectangle to the screen

  ---

  Parameters

  • x: number

  • y: number

  • width: number

  • height: number

  • optionalrectOptions: RectGraphicsOptions

  Returns void

drawText

• drawText(text: string, pos: Vector, options?: DebugTextOptions): void

• Debug text styling options

  ---

  Parameters

  • text: string

  • pos: Vector

  • optionaloptions: DebugTextOptions

  Returns void

measureText

• measureText(text: string, scale?: number): { height: number; width: number }

• Measure the pixel dimensions of debug text as it would be drawn by DebugDraw.drawText, accounting for the optional scale factor. Useful for sizing UI around debug labels.

  ---

  Parameters

  • text: string

    Text to measure

  • optionalscale: number

    Glyph scale factor, defaults to 1

  Returns { height: number; width: number }

  • height: number

  • width: number