Web Inspector: provide way for ShaderPrograms to be enabled/disabled
[WebKit-https.git] / Source / WebInspectorUI / UserInterface / Models / ShaderProgram.js
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 WI.ShaderProgram = class ShaderProgram
27 {
28     constructor(identifier, canvas)
29     {
30         console.assert(identifier);
31         console.assert(canvas instanceof WI.Canvas);
32
33         this._identifier = identifier;
34         this._canvas = canvas;
35         this._uniqueDisplayNumber = canvas.nextShaderProgramDisplayNumber();
36         this._disabled = false;
37     }
38
39     // Public
40
41     get identifier() { return this._identifier; }
42     get canvas() { return this._canvas; }
43     get disabled() { return this._disabled; }
44
45     get displayName()
46     {
47         return WI.UIString("Program %d").format(this._uniqueDisplayNumber);
48     }
49
50     requestVertexShaderSource(callback)
51     {
52         this._requestShaderSource(CanvasAgent.ShaderType.Vertex, callback);
53     }
54
55     requestFragmentShaderSource(callback)
56     {
57         this._requestShaderSource(CanvasAgent.ShaderType.Fragment, callback);
58     }
59
60     updateVertexShader(source)
61     {
62         this._updateShader(CanvasAgent.ShaderType.Vertex, source);
63     }
64
65     updateFragmentShader(source)
66     {
67         this._updateShader(CanvasAgent.ShaderType.Fragment, source);
68     }
69
70     toggleDisabled(callback)
71     {
72         CanvasAgent.setShaderProgramDisabled(this._identifier, !this._disabled, (error) => {
73             console.assert(!error, error);
74             if (error)
75                 return;
76
77             this._disabled = !this._disabled;
78             callback();
79         });
80     }
81
82     // Private
83
84     _requestShaderSource(shaderType, callback)
85     {
86         CanvasAgent.requestShaderSource(this._identifier, shaderType, (error, content) => {
87             if (error) {
88                 callback(null);
89                 return;
90             }
91
92             callback(content);
93         });
94     }
95
96     _updateShader(shaderType, source)
97     {
98         CanvasAgent.updateShader(this._identifier, shaderType, source, (error) => {
99             console.assert(!error, error);
100         });
101     }
102 };
103
104 WI.ShaderProgram.ShaderType = {
105     Fragment: "shader-type-fragment",
106     Vertex: "shader-type-vertex",
107 };