Class: CanvasPoolClass

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CanvasPool.d.ts:19

Internal

CanvasPool is a utility class that manages a pool of reusable canvas elements

Constructors

Constructor

> new CanvasPoolClass(canvasOptions?): CanvasPoolClass

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CanvasPool.d.ts:29

Parameters

canvasOptions?

ICanvasRenderingContext2DSettings

Returns

CanvasPoolClass

Properties

canvasOptions

> canvasOptions: ICanvasRenderingContext2DSettings

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CanvasPool.d.ts:20

enableFullScreen

> enableFullScreen: boolean

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CanvasPool.d.ts:27

Allow renderTextures of the same size as screen, not just pow2

Automatically sets to true after setScreenSize

Default

false

Methods

clear()

> clear(): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CanvasPool.d.ts:49

Returns

void

getOptimalCanvasAndContext()

> getOptimalCanvasAndContext(minWidth, minHeight, resolution?): CanvasAndContext

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CanvasPool.d.ts:43

Gets a Power-of-Two render texture or fullScreen texture

Parameters

minWidth

number

The minimum width of the render texture.

minHeight

number

The minimum height of the render texture.

resolution?

number

The resolution of the render texture.

Returns

CanvasAndContext

The new render texture.

returnCanvasAndContext()

> returnCanvasAndContext(canvasAndContext): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CanvasPool.d.ts:48

Place a render texture back into the pool.

Parameters

canvasAndContext

CanvasAndContext

Returns

void