blob: 0b9eb567ca5a234f8df11983be5073b2c5a6c15c [file] [log] [blame]
Kevin Lubick5b90b842018-10-17 07:57:18 -04001// Adds compile-time JS functions to augment the CanvasKit interface.
2// Specifically, anything that should only be on the GPU version of canvaskit.
Bryce Thomas9331ca02020-05-29 16:51:21 -07003// Functions in this file are supplemented by cpu.js.
Kevin Lubick5b90b842018-10-17 07:57:18 -04004(function(CanvasKit){
5 CanvasKit._extraInitializations = CanvasKit._extraInitializations || [];
6 CanvasKit._extraInitializations.push(function() {
Kevin Lubick5f1692c2019-01-03 16:20:04 -05007 function get(obj, attr, defaultValue) {
8 if (obj && obj.hasOwnProperty(attr)) {
9 return obj[attr];
Kevin Lubick5b90b842018-10-17 07:57:18 -040010 }
Kevin Lubick5f1692c2019-01-03 16:20:04 -050011 return defaultValue;
12 }
13
Kevin Lubick204c3be2020-08-19 14:30:58 -040014 CanvasKit.GetWebGLContext = function(canvas, attrs) {
Kevin Lubick5f1692c2019-01-03 16:20:04 -050015 if (!canvas) {
Kevin Lubicke70af512020-05-14 14:50:54 -040016 throw 'null canvas passed into makeWebGLContext';
Kevin Lubick5f1692c2019-01-03 16:20:04 -050017 }
Kevin Lubicke70af512020-05-14 14:50:54 -040018 var contextAttributes = {
19 'alpha': get(attrs, 'alpha', 1),
20 'depth': get(attrs, 'depth', 1),
21 'stencil': get(attrs, 'stencil', 8),
Chris Dalton38e33df2020-05-21 15:46:16 -060022 'antialias': get(attrs, 'antialias', 0),
Kevin Lubicke70af512020-05-14 14:50:54 -040023 'premultipliedAlpha': get(attrs, 'premultipliedAlpha', 1),
24 'preserveDrawingBuffer': get(attrs, 'preserveDrawingBuffer', 0),
25 'preferLowPowerToHighPerformance': get(attrs, 'preferLowPowerToHighPerformance', 0),
26 'failIfMajorPerformanceCaveat': get(attrs, 'failIfMajorPerformanceCaveat', 0),
27 'enableExtensionsByDefault': get(attrs, 'enableExtensionsByDefault', 1),
28 'explicitSwapControl': get(attrs, 'explicitSwapControl', 0),
29 'renderViaOffscreenBackBuffer': get(attrs, 'renderViaOffscreenBackBuffer', 0),
30 };
31
Nathaniel Nifonga237f9e2020-07-17 15:20:44 -040032 if (attrs && attrs['majorVersion']) {
33 contextAttributes['majorVersion'] = attrs['majorVersion']
Kevin Lubick204c3be2020-08-19 14:30:58 -040034 } else {
35 // Default to WebGL 2 if available and not specified.
36 contextAttributes['majorVersion'] = (typeof WebGL2RenderingContext !== 'undefined') ? 2 : 1;
Nathaniel Nifonga237f9e2020-07-17 15:20:44 -040037 }
38
Kevin Lubick5f1692c2019-01-03 16:20:04 -050039 // This check is from the emscripten version
40 if (contextAttributes['explicitSwapControl']) {
Kevin Lubicke70af512020-05-14 14:50:54 -040041 throw 'explicitSwapControl is not supported';
Kevin Lubick5f1692c2019-01-03 16:20:04 -050042 }
Kevin Lubicke70af512020-05-14 14:50:54 -040043 // Creates a WebGL context and sets it to be the current context.
Kevin Lubick204c3be2020-08-19 14:30:58 -040044 // These functions are defined in emscripten's library_webgl.js
45 var handle = GL.createContext(canvas, contextAttributes);
46 if (!handle) {
47 return 0;
48 }
49 GL.makeContextCurrent(handle);
50 return handle;
Kevin Lubickf7fdf1a2020-12-10 15:21:01 -050051 };
52
53 CanvasKit.deleteContext = function(handle) {
54 GL.deleteContext(handle);
55 };
Kevin Lubick5f1692c2019-01-03 16:20:04 -050056
Kevin Lubick7b6a9282021-06-03 08:02:03 -040057 CanvasKit._setTextureCleanup({
58 "deleteTexture": function(webglHandle, texHandle) {
59 var tex = GL.textures[texHandle];
60 if (tex) {
61 GL.getContext(webglHandle).GLctx.deleteTexture(tex);
62 }
63 GL.textures[texHandle] = null;
64 },
65 });
66
Kevin Lubickf6114042021-08-25 13:13:09 -040067 CanvasKit.MakeGrContext = function(ctx) {
68 // Make sure we are pointing at the right WebGL context.
69 if (!this.setCurrentContext(ctx)) {
70 return null;
71 }
72 var grCtx = this._MakeGrContext();
73 if (!grCtx) {
74 return null;
75 }
76 // This context is an index into the emscripten-provided GL wrapper.
77 grCtx._context = ctx;
78 return grCtx;
79 }
80
81 CanvasKit.MakeOnScreenGLSurface = function(grCtx, w, h, colorspace) {
82 var surface = this._MakeOnScreenGLSurface(grCtx, w, h, colorspace);
83 if (!surface) {
84 return null;
85 }
86 surface._context = grCtx._context;
87 return surface;
88 }
89
90 CanvasKit.MakeRenderTarget = function(grCtx, w, h) {
91 var surface = this._MakeRenderTargetWH(grCtx, w, h);
92 if (!surface) {
93 return null;
94 }
95 surface._context = grCtx._context;
96 return surface;
97 }
98
99 CanvasKit.MakeRenderTarget = function(grCtx, imageInfo) {
100 var surface = this._MakeRenderTargetII(grCtx, imageInfo);
101 if (!surface) {
102 return null;
103 }
104 surface._context = grCtx._context;
105 return surface;
106 }
107
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -0400108 // idOrElement can be of types:
Kevin Lubick5f1692c2019-01-03 16:20:04 -0500109 // - String - in which case it is interpreted as an id of a
110 // canvas element.
111 // - HTMLCanvasElement - in which the provided canvas element will
112 // be used directly.
Kevin Lubick54c1b3d2020-10-07 16:09:22 -0400113 // colorSpace - sk_sp<ColorSpace> - one of the supported color spaces:
114 // CanvasKit.ColorSpace.SRGB
115 // CanvasKit.ColorSpace.DISPLAY_P3
116 // CanvasKit.ColorSpace.ADOBE_RGB
Nathaniel Nifonga237f9e2020-07-17 15:20:44 -0400117 CanvasKit.MakeWebGLCanvasSurface = function(idOrElement, colorSpace, attrs) {
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -0400118 colorSpace = colorSpace || null;
119 var canvas = idOrElement;
Elliot Evans683bbe02020-07-21 17:46:58 -0400120 var isHTMLCanvas = typeof HTMLCanvasElement !== 'undefined' && canvas instanceof HTMLCanvasElement;
Florin Malitad7389b02020-08-21 09:47:54 -0400121 var isOffscreenCanvas = typeof OffscreenCanvas !== 'undefined' && canvas instanceof OffscreenCanvas;
Elliot Evans683bbe02020-07-21 17:46:58 -0400122 if (!isHTMLCanvas && !isOffscreenCanvas) {
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -0400123 canvas = document.getElementById(idOrElement);
Kevin Lubick543f3522019-03-08 10:04:28 -0500124 if (!canvas) {
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -0400125 throw 'Canvas with id ' + idOrElement + ' was not found';
Kevin Lubick5f1692c2019-01-03 16:20:04 -0500126 }
Kevin Lubick5f1692c2019-01-03 16:20:04 -0500127 }
Kevin Lubick5766e3b2020-04-27 10:22:51 -0400128
Nathaniel Nifonga237f9e2020-07-17 15:20:44 -0400129 var ctx = this.GetWebGLContext(canvas, attrs);
Kevin Lubick5f1692c2019-01-03 16:20:04 -0500130 if (!ctx || ctx < 0) {
131 throw 'failed to create webgl context: err ' + ctx;
132 }
133
Kevin Lubick543f3522019-03-08 10:04:28 -0500134 var grcontext = this.MakeGrContext(ctx);
Kevin Lubickc7755d92019-04-05 13:29:51 -0400135
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -0400136 // Note that canvas.width/height here is used because it gives the size of the buffer we're
137 // rendering into. This may not be the same size the element is displayed on the page, which
138 // constrolled by css, and available in canvas.clientWidth/height.
139 var surface = this.MakeOnScreenGLSurface(grcontext, canvas.width, canvas.height, colorSpace);
Kevin Lubickb07204a2018-11-20 14:07:42 -0500140 if (!surface) {
Kevin Lubick54c1b3d2020-10-07 16:09:22 -0400141 Debug('falling back from GPU implementation to a SW based one');
Kevin Lubick832787a2019-03-14 11:25:57 -0400142 // we need to throw away the old canvas (which was locked to
143 // a webGL context) and create a new one so we can
144 var newCanvas = canvas.cloneNode(true);
145 var parent = canvas.parentNode;
146 parent.replaceChild(newCanvas, canvas);
147 // add a class so the user can detect that it was replaced.
148 newCanvas.classList.add('ck-replaced');
149
150 return CanvasKit.MakeSWCanvasSurface(newCanvas);
Kevin Lubickb07204a2018-11-20 14:07:42 -0500151 }
152 return surface;
Kevin Lubick5b90b842018-10-17 07:57:18 -0400153 };
Kevin Lubickb07204a2018-11-20 14:07:42 -0500154 // Default to trying WebGL first.
155 CanvasKit.MakeCanvasSurface = CanvasKit.MakeWebGLCanvasSurface;
Kevin Lubick7b6a9282021-06-03 08:02:03 -0400156
157 CanvasKit.Surface.prototype.makeImageFromTexture = function(tex, info) {
158 if (!info['colorSpace']) {
159 info['colorSpace'] = CanvasKit.ColorSpace.SRGB;
160 }
161 // GL is an emscripten object that holds onto WebGL state. One item in that state is
162 // an array of textures, of which the index is the handle/id.
163 var texHandle = GL.textures.length;
164 if (!texHandle) {
165 // If our texture handle is 0, Skia interprets that as an invalid texture id.
166 // As a special case, we push a null texture there so the first texture has id 1.
167 GL.textures.push(null);
168 texHandle = 1;
169 }
170 GL.textures.push(tex);
171 return this._makeImageFromTexture(GL.currentContext.handle, texHandle, info);
172 };
173
174 CanvasKit.Surface.prototype.makeImageFromTextureSource = function(src, w, h) {
175 // If the user specified a height or width in the image info, we use that. Otherwise,
176 // we try to find the natural media type (for <img> and <video>) and then fall back to
177 // the height and width (to cover <canvas>, ImageBitmap or ImageData).
178 var height = h || src.naturalHeight || src.videoHeight || src.height;
179 var width = w || src.naturalWidth || src.videoWidth || src.width;
Kevin Lubickf6114042021-08-25 13:13:09 -0400180 // We want to be pointing at the context associated with this surface.
181 CanvasKit.setCurrentContext(this._context);
Kevin Lubick7b6a9282021-06-03 08:02:03 -0400182 var glCtx = GL.currentContext.GLctx;
183 var newTex = glCtx.createTexture();
184 glCtx.bindTexture(glCtx.TEXTURE_2D, newTex);
185 if (GL.currentContext.version === 2) {
186 glCtx.texImage2D(glCtx.TEXTURE_2D, 0, glCtx.RGBA, width, height, 0, glCtx.RGBA, glCtx.UNSIGNED_BYTE, src);
187 } else {
188 glCtx.texImage2D(glCtx.TEXTURE_2D, 0, glCtx.RGBA, glCtx.RGBA, glCtx.UNSIGNED_BYTE, src);
189 }
190 glCtx.bindTexture(glCtx.TEXTURE_2D, null);
191 var info = {
192 'height': height,
193 'width': width,
194 'colorType': CanvasKit.ColorType.RGBA_8888,
195 'alphaType': CanvasKit.AlphaType.Unpremul,
196 'colorSpace': CanvasKit.ColorSpace.SRGB,
197 };
198 return this.makeImageFromTexture(newTex, info);
199 };
Kevin Lubickf6114042021-08-25 13:13:09 -0400200
201 CanvasKit.setCurrentContext = function(ctx) {
202 if (!ctx) {
203 return false;
204 }
205 return GL.makeContextCurrent(ctx);
206 };
Kevin Lubick5b90b842018-10-17 07:57:18 -0400207 });
208}(Module)); // When this file is loaded in, the high level object is "Module";