ExcaliburGraphicsContext2DCanvas

Implements

• ExcaliburGraphicsContext

Index

Constructors

• constructor

Properties

• backgroundColor
• debug
• snapToPixel
• useDrawSorting
• z

Accessors

• height
• material
• opacity
• smoothing
• tint
• width

Methods

• addPostProcessor
• beginDrawLifecycle
• clear
• clearPostProcessors
• createMaterial
• dispose
• drawCircle
• drawImage
• drawLine
• drawRectangle
• endDrawLifecycle
• flush
• getTransform
• multiply
• removePostProcessor
• resetTransform
• restore
• rotate
• save
• scale
• translate
• updatePostProcessors
• updateViewport

Constructors

constructor

• new ExcaliburGraphicsContext2DCanvas(options: ExcaliburGraphicsContext2DOptions): ExcaliburGraphicsContext2DCanvas

• Parameters

  • options: ExcaliburGraphicsContext2DOptions

  Returns ExcaliburGraphicsContext2DCanvas

Properties

publicbackgroundColor

backgroundColor: Color = Color.ExcaliburBlue

Implementation of ExcaliburGraphicsContext.backgroundColor

Set the background color of the graphics context, default is [[Color.ExcaliburBlue]]

debug

debug: ExcaliburGraphicsContext2DCanvasDebug = ...

Implementation of ExcaliburGraphicsContext.debug

Access the debug drawing api

publicsnapToPixel

snapToPixel: boolean = false

Implementation of ExcaliburGraphicsContext.snapToPixel

Snaps all drawings to the nearest pixel truncated down, by default false

publicreadonlyuseDrawSorting

useDrawSorting: boolean = false

Implementation of ExcaliburGraphicsContext.useDrawSorting

Unused in Canvas implementation

publicz

z: number = 0

Implementation of ExcaliburGraphicsContext.z

Unused in Canvas implementation

Accessors

publicheight

• get height(): number

• Implementation of ExcaliburGraphicsContext.height

  Returns number

publicmaterial

• get material(): Material
• set material(material: Material): void

• Implementation of ExcaliburGraphicsContext.material

  Gets or sets the material to be used in the current context's drawings

  This allows customs shaders to be used but draw calls are no longer batched by default.

  ---

  Returns Material

• Implementation of ExcaliburGraphicsContext.material

  Gets or sets the material to be used in the current context's drawings

  This allows customs shaders to be used but draw calls are no longer batched by default.

  ---

  Parameters

  • material: Material

  Returns void

publicopacity

• get opacity(): number
• set opacity(value: number): void

• Implementation of ExcaliburGraphicsContext.opacity

  Sets the opacity of the current [[Graphic]] being drawn, default is 1

  ---

  Returns number

• Implementation of ExcaliburGraphicsContext.opacity

  Sets the opacity of the current [[Graphic]] being drawn, default is 1

  ---

  Parameters

  • value: number

  Returns void

publicsmoothing

• get smoothing(): boolean
• set smoothing(value: boolean): void

• Implementation of ExcaliburGraphicsContext.smoothing

  Enable smoothed drawing (also known as anti-aliasing), by default true

  ---

  Returns boolean

• Implementation of ExcaliburGraphicsContext.smoothing

  Enable smoothed drawing (also known as anti-aliasing), by default true

  ---

  Parameters

  • value: boolean

  Returns void

publictint

• get tint(): Color
• set tint(color: Color): void

• Implementation of ExcaliburGraphicsContext.tint

  Sets the tint color to be multiplied by any images drawn, default is black 0xFFFFFFFF

  ---

  Returns Color

• Implementation of ExcaliburGraphicsContext.tint

  Sets the tint color to be multiplied by any images drawn, default is black 0xFFFFFFFF

  ---

  Parameters

  • color: Color

  Returns void

publicwidth

• get width(): number

• Implementation of ExcaliburGraphicsContext.width

  Returns number

Methods

publicaddPostProcessor

• addPostProcessor(_postprocessor: PostProcessor): void

• Implementation of ExcaliburGraphicsContext.addPostProcessor

  Add a post processor to the graphics context

  Post processors are run in the order they were added.

  ---

  Parameters

  • _postprocessor: PostProcessor

  Returns void

publicbeginDrawLifecycle

• beginDrawLifecycle(): void

• Implementation of ExcaliburGraphicsContext.beginDrawLifecycle

  Returns void

clear

• clear(): void

• Implementation of ExcaliburGraphicsContext.clear

  Clears the screen with the current background color

  ---

  Returns void

publicclearPostProcessors

• clearPostProcessors(): void

• Implementation of ExcaliburGraphicsContext.clearPostProcessors

  Remove all post processors from the graphics context

  ---

  Returns void

publiccreateMaterial

• createMaterial(options: Omit<MaterialOptions, graphicsContext>): Material

• Implementation of ExcaliburGraphicsContext.createMaterial

  Creates and initializes the material which compiles the internal shader

  ---

  Parameters

  • options: Omit<MaterialOptions, graphicsContext>

  Returns Material

dispose

• dispose(): void

• Implementation of ExcaliburGraphicsContext.dispose

  Returns void

publicdrawCircle

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

• Implementation of ExcaliburGraphicsContext.drawCircle

  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

drawImage

• drawImage(image: HTMLImageSource, x: number, y: number): void
• drawImage(image: HTMLImageSource, x: number, y: number, width: number, height: number): void
• drawImage(image: HTMLImageSource, sx: number, sy: number, swidth?: number, sheight?: number, dx?: number, dy?: number, dwidth?: number, dheight?: number): void

• Implementation of ExcaliburGraphicsContext.drawImage

  Draw an image to the Excalibur Graphics context at an x and y coordinate using the images width and height

  ---

  Parameters

  • image: HTMLImageSource

  • x: number

  • y: number

  Returns void

publicdrawLine

• drawLine(start: Vector, end: Vector, color: Color, thickness?: number): void

• Implementation of ExcaliburGraphicsContext.drawLine

  Draw a solid line to the Excalibur Graphics context

  ---

  Parameters

  • start: Vector

  • end: Vector

  • color: Color

  • thickness: number = 1

  Returns void

publicdrawRectangle

• drawRectangle(pos: Vector, width: number, height: number, color: Color): void

• Implementation of ExcaliburGraphicsContext.drawRectangle

  Draw a solid rectangle to the Excalibur Graphics context

  ---

  Parameters

  • pos: Vector

  • width: number

  • height: number

  • color: Color

  Returns void

publicendDrawLifecycle

• endDrawLifecycle(): void

• Implementation of ExcaliburGraphicsContext.endDrawLifecycle

  Returns void

flush

• flush(): void

• Implementation of ExcaliburGraphicsContext.flush

  Flushes the batched draw calls to the screen

  ---

  Returns void

publicgetTransform

• getTransform(): AffineMatrix

• Implementation of ExcaliburGraphicsContext.getTransform

  Gets the current transform

  ---

  Returns AffineMatrix

publicmultiply

• multiply(_m: AffineMatrix): void

• Implementation of ExcaliburGraphicsContext.multiply

  Multiplies the current transform by a matrix

  ---

  Parameters

  • _m: AffineMatrix

  Returns void

publicremovePostProcessor

• removePostProcessor(_postprocessor: PostProcessor): void

• Implementation of ExcaliburGraphicsContext.removePostProcessor

  Remove a specific post processor from the graphics context

  ---

  Parameters

  • _postprocessor: PostProcessor

  Returns void

publicresetTransform

• resetTransform(): void

• Implementation of ExcaliburGraphicsContext.resetTransform

  Resets the current transform to the identity matrix

  ---

  Returns void

restore

• restore(): void

• Implementation of ExcaliburGraphicsContext.restore

  Restore the state of the canvas from the stack

  ---

  Returns void

rotate

• rotate(angle: number): void

• Implementation of ExcaliburGraphicsContext.rotate

  Rotate the context about the current origin

  ---

  Parameters

  • angle: number

  Returns void

save

• save(): void

• Implementation of ExcaliburGraphicsContext.save

  Save the current state of the canvas to the stack (transforms and opacity)

  ---

  Returns void

scale

• scale(x: number, y: number): void

• Implementation of ExcaliburGraphicsContext.scale

  Scale the context by an x and y factor

  ---

  Parameters

  • x: number

  • y: number

  Returns void

translate

• translate(x: number, y: number): void

• Implementation of ExcaliburGraphicsContext.translate

  Translate the origin of the context by an x and y

  ---

  Parameters

  • x: number

  • y: number

  Returns void

publicupdatePostProcessors

• updatePostProcessors(delta: number): void

• Implementation of ExcaliburGraphicsContext.updatePostProcessors

  Parameters

  • delta: number

  Returns void

publicupdateViewport

• updateViewport(_resolution: ScreenDimension): void

• Implementation of ExcaliburGraphicsContext.updateViewport

  Update the context with the current viewport dimensions (used in resizing)

  ---

  Parameters

  • _resolution: ScreenDimension

  Returns void