ExcaliburGraphicsContextWebGL

Implements

• ExcaliburGraphicsContext

Index

Constructors

• constructor

Properties

• backgroundColor
• debug
• materialScreenTexture
• multiSampleAntialiasing
• pixelArtSampler
• samples
• smoothing
• snapToPixel
• textureLoader
• transparency
• useDrawSorting
• uvPadding

Accessors

• height
• material
• opacity
• ortho
• tint
• width
• z

Methods

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

Constructors

constructor

• new ExcaliburGraphicsContextWebGL(options: ExcaliburGraphicsContextWebGLOptions): ExcaliburGraphicsContextWebGL

• Parameters

  • options: ExcaliburGraphicsContextWebGLOptions

  Returns ExcaliburGraphicsContextWebGL

Properties

publicbackgroundColor

backgroundColor: Color = Color.ExcaliburBlue

Implementation of ExcaliburGraphicsContext.backgroundColor

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

debug

debug: ExcaliburGraphicsContextWebGLDebug = ...

Implementation of ExcaliburGraphicsContext.debug

Access the debug drawing api

publicmaterialScreenTexture

materialScreenTexture: WebGLTexture

publicreadonlymultiSampleAntialiasing

multiSampleAntialiasing: boolean = true

publicreadonlypixelArtSampler

pixelArtSampler: boolean = false

Whether the pixel art sampler is enabled for smooth sub pixel anti-aliasing

publicoptionalreadonlysamples

samples?: number

publicreadonlysmoothing

smoothing: boolean = false

Implementation of ExcaliburGraphicsContext.smoothing

Native context smoothing

publicsnapToPixel

snapToPixel: boolean = false

Implementation of ExcaliburGraphicsContext.snapToPixel

Snaps the drawing x/y coordinate to the nearest whole pixel

publictextureLoader

textureLoader: TextureLoader

publicreadonlytransparency

transparency: boolean = true

publicuseDrawSorting

useDrawSorting: boolean = true

Implementation of ExcaliburGraphicsContext.useDrawSorting

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

publicuvPadding

uvPadding: number = 0.01

UV padding in pixels to use in internal image rendering to prevent texture bleed

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

publicortho

• get ortho(): Matrix

• Returns Matrix

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

publicz

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

• Implementation of ExcaliburGraphicsContext.z

  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

  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

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

publiccheckIfResolutionSupported

• checkIfResolutionSupported(dim: Resolution): boolean

• Checks the underlying webgl implementation if the requested internal resolution is supported

  ---

  Parameters

  • dim: Resolution

  Returns boolean

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

  Material

publiccreateShader

• createShader(options: Omit<ShaderOptions, gl>): Shader

• Parameters

  • options: Omit<ShaderOptions, gl>

  Returns Shader

publicdispose

• dispose(): void

• Implementation of ExcaliburGraphicsContext.dispose

  Returns void

publicdraw

• draw<TRenderer>(rendererName: TRenderer[type], ...args: Parameters<TRenderer[draw]>): void

• Type parameters

  • TRenderer: RendererPlugin

  Parameters

  • rendererName: TRenderer[type]

  • rest...args: Parameters<TRenderer[draw]>

  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, stroke?: Color, strokeThickness?: number): void

• Implementation of ExcaliburGraphicsContext.drawRectangle

  Draw a solid rectangle to the Excalibur Graphics context

  ---

  Parameters

  • pos: Vector

  • width: number

  • height: number

  • color: Color

  • optionalstroke: Color

  • optionalstrokeThickness: number

  Returns void

publicendDrawLifecycle

• endDrawLifecycle(): void

• Implementation of ExcaliburGraphicsContext.endDrawLifecycle

  Returns void

flush

• flush(): void

• Implementation of ExcaliburGraphicsContext.flush

  Flushes all batched rendering to the screen

  ---

  Returns void

publicget

• get(rendererName: string): RendererPlugin

• Parameters

  • rendererName: string

  Returns RendererPlugin

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

publicregister

• register<T>(renderer: T): void

• Type parameters

  • T: RendererPlugin

  Parameters

  • renderer: T

  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

publicrestore

• restore(): void

• Implementation of ExcaliburGraphicsContext.restore

  Restore the state of the canvas from the stack

  ---

  Returns void

publicrotate

• rotate(angle: number): void

• Implementation of ExcaliburGraphicsContext.rotate

  Rotate the context about the current origin

  ---

  Parameters

  • angle: number

  Returns void

publicsave

• save(): void

• Implementation of ExcaliburGraphicsContext.save

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

  ---

  Returns void

publicscale

• 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

publictransform

• transform(matrix: AffineMatrix): void

• Parameters

  • matrix: AffineMatrix

  Returns void

publictranslate

• 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: Resolution): void

• Implementation of ExcaliburGraphicsContext.updateViewport

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

  ---

  Parameters

  • resolution: Resolution

  Returns void