Skip to main content

ExcaliburGraphicsContextWebGLOptions

Hierarchy

Index

Properties

Properties

optionalinheritedantialiasing

antialiasing?: boolean

Enables antialiasing on the canvas context (smooths pixels with default canvas sampling)

optionalinheritedbackgroundColor

backgroundColor?: Color

Current clearing color of the context

inheritedcanvasElement

canvasElement: HTMLCanvasElement

Target existing html canvas element

optionalcontext

context?: WebGL2RenderingContext

optionalinheritedenableTransparency

enableTransparency?: boolean

Enable canvas transparency

optionalgarbageCollector

garbageCollector?: { collectionInterval: number; garbageCollector: GarbageCollector }

Type declaration

optionalhandleContextLost

handleContextLost?: (e: Event) => void

Type declaration

    • (e: Event): void

    • Parameters

      • e: Event

      Returns void

optionalhandleContextRestored

handleContextRestored?: (e: Event) => void

Type declaration

    • (e: Event): void

    • Parameters

      • e: Event

      Returns void

optionalinheritedmultiSampleAntialiasing

multiSampleAntialiasing?: boolean | { samples: number }

Enable or disable multi-sample antialiasing in the internal render buffer.

If true the max number of samples will be used

By default enabled

optionalinheritedpixelArtSampler

pixelArtSampler?: boolean

Enable the sub pixel antialiasing pixel art sampler for nice looking pixel art

optionalinheritedpowerPreference

powerPreference?: default | high-performance | low-power

Hint the power preference to the graphics context

optionalinheritedsnapToPixel

snapToPixel?: boolean

Snaps the pixel to an integer value (floor)

optionalinheriteduseDrawSorting

useDrawSorting?: boolean

Feature flag that enables draw sorting will removed in v0.29

optionalinheriteduvPadding

uvPadding?: number

UV padding in pixels to use in the internal image rendering

Recommended .25 - .5 of a pixel

Page Options