blob: 20b5553fa20b4b4ba13cc5841fdb791169fe9b4f [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 Lubicke70af512020-05-14 14:50:54 -040014 CanvasKit.makeWebGLContextAsCurrent = 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
Kevin Lubick5f1692c2019-01-03 16:20:04 -050032 // This check is from the emscripten version
33 if (contextAttributes['explicitSwapControl']) {
Kevin Lubicke70af512020-05-14 14:50:54 -040034 throw 'explicitSwapControl is not supported';
Kevin Lubick5f1692c2019-01-03 16:20:04 -050035 }
Kevin Lubicke70af512020-05-14 14:50:54 -040036 // Creates a WebGL context and sets it to be the current context.
37 this.createContext(canvas, true, true, contextAttributes);
Kevin Lubick5f1692c2019-01-03 16:20:04 -050038 }
39
Kevin Lubick543f3522019-03-08 10:04:28 -050040 CanvasKit.GetWebGLContext = function(canvas, attrs) {
Kevin Lubicke70af512020-05-14 14:50:54 -040041 this.makeWebGLContextAsCurrent(canvas, attrs);
42 return CanvasKit.currentContext() || 0;
Kevin Lubick543f3522019-03-08 10:04:28 -050043 };
44
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -040045 // idOrElement can be of types:
Kevin Lubick5f1692c2019-01-03 16:20:04 -050046 // - String - in which case it is interpreted as an id of a
47 // canvas element.
48 // - HTMLCanvasElement - in which the provided canvas element will
49 // be used directly.
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -040050 // colorSpace - sk_sp<SkColorSpace> - one of the supported color spaces:
51 // CanvasKit.SkColorSpace.SRGB
52 // CanvasKit.SkColorSpace.DISPLAY_P3
53 // CanvasKit.SkColorSpace.ADOBE_RGB
54 CanvasKit.MakeWebGLCanvasSurface = function(idOrElement, colorSpace) {
55 colorSpace = colorSpace || null;
56 var canvas = idOrElement;
Kevin Lubick543f3522019-03-08 10:04:28 -050057 if (canvas.tagName !== 'CANVAS') {
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -040058 canvas = document.getElementById(idOrElement);
Kevin Lubick543f3522019-03-08 10:04:28 -050059 if (!canvas) {
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -040060 throw 'Canvas with id ' + idOrElement + ' was not found';
Kevin Lubick5f1692c2019-01-03 16:20:04 -050061 }
Kevin Lubick5f1692c2019-01-03 16:20:04 -050062 }
Kevin Lubick5766e3b2020-04-27 10:22:51 -040063
64 // we are ok with all the other defaults.
Kevin Lubicke70af512020-05-14 14:50:54 -040065 var ctx = this.GetWebGLContext(canvas);
Kevin Lubick5f1692c2019-01-03 16:20:04 -050066
67 if (!ctx || ctx < 0) {
68 throw 'failed to create webgl context: err ' + ctx;
69 }
70
Kevin Lubick543f3522019-03-08 10:04:28 -050071 var grcontext = this.MakeGrContext(ctx);
Kevin Lubickc7755d92019-04-05 13:29:51 -040072
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -040073 // Note that canvas.width/height here is used because it gives the size of the buffer we're
74 // rendering into. This may not be the same size the element is displayed on the page, which
75 // constrolled by css, and available in canvas.clientWidth/height.
76 var surface = this.MakeOnScreenGLSurface(grcontext, canvas.width, canvas.height, colorSpace);
Kevin Lubickb07204a2018-11-20 14:07:42 -050077 if (!surface) {
Kevin Lubick6fccc9d2018-11-20 15:55:10 -050078 SkDebug('falling back from GPU implementation to a SW based one');
Kevin Lubick832787a2019-03-14 11:25:57 -040079 // we need to throw away the old canvas (which was locked to
80 // a webGL context) and create a new one so we can
81 var newCanvas = canvas.cloneNode(true);
82 var parent = canvas.parentNode;
83 parent.replaceChild(newCanvas, canvas);
84 // add a class so the user can detect that it was replaced.
85 newCanvas.classList.add('ck-replaced');
86
87 return CanvasKit.MakeSWCanvasSurface(newCanvas);
Kevin Lubickb07204a2018-11-20 14:07:42 -050088 }
Kevin Lubick359a7e32019-03-19 09:34:37 -040089 surface._context = ctx;
Kevin Lubickcd544662019-03-22 15:41:36 -040090 surface.grContext = grcontext;
Kevin Lubickb07204a2018-11-20 14:07:42 -050091 return surface;
Kevin Lubick5b90b842018-10-17 07:57:18 -040092 };
Kevin Lubickb07204a2018-11-20 14:07:42 -050093 // Default to trying WebGL first.
94 CanvasKit.MakeCanvasSurface = CanvasKit.MakeWebGLCanvasSurface;
Kevin Lubick5b90b842018-10-17 07:57:18 -040095 });
96}(Module)); // When this file is loaded in, the high level object is "Module";