blob: 061822e3c39d2159eb12aa3d9778affd3cbd65ae [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
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -040057 // idOrElement can be of types:
Kevin Lubick5f1692c2019-01-03 16:20:04 -050058 // - String - in which case it is interpreted as an id of a
59 // canvas element.
60 // - HTMLCanvasElement - in which the provided canvas element will
61 // be used directly.
Kevin Lubick54c1b3d2020-10-07 16:09:22 -040062 // colorSpace - sk_sp<ColorSpace> - one of the supported color spaces:
63 // CanvasKit.ColorSpace.SRGB
64 // CanvasKit.ColorSpace.DISPLAY_P3
65 // CanvasKit.ColorSpace.ADOBE_RGB
Nathaniel Nifonga237f9e2020-07-17 15:20:44 -040066 CanvasKit.MakeWebGLCanvasSurface = function(idOrElement, colorSpace, attrs) {
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -040067 colorSpace = colorSpace || null;
68 var canvas = idOrElement;
Elliot Evans683bbe02020-07-21 17:46:58 -040069 var isHTMLCanvas = typeof HTMLCanvasElement !== 'undefined' && canvas instanceof HTMLCanvasElement;
Florin Malitad7389b02020-08-21 09:47:54 -040070 var isOffscreenCanvas = typeof OffscreenCanvas !== 'undefined' && canvas instanceof OffscreenCanvas;
Elliot Evans683bbe02020-07-21 17:46:58 -040071 if (!isHTMLCanvas && !isOffscreenCanvas) {
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -040072 canvas = document.getElementById(idOrElement);
Kevin Lubick543f3522019-03-08 10:04:28 -050073 if (!canvas) {
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -040074 throw 'Canvas with id ' + idOrElement + ' was not found';
Kevin Lubick5f1692c2019-01-03 16:20:04 -050075 }
Kevin Lubick5f1692c2019-01-03 16:20:04 -050076 }
Kevin Lubick5766e3b2020-04-27 10:22:51 -040077
Nathaniel Nifonga237f9e2020-07-17 15:20:44 -040078 var ctx = this.GetWebGLContext(canvas, attrs);
79 var openGLversion = canvas.GLctxObject.version;
Kevin Lubick5f1692c2019-01-03 16:20:04 -050080
81 if (!ctx || ctx < 0) {
82 throw 'failed to create webgl context: err ' + ctx;
83 }
84
Kevin Lubick543f3522019-03-08 10:04:28 -050085 var grcontext = this.MakeGrContext(ctx);
Kevin Lubickc7755d92019-04-05 13:29:51 -040086
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -040087 // Note that canvas.width/height here is used because it gives the size of the buffer we're
88 // rendering into. This may not be the same size the element is displayed on the page, which
89 // constrolled by css, and available in canvas.clientWidth/height.
90 var surface = this.MakeOnScreenGLSurface(grcontext, canvas.width, canvas.height, colorSpace);
Kevin Lubickb07204a2018-11-20 14:07:42 -050091 if (!surface) {
Kevin Lubick54c1b3d2020-10-07 16:09:22 -040092 Debug('falling back from GPU implementation to a SW based one');
Kevin Lubick832787a2019-03-14 11:25:57 -040093 // we need to throw away the old canvas (which was locked to
94 // a webGL context) and create a new one so we can
95 var newCanvas = canvas.cloneNode(true);
96 var parent = canvas.parentNode;
97 parent.replaceChild(newCanvas, canvas);
98 // add a class so the user can detect that it was replaced.
99 newCanvas.classList.add('ck-replaced');
100
101 return CanvasKit.MakeSWCanvasSurface(newCanvas);
Kevin Lubickb07204a2018-11-20 14:07:42 -0500102 }
Kevin Lubick359a7e32019-03-19 09:34:37 -0400103 surface._context = ctx;
Kevin Lubickcd544662019-03-22 15:41:36 -0400104 surface.grContext = grcontext;
Nathaniel Nifonga237f9e2020-07-17 15:20:44 -0400105 surface.openGLversion = openGLversion;
Kevin Lubickb07204a2018-11-20 14:07:42 -0500106 return surface;
Kevin Lubick5b90b842018-10-17 07:57:18 -0400107 };
Kevin Lubickb07204a2018-11-20 14:07:42 -0500108 // Default to trying WebGL first.
109 CanvasKit.MakeCanvasSurface = CanvasKit.MakeWebGLCanvasSurface;
Kevin Lubick5b90b842018-10-17 07:57:18 -0400110 });
111}(Module)); // When this file is loaded in, the high level object is "Module";