Class: CanvasContextSystem

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:31

Canvas 2D context system for the CanvasRenderer.

Advanced

Implements

• System

Constructors

Constructor

> new CanvasContextSystem(renderer): CanvasContextSystem

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:59

Parameters

renderer

CanvasRenderer

The owning CanvasRenderer.

Returns

CanvasContextSystem

Properties

_activeBlendMode

> _activeBlendMode: BLEND_MODES

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:49

Current canvas blend mode.

---

_outerBlend

> _outerBlend: boolean

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:53

True when external blend mode control is in use.

---

_projTransform

> _projTransform: Matrix

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:51

Optional projection transform for render targets.

---

activeContext

> activeContext: CrossPlatformCanvasRenderingContext2D

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:41

Active 2D context for rendering (root or render target).

---

activeResolution

> activeResolution: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:43

Resolution of the active context.

---

blendModes

> readonly blendModes: Record<BLEND_MODES, GlobalCompositeOperation>

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:47

Map of Pixi blend modes to canvas composite operations.

---

rootContext

> rootContext: CrossPlatformCanvasRenderingContext2D

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:39

Root 2D context tied to the renderer's canvas.

---

smoothProperty

> smoothProperty: SmoothingEnabledProperties

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:45

The image smoothing property to toggle for this browser.

Methods

clear()

> clear(clearColor?, alpha?): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:76

Clears the current render target, optionally filling with a color.

Parameters

clearColor?

string | number | number[]

Color to fill after clearing.

alpha?

number

Alpha override for the clear color.

Returns

void

---

destroy()

> destroy(): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:83

Releases context references.

Returns

void

Implementation of

System.destroy

---

init()

> init(): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:62

Initializes the root context and smoothing flag selection.

Returns

void

Implementation of

System.init

---

resolutionChange()

> protected resolutionChange(resolution): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:60

Parameters

resolution

number

Returns

void

---

setBlendMode()

> setBlendMode(blendMode): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:81

Sets the active blend mode.

Parameters

blendMode

BLEND_MODES

Pixi blend mode.

Returns

void

---

setContextTransform()

> setContextTransform(transform, roundPixels?, localResolution?, skipGlobalTransform?): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/CanvasContextSystem.d.ts:70

Sets the current transform on the active context.

Parameters

transform

Matrix

Transform to apply.

roundPixels?

boolean

Whether to round translation to integers.

localResolution?

number

Optional local resolution multiplier.

skipGlobalTransform?

boolean

If true, skip applying the global world transform matrix.

Returns

void