Class: BaseRenderer

PhotoEditorSDK .Engine~ BaseRenderer

The base class for all renderers

new BaseRenderer(width, height, options)

sdk/core/engine/renderers/base-renderer.js, line 34

Create a BaseRenderer instance

Name Type Description

width Number

height Number

options

Object

= {}

Name	Type	Default	Description
`pixelRatio`	Number	1	optional
`clearColor`	PhotoEditorSDK.Color	PhotoEditorSDK.Color.TRANSPARENT	optional
`debug`	Boolean	false	optional

Methods

staticPhotoEditorSDK.Engine.BaseRenderer.isSupported(){Boolean} sdk/core/engine/renderers/base-renderer.js, line 209

Checks if this renderer is supported on the current device and browser

Returns:

Type	Description
Boolean

abstractdispose() sdk/core/engine/renderers/base-renderer.js, line 224

Disposes this Renderer

getCanvas(){HTMLCanvasElement} sdk/core/engine/renderers/base-renderer.js, line 76

Returns the current canvas

Returns:

Type	Description
HTMLCanvasElement

getContext(){RenderingContext} sdk/core/engine/renderers/base-renderer.js, line 150

Returns the current rendering context

Returns:

Type	Description
RenderingContext

getDimensions(){PhotoEditorSDK.Math.Vector2} sdk/core/engine/renderers/base-renderer.js, line 168

Returns the current dimensions

Returns:

Type	Description
PhotoEditorSDK.Math.Vector2

getFilterManager(){PhotoEditorSDK.Engine.FilterManager} sdk/core/engine/renderers/base-renderer.js, line 197

Returns the current filter manager

Returns:

Type	Description
PhotoEditorSDK.Engine.FilterManager

getHeight(){Number} sdk/core/engine/renderers/base-renderer.js, line 162

Returns the current height

Returns:

Type	Description
Number

getMaxDimensions(){Number} sdk/core/engine/renderers/base-renderer.js, line 142

Returns the maximum dimensions

Returns:

Type	Description
Number

getMaxTextureSize(){Number} sdk/core/engine/renderers/base-renderer.js, line 191

Returns the maximum texture size

Returns:

Type	Description
Number

getPixelRatio(){Number} sdk/core/engine/renderers/base-renderer.js, line 174

Returns the current pixel ratio

Returns:

Type	Description
Number

getWidth(){Number} sdk/core/engine/renderers/base-renderer.js, line 156

Returns the current width

Returns:

Type	Description
Number

isOfType(type){Boolean} sdk/core/engine/renderers/base-renderer.js, line 216

Checks if this renderer's type is equal to the given one

Name	Type	Description
`type`	String

Returns:

Type	Description
Boolean

abstractrender(displayObject) sdk/core/engine/renderers/base-renderer.js, line 134

Renders the given displayObject

Name	Type	Description
`displayObject`	PhotoEditorSDK.Engine.DisplayObject

resizeTo(dimensions, resizeCanvas) sdk/core/engine/renderers/base-renderer.js, line 93

Resizes the context and view to the given size

Name	Type	Default	Description
`dimensions`	PhotoEditorSDK.Math.Vector2
`resizeCanvas`	Boolean	true	= true

setCanvas(canvas) sdk/core/engine/renderers/base-renderer.js, line 59

Sets the canvas to the given one

Name	Type	Description
`canvas`	HTMLCanvasElement

setFilterManager(filterManager) sdk/core/engine/renderers/base-renderer.js, line 203

Sets the filter manager

Name	Type	Description
`filterManager`	PhotoEditorSDK.Engine.FilterManager

setPixelRatio(){Number} sdk/core/engine/renderers/base-renderer.js, line 180

Sets the pixel ratio

Returns:

Type	Description
Number