Class ExcaliburGraphicsContextWebGL

Hierarchy

ExcaliburGraphicsContextWebGL

Implements

ExcaliburGraphicsContext

Index

Constructors

constructor

new ExcaliburGraphicsContextWebGL(options: ExcaliburGraphicsContextOptions): ExcaliburGraphicsContextWebGL
Parameters
- options: ExcaliburGraphicsContextOptions
Returns ExcaliburGraphicsContextWebGL
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:178

Properties

`Internal` __gl

__gl: WebGL2RenderingContext

Meant for internal use only. Access the internal context at your own risk and no guarantees this will exist in the future.

backgroundColor

backgroundColor: Color = Color.ExcaliburBlue

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

debug

debug: ExcaliburGraphicsContextWebGLDebug = ...

Access the debug drawing api

smoothing

smoothing: boolean = false

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

snapToPixel

snapToPixel: boolean = false

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

useDrawSorting

useDrawSorting: boolean = true

Excalibur will automatically sort draw calls by z and priority for maximal draw performance, this can disrupt a specific desired painter order.

To force a specific draw call order, use ExcaliburGraphicsContext.z

By default useDrawSorting is true, to opt out set this to false

Accessors

height

get height(): number
Returns number
Implementation of ExcaliburGraphicsContext.height
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:157

opacity

get opacity(): number
Sets the opacity of the current Graphic being drawn, default is 1

Returns number
Implementation of ExcaliburGraphicsContext.opacity
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:137
set opacity(value: number): void
Sets the opacity of the current Graphic being drawn, default is 1
Parameters
- value: number
Returns void
Implementation of ExcaliburGraphicsContext.opacity
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:141

ortho

get ortho(): Matrix
Returns Matrix
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:161

tint

get tint(): Color
Sets the tint color to be multiplied by any images drawn, default is black 0xFFFFFFFF

Returns Color
Implementation of ExcaliburGraphicsContext.tint
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:145
set tint(color: Color): void
Sets the tint color to be multiplied by any images drawn, default is black 0xFFFFFFFF
Parameters
- color: Color
Returns void
Implementation of ExcaliburGraphicsContext.tint
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:149

width

get width(): number
Returns number
Implementation of ExcaliburGraphicsContext.width
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:153

z

get z(): number
Set the current z context for the graphics context. Draw calls issued to the context will use this z to inform their sort order.

Note it is important to all ExcaliburGraphicsContext.save and ExcaliburGraphicsContext.restore when modifying state.

Returns number
Implementation of ExcaliburGraphicsContext.z
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:129
set z(value: number): void
Set the current z context for the graphics context. Draw calls issued to the context will use this z to inform their sort order.

Note it is important to all ExcaliburGraphicsContext.save and ExcaliburGraphicsContext.restore when modifying state.
Parameters
- value: number
Returns void
Implementation of ExcaliburGraphicsContext.z
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:133

Methods

addPostProcessor

addPostProcessor(postprocessor: PostProcessor): void
Add a post processor to the graphics context

Post processors are run in the order they were added.
Parameters
- postprocessor: PostProcessor
Returns void
Implementation of ExcaliburGraphicsContext.addPostProcessor
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:426

beginDrawLifecycle

beginDrawLifecycle(): void
Returns void
Implementation of ExcaliburGraphicsContext.beginDrawLifecycle
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:269

checkIfResolutionSupported

checkIfResolutionSupported(dim: ScreenDimension): boolean
Checks the underlying webgl implementation if the requested internal resolution is supported
Parameters
- dim: ScreenDimension
Returns boolean
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:169

clear

clear(): void
Clears the screen with the current background color

Returns void
Implementation of ExcaliburGraphicsContext.clear
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:442

clearPostProcessors

clearPostProcessors(): void
Remove all post processors from the graphics context

Returns void
Implementation of ExcaliburGraphicsContext.clearPostProcessors
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:438

draw

draw<TRenderer>(rendererName: TRenderer["type"], ...args: Parameters<TRenderer["draw"]>): void
Type Parameters
- TRenderer extends RendererPlugin
Parameters
- rendererName: TRenderer["type"]
- Rest ...args: Parameters<TRenderer["draw"]>
Returns void
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:279

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
- Optional stroke: Color
  
  Optionally specify the stroke color
- Optional thickness: number
Returns void
Implementation of ExcaliburGraphicsContext.drawCircle
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:386

drawImage

drawImage(image: HTMLImageSource, x: number, y: number): void
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
Implementation of ExcaliburGraphicsContext.drawImage
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:334
drawImage(image: HTMLImageSource, x: number, y: number, width: number, height: number): void
Draw an image to the Excalibur Graphics context at an x and y coordinate with a specific width and height
Parameters
- image: HTMLImageSource
- x: number
- y: number
- width: number
- height: number
Returns void
Implementation of ExcaliburGraphicsContext.drawImage
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:335
drawImage(image: HTMLImageSource, sx: number, sy: number, swidth?: number, sheight?: number, dx?: number, dy?: number, dwidth?: number, dheight?: number): void
Draw an image to the Excalibur Graphics context specifying the source image coordinates (sx, sy, swidth, sheight) and to a specific destination on the context (dx, dy, dwidth, dheight)
Parameters
- image: HTMLImageSource
- sx: number
- sy: number
- Optional swidth: number
- Optional sheight: number
- Optional dx: number
- Optional dy: number
- Optional dwidth: number
- Optional dheight: number
Returns void
Implementation of ExcaliburGraphicsContext.drawImage
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:336

drawLine

drawLine(start: Vector, end: Vector, color: Color, thickness?: number): void
Draw a solid line to the Excalibur Graphics context
Parameters
- start: Vector
- end: Vector
- color: Color
- thickness: number = 1
Returns void
Implementation of ExcaliburGraphicsContext.drawLine
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:378

drawRectangle

drawRectangle(pos: Vector, width: number, height: number, color: Color, stroke?: Color, strokeThickness?: number): void
Draw a solid rectangle to the Excalibur Graphics context
Parameters
- pos: Vector
- width: number
- height: number
- color: Color
- Optional stroke: Color
- Optional strokeThickness: number
Returns void
Implementation of ExcaliburGraphicsContext.drawRectangle
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:382

endDrawLifecycle

endDrawLifecycle(): void
Returns void
Implementation of ExcaliburGraphicsContext.endDrawLifecycle
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:273

flush

flush(): void
Flushes all batched rendering to the screen

Returns void
Implementation of ExcaliburGraphicsContext.flush
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:454

get

get(rendererName: string): RendererPlugin
Parameters
- rendererName: string
Returns RendererPlugin
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:256

getTransform

getTransform(): AffineMatrix
Gets the current transform

Returns AffineMatrix
Implementation of ExcaliburGraphicsContext.getTransform
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:418

multiply

multiply(m: AffineMatrix): void
Multiplies the current transform by a matrix
Parameters
- m: AffineMatrix
Returns void
Implementation of ExcaliburGraphicsContext.multiply
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:422

register

register<T>(renderer: T): void
Type Parameters
- T extends RendererPlugin
Parameters
- renderer: T
Returns void
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:251

removePostProcessor

removePostProcessor(postprocessor: PostProcessor): void
Remove a specific post processor from the graphics context
Parameters
- postprocessor: PostProcessor
Returns void
Implementation of ExcaliburGraphicsContext.removePostProcessor
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:431

resetTransform

resetTransform(): void
Resets the current transform to the identity matrix

Returns void
Implementation of ExcaliburGraphicsContext.resetTransform
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:321

restore

restore(): void
Restore the state of the canvas from the stack

Returns void
Implementation of ExcaliburGraphicsContext.restore
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:397

rotate

rotate(angle: number): void
Rotate the context about the current origin
Parameters
- angle: number
Returns void
Implementation of ExcaliburGraphicsContext.rotate
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:406

save

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

Returns void
Implementation of ExcaliburGraphicsContext.save
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:392

scale

scale(x: number, y: number): void
Scale the context by an x and y factor
Parameters
- x: number
- y: number
Returns void
Implementation of ExcaliburGraphicsContext.scale
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:410

transform

transform(matrix: AffineMatrix): void
Parameters
- matrix: AffineMatrix
Returns void
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:414

translate

translate(x: number, y: number): void
Translate the origin of the context by an x and y
Parameters
- x: number
- y: number
Returns void
Implementation of ExcaliburGraphicsContext.translate
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:402

updateViewport

updateViewport(resolution: ScreenDimension): void
Update the context with the current viewport dimensions (used in resizing)
Parameters
- resolution: ScreenDimension
Returns void
Implementation of ExcaliburGraphicsContext.updateViewport
- Defined in Graphics/Context/ExcaliburGraphicsContextWebGL.ts:325

Class ExcaliburGraphicsContextWebGL

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: ExcaliburGraphicsContextOptions

Returns ExcaliburGraphicsContextWebGL

Properties

Internal __gl

backgroundColor

debug

smoothing

snapToPixel

useDrawSorting

Accessors

height

Returns number

opacity

Returns number

Parameters

value: number

Returns void

ortho

Returns Matrix

tint

Returns Color

Parameters

color: Color

Returns void

width

Returns number

z

Returns number

Parameters

value: number

Returns void

Methods

addPostProcessor

Parameters

postprocessor: PostProcessor

Returns void

beginDrawLifecycle

Returns void

checkIfResolutionSupported

Parameters

dim: ScreenDimension

Returns boolean

clear

Returns void

clearPostProcessors

Returns void

draw

Type Parameters

TRenderer extends RendererPlugin

Parameters

rendererName: TRenderer["type"]

Rest ...args: Parameters<TRenderer["draw"]>

Returns void

drawCircle

Parameters

pos: Vector

radius: number

color: Color

Optional stroke: Color

Optional thickness: number

Returns void

drawImage

Parameters

image: HTMLImageSource

x: number

y: number

Returns void

Parameters

image: HTMLImageSource

`Internal` __gl

`Rest` ...args: Parameters<TRenderer["draw"]>

`Optional` stroke: Color

`Optional` thickness: number

`Optional` swidth: number

`Optional` sheight: number

`Optional` dx: number

`Optional` dy: number

`Optional` dwidth: number

`Optional` dheight: number

`Optional` stroke: Color

`Optional` strokeThickness: number