Class: CanvasRenderTarget

PhotoEditorSDK.Engine~ CanvasRenderTarget

A canvas render target that you can render to. Canvas equivalent of PhotoEditorSDK.Engine.WebGLRenderTarget

new CanvasRenderTarget(width, height, pixelRatio, canvas, context)

sdk/core/engine/utils/canvas-render-target.js, line 34

Creates a CanvasRenderTarget

Name Type Description
width Number
height Number
pixelRatio Number
canvas HTMLCanvasElement
context CanvasRenderingContext2D

Methods

clear()

sdk/core/engine/utils/canvas-render-target.js, line 66

Clears this CanvasRenderTarget

dispose()

sdk/core/engine/utils/canvas-render-target.js, line 149

Cleans up this canvas buffer

getBaseTexture(){PhotoEditorSDK.Engine.BaseTexture}

sdk/core/engine/utils/canvas-render-target.js, line 142

Returns the base texture

Returns:
Type Description
PhotoEditorSDK.Engine.BaseTexture

getCanvas(){HTMLCanvasElement}

sdk/core/engine/utils/canvas-render-target.js, line 94

Returns the canvas

Returns:
Type Description
HTMLCanvasElement

getContext(){CanvasRenderingContext2D}

sdk/core/engine/utils/canvas-render-target.js, line 100

Returns the rendering context

Returns:
Type Description
CanvasRenderingContext2D [description]

getDimensions(){PhotoEditorSDK.Math.Vector2}

sdk/core/engine/utils/canvas-render-target.js, line 136

Returns the dimensions

Returns:
Type Description
PhotoEditorSDK.Math.Vector2

getFilterStack(){Array.<Object>}

sdk/core/engine/utils/canvas-render-target.js, line 106

Returns the filter stack

Returns:
Type Description
Array.<Object>

getHeight(){Number}

sdk/core/engine/utils/canvas-render-target.js, line 118

Returns the height

Returns:
Type Description
Number

getPixelRatio(){Number}

sdk/core/engine/utils/canvas-render-target.js, line 124

Returns the pixel ratio

Returns:
Type Description
Number

getWidth(){Number}

sdk/core/engine/utils/canvas-render-target.js, line 112

Returns the width

Returns:
Type Description
Number

resizeTo(dimensions)

sdk/core/engine/utils/canvas-render-target.js, line 76

Resizes this canvas buffer to the given dimensions

Name Type Description
dimensions PhotoEditorSDK.Math.Vector2

setPixelRatio(pixelRatio)

sdk/core/engine/utils/canvas-render-target.js, line 130

Sets the pixel ratio

Name Type Description
pixelRatio Number