Class: CanvasRenderTargetAdaptor

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/renderTarget/CanvasRenderTargetAdaptor.d.ts:28

Canvas adaptor for render targets.

Advanced

Constructors

Constructor

> new CanvasRenderTargetAdaptor(): CanvasRenderTargetAdaptor

Returns

CanvasRenderTargetAdaptor

Methods

clear()

> clear(renderTarget, _clear, clearColor?, viewport?): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/renderTarget/CanvasRenderTargetAdaptor.d.ts:67

Clears the render target.

Parameters

renderTarget

RenderTarget

Target to clear.

_clear

CLEAR_OR_BOOL

Clear mode (unused).

clearColor?

number[]

Optional clear color.

viewport?

Rectangle

Optional viewport rectangle.

Returns

void

Advanced

Implementation of

RenderTargetAdaptor.clear

---

copyToTexture()

> copyToTexture(sourceRenderSurfaceTexture, destinationTexture, originSrc, size, originDest?): Texture

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/renderTarget/CanvasRenderTargetAdaptor.d.ts:88

Copies a render target into a texture source.

Parameters

sourceRenderSurfaceTexture

RenderTarget

Source render target.

destinationTexture

Texture

Destination texture.

originSrc

Source origin.

x

number

Source x origin.

y

number

Source y origin.

size

Copy size.

height

number

Copy height.

width

number

Copy width.

originDest?

Destination origin.

x

number

Destination x origin.

y

number

Destination y origin.

Returns

Texture

Advanced

Implementation of

RenderTargetAdaptor.copyToTexture

---

destroyGpuRenderTarget()

> destroyGpuRenderTarget(_gpuRenderTarget): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/renderTarget/CanvasRenderTargetAdaptor.d.ts:103

Destroys a GPU render target (no-op for canvas).

Parameters

_gpuRenderTarget

CanvasRenderTarget

Target to destroy.

Returns

void

Advanced

Implementation of

RenderTargetAdaptor.destroyGpuRenderTarget

---

finishRenderPass()

> finishRenderPass(): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/renderTarget/CanvasRenderTargetAdaptor.d.ts:72

Finishes the render pass (no-op for canvas).

Returns

void

Advanced

Implementation of

RenderTargetAdaptor.finishRenderPass

---

init()

> init(renderer, renderTargetSystem): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/renderTarget/CanvasRenderTargetAdaptor.d.ts:37

Initializes the adaptor.

Parameters

renderer

CanvasRenderer

Canvas renderer instance.

renderTargetSystem

RenderTargetSystem<CanvasRenderTarget>

The render target system.

Returns

void

Advanced

Implementation of

RenderTargetAdaptor.init

---

initGpuRenderTarget()

> initGpuRenderTarget(renderTarget): CanvasRenderTarget

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

Creates a GPU render target for canvas.

Parameters

renderTarget

RenderTarget

Render target to initialize.

Returns

CanvasRenderTarget

Advanced

Implementation of

RenderTargetAdaptor.initGpuRenderTarget

---

resizeGpuRenderTarget()

> resizeGpuRenderTarget(renderTarget): void

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

Resizes the backing canvas for a render target.

Parameters

renderTarget

RenderTarget

Render target to resize.

Returns

void

Advanced

Implementation of

RenderTargetAdaptor.resizeGpuRenderTarget

---

startRenderPass()

> startRenderPass(renderTarget, clear, clearColor?, viewport?): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/canvas/renderTarget/CanvasRenderTargetAdaptor.d.ts:58

Starts a render pass on the canvas target.

Parameters

renderTarget

RenderTarget

Target to render to.

clear

CLEAR_OR_BOOL

Clear mode.

clearColor?

number[]

Optional clear color.

viewport?

Rectangle

Optional viewport.

Returns

void

Advanced

Implementation of

RenderTargetAdaptor.startRenderPass