blob: 9b522a167d6affed0277e529c4079c8fb5f6f980 [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.
3(function(CanvasKit){
4 CanvasKit._extraInitializations = CanvasKit._extraInitializations || [];
5 CanvasKit._extraInitializations.push(function() {
Kevin Lubick5f1692c2019-01-03 16:20:04 -05006 function get(obj, attr, defaultValue) {
7 if (obj && obj.hasOwnProperty(attr)) {
8 return obj[attr];
Kevin Lubick5b90b842018-10-17 07:57:18 -04009 }
Kevin Lubick5f1692c2019-01-03 16:20:04 -050010 return defaultValue;
11 }
12
Kevin Lubicke70af512020-05-14 14:50:54 -040013 CanvasKit.makeWebGLContextAsCurrent = function(canvas, attrs) {
Kevin Lubick5f1692c2019-01-03 16:20:04 -050014 if (!canvas) {
Kevin Lubicke70af512020-05-14 14:50:54 -040015 throw 'null canvas passed into makeWebGLContext';
Kevin Lubick5f1692c2019-01-03 16:20:04 -050016 }
Kevin Lubicke70af512020-05-14 14:50:54 -040017 var contextAttributes = {
18 'alpha': get(attrs, 'alpha', 1),
19 'depth': get(attrs, 'depth', 1),
20 'stencil': get(attrs, 'stencil', 8),
Chris Dalton38e33df2020-05-21 15:46:16 -060021 'antialias': get(attrs, 'antialias', 0),
Kevin Lubicke70af512020-05-14 14:50:54 -040022 'premultipliedAlpha': get(attrs, 'premultipliedAlpha', 1),
23 'preserveDrawingBuffer': get(attrs, 'preserveDrawingBuffer', 0),
24 'preferLowPowerToHighPerformance': get(attrs, 'preferLowPowerToHighPerformance', 0),
25 'failIfMajorPerformanceCaveat': get(attrs, 'failIfMajorPerformanceCaveat', 0),
26 'enableExtensionsByDefault': get(attrs, 'enableExtensionsByDefault', 1),
27 'explicitSwapControl': get(attrs, 'explicitSwapControl', 0),
28 'renderViaOffscreenBackBuffer': get(attrs, 'renderViaOffscreenBackBuffer', 0),
29 };
30
Kevin Lubick5f1692c2019-01-03 16:20:04 -050031 // This check is from the emscripten version
32 if (contextAttributes['explicitSwapControl']) {
Kevin Lubicke70af512020-05-14 14:50:54 -040033 throw 'explicitSwapControl is not supported';
Kevin Lubick5f1692c2019-01-03 16:20:04 -050034 }
Kevin Lubicke70af512020-05-14 14:50:54 -040035 // Creates a WebGL context and sets it to be the current context.
36 this.createContext(canvas, true, true, contextAttributes);
Kevin Lubick5f1692c2019-01-03 16:20:04 -050037 }
38
Kevin Lubick543f3522019-03-08 10:04:28 -050039 CanvasKit.GetWebGLContext = function(canvas, attrs) {
Kevin Lubicke70af512020-05-14 14:50:54 -040040 this.makeWebGLContextAsCurrent(canvas, attrs);
41 return CanvasKit.currentContext() || 0;
Kevin Lubick543f3522019-03-08 10:04:28 -050042 };
43
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -040044 // idOrElement can be of types:
Kevin Lubick5f1692c2019-01-03 16:20:04 -050045 // - String - in which case it is interpreted as an id of a
46 // canvas element.
47 // - HTMLCanvasElement - in which the provided canvas element will
48 // be used directly.
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -040049 // colorSpace - sk_sp<SkColorSpace> - one of the supported color spaces:
50 // CanvasKit.SkColorSpace.SRGB
51 // CanvasKit.SkColorSpace.DISPLAY_P3
52 // CanvasKit.SkColorSpace.ADOBE_RGB
53 CanvasKit.MakeWebGLCanvasSurface = function(idOrElement, colorSpace) {
54 colorSpace = colorSpace || null;
55 var canvas = idOrElement;
Kevin Lubick543f3522019-03-08 10:04:28 -050056 if (canvas.tagName !== 'CANVAS') {
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -040057 canvas = document.getElementById(idOrElement);
Kevin Lubick543f3522019-03-08 10:04:28 -050058 if (!canvas) {
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -040059 throw 'Canvas with id ' + idOrElement + ' was not found';
Kevin Lubick5f1692c2019-01-03 16:20:04 -050060 }
Kevin Lubick5f1692c2019-01-03 16:20:04 -050061 }
Kevin Lubick5766e3b2020-04-27 10:22:51 -040062
63 // we are ok with all the other defaults.
Kevin Lubicke70af512020-05-14 14:50:54 -040064 var ctx = this.GetWebGLContext(canvas);
Kevin Lubick5f1692c2019-01-03 16:20:04 -050065
66 if (!ctx || ctx < 0) {
67 throw 'failed to create webgl context: err ' + ctx;
68 }
69
Kevin Lubick543f3522019-03-08 10:04:28 -050070 var grcontext = this.MakeGrContext(ctx);
Kevin Lubickc7755d92019-04-05 13:29:51 -040071
Nathaniel Nifongb1ebbb12020-05-26 13:10:20 -040072 // Note that canvas.width/height here is used because it gives the size of the buffer we're
73 // rendering into. This may not be the same size the element is displayed on the page, which
74 // constrolled by css, and available in canvas.clientWidth/height.
75 var surface = this.MakeOnScreenGLSurface(grcontext, canvas.width, canvas.height, colorSpace);
Kevin Lubickb07204a2018-11-20 14:07:42 -050076 if (!surface) {
Kevin Lubick6fccc9d2018-11-20 15:55:10 -050077 SkDebug('falling back from GPU implementation to a SW based one');
Kevin Lubick832787a2019-03-14 11:25:57 -040078 // we need to throw away the old canvas (which was locked to
79 // a webGL context) and create a new one so we can
80 var newCanvas = canvas.cloneNode(true);
81 var parent = canvas.parentNode;
82 parent.replaceChild(newCanvas, canvas);
83 // add a class so the user can detect that it was replaced.
84 newCanvas.classList.add('ck-replaced');
85
86 return CanvasKit.MakeSWCanvasSurface(newCanvas);
Kevin Lubickb07204a2018-11-20 14:07:42 -050087 }
Kevin Lubick359a7e32019-03-19 09:34:37 -040088 surface._context = ctx;
Kevin Lubickcd544662019-03-22 15:41:36 -040089 surface.grContext = grcontext;
Kevin Lubickb07204a2018-11-20 14:07:42 -050090 return surface;
Kevin Lubick5b90b842018-10-17 07:57:18 -040091 };
Kevin Lubickb07204a2018-11-20 14:07:42 -050092 // Default to trying WebGL first.
93 CanvasKit.MakeCanvasSurface = CanvasKit.MakeWebGLCanvasSurface;
Kevin Lubick5b90b842018-10-17 07:57:18 -040094 });
95}(Module)); // When this file is loaded in, the high level object is "Module";