1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
|
# Copyright (c) 2022 Ultimaker B.V.
# Uranium is released under the terms of the LGPLv3 or higher.
import ast
import configparser
from typing import Any, cast, Dict, List, Union, Optional
from PyQt6.QtGui import QVector2D, QVector3D, QVector4D, QMatrix4x4, QColor
from PyQt6.QtOpenGL import QOpenGLShader, QOpenGLShaderProgram
from UM.Logger import Logger
from UM.Math.Vector import Vector
from UM.Math.Matrix import Matrix
from UM.Math.Color import Color
from UM.View.GL.Texture import Texture
class InvalidShaderProgramError(Exception):
"""Raised when an error occurs during loading of the shader file."""
pass
class ShaderProgram:
"""An abstract class for dealing with shader programs.
This class provides an interface an some basic elements for dealing with
shader programs. Shader programs are described in a simple text file
based on the Python configparser module. These files contain the shaders
for the different shader program stages, in addition to defaults that should
be used for uniform values and uniform and attribute bindings.
"""
def __init__(self) -> None:
self._bindings = {} # type: Dict[str, str]
self._attribute_bindings = {} # type: Dict[str, str]
self._shader_program = None # type: Optional[QOpenGLShaderProgram]
self._uniform_indices = {} # type: Dict[str, int]
self._attribute_indices = {} # type: Dict[str, int]
self._uniform_values = {} # type: Dict[int, Union[Vector, Matrix, Color, List[float], List[List[float]], float, int]]
self._bound = False
self._textures = {} # type: Dict[int, Texture]
self._debug_shader = False # Set this to true to enable extra logging concerning shaders
def load(self, file_name: str, version: str = "") -> None:
"""Load a shader program file.
This method loads shaders from a simple text file, using Python's configparser
as parser.
:note When writing shader program files, please note that configparser expects
indented lines for multiline values. Since the shaders are provided as a single
multiline string, make sure to indent them properly.
:param file_name: The shader file to load.
:param version: can be used for a special version of the shader. it will be appended
to the keys [vertex, fragment, geometry] in the shader file
:exception{InvalidShaderProgramError} Raised when the file provided does not contain any valid shaders.
"""
Logger.log("d", "Loading [%s]...", file_name)
vertex_key = "vertex" + version
fragment_key = "fragment" + version
geometry_key = "geometry" + version
# Hashtags should not be ignored, they are part of GLSL.
parser = configparser.ConfigParser(interpolation = None, comment_prefixes = (';', ))
parser.optionxform = lambda option: option # type: ignore
try:
parser.read(file_name, encoding = "UTF-8")
except EnvironmentError:
raise InvalidShaderProgramError("{0} can't be opened for reading.".format(file_name))
except UnicodeDecodeError:
raise InvalidShaderProgramError("{0} contains invalid UTF-8 code. File corrupted?".format(file_name))
except configparser.Error as e:
raise InvalidShaderProgramError("{file_name} has broken config file syntax: {err}".format(file_name = file_name, err = str(e)))
if "shaders" not in parser:
raise InvalidShaderProgramError("{0} is missing section [shaders]".format(file_name))
if vertex_key not in parser["shaders"] or fragment_key not in parser["shaders"]:
raise InvalidShaderProgramError("{0} is missing a shader [{1}, {2}]".format(file_name, vertex_key, fragment_key))
vertex_code = parser["shaders"][vertex_key]
if self._debug_shader:
vertex_code_str = "\n".join(["%4i %s" % (i, s) for i, s in enumerate(vertex_code.split("\n"))])
Logger.log("d", "Vertex shader")
Logger.log("d", vertex_code_str)
fragment_code = parser["shaders"][fragment_key]
if self._debug_shader:
fragment_code_str = "\n".join(["%4i %s" % (i, s) for i, s in enumerate(fragment_code.split("\n"))])
Logger.log("d", "Fragment shader")
Logger.log("d", fragment_code_str)
if not self.setVertexShader(vertex_code):
raise InvalidShaderProgramError(f"Could not set vertex shader from '{file_name}'.")
if not self.setFragmentShader(fragment_code):
raise InvalidShaderProgramError(f"Could not set fragment shader from '{file_name}'.")
# Geometry shader is optional and only since version OpenGL 3.2 or with extension ARB_geometry_shader4
if geometry_key in parser["shaders"]:
code = parser["shaders"][geometry_key]
if self._debug_shader:
code_str = "\n".join(["%4i %s" % (i, s) for i, s in enumerate(code.split("\n"))])
Logger.log("d", "Loading geometry shader... \n")
Logger.log("d", code_str)
if not self.setGeometryShader(code):
raise InvalidShaderProgramError(f"Could not set geometry shader from '{file_name}'.")
self.build()
if "defaults" in parser:
for key, value in parser["defaults"].items():
self.setUniformValue(key, ast.literal_eval(value), cache = True)
if "bindings" in parser:
for key, value in parser["bindings"].items():
self.addBinding(key, value)
if "attributes" in parser:
for key, value in parser["attributes"].items():
self.addAttributeBinding(key, value)
def setVertexShader(self, shader: str) -> bool:
"""Set the vertex shader to use.
:param shader: :type{string} The vertex shader to use.
"""
if not self._shader_program:
self._shader_program = QOpenGLShaderProgram()
if not cast(QOpenGLShaderProgram, self._shader_program).addShaderFromSourceCode(QOpenGLShader.ShaderTypeBit.Vertex, shader):
Logger.log("e", "Vertex shader failed to compile: %s", self._shader_program.log())
return False
return True
def setFragmentShader(self, shader: str) -> bool:
"""Set the fragment shader to use.
:param shader: :type{string} The fragment shader to use.
"""
if not self._shader_program:
self._shader_program = QOpenGLShaderProgram()
if not cast(QOpenGLShaderProgram, self._shader_program).addShaderFromSourceCode(QOpenGLShader.ShaderTypeBit.Fragment, shader):
Logger.log("e", "Fragment shader failed to compile: %s", self._shader_program.log())
return False
return True
def setGeometryShader(self, shader: str) -> bool:
if not self._shader_program:
self._shader_program = QOpenGLShaderProgram()
if not cast(QOpenGLShaderProgram, self._shader_program).addShaderFromSourceCode(QOpenGLShader.ShaderTypeBit.Geometry, shader):
Logger.log("e", "Geometry shader failed to compile: %s", self._shader_program.log())
return False
return True
def build(self) -> None:
"""Build the complete shader program out of the separately provided sources."""
if not self._shader_program:
Logger.log("e", "No shader sources loaded")
return
if not self._shader_program.link():
Logger.log("e", "Shader failed to link: %s", self._shader_program.log())
def setUniformValue(self, name: str, value: Union[Vector, Matrix, Color, List[float], List[List[float]], float, int], **kwargs: Any) -> None:
"""Set a named uniform variable.
Unless otherwise specified as argument, the specified value will be cached so that
it does not matter whether bind() has already been called. Instead, if the shader
is not currently bound, the next call to bind() will update the uniform values.
:param name: The name of the uniform variable.
:param value: The value to set the variable to.
:param kwargs: Keyword arguments.
Possible keywords:
- cache: False when the value should not be cached for later calls to bind().
"""
if not self._shader_program:
return
if name not in self._uniform_indices and self._shader_program is not None:
self._uniform_indices[name] = self._shader_program.uniformLocation(name)
uniform = self._uniform_indices[name]
if uniform == -1:
return
if kwargs.get("cache", True):
self._uniform_values[uniform] = value
if self._bound:
self._setUniformValueDirect(uniform, value)
def setTexture(self, texture_unit: int, texture: Texture) -> None:
"""Set a texture that should be bound to a specified texture unit when this shader is bound.
:param texture_unit: :type{int} The texture unit to bind the texture to.
:param texture: :type{Texture} The texture object to bind to the texture unit.
"""
if texture is None:
if texture_unit in self._textures:
del self._textures[texture_unit]
else:
self._textures[texture_unit] = texture
def enableAttribute(self, name: str, type: str, offset: int, stride: int = 0) -> None:
"""Enable a vertex attribute to be used.
:param name: The name of the attribute to enable.
:param type: The type of the attribute. Should be a python type.
:param offset: The offset into a bound buffer where the data for this attribute starts.
:param stride: The stride of the attribute.
:note If the shader is not bound, this will bind the shader.
"""
if not self._shader_program:
return
self.bind()
if name not in self._attribute_indices:
self._attribute_indices[name] = self._shader_program.attributeLocation(name)
attribute = self._attribute_indices[name]
if attribute == -1:
return
if type == "vector3f":
self._shader_program.setAttributeBuffer(attribute, 0x1406, offset, 3, stride) #GL_FLOAT
elif type == "vector2f":
self._shader_program.setAttributeBuffer(attribute, 0x1406, offset, 2, stride) # GL_FLOAT
elif type == "vector4f":
self._shader_program.setAttributeBuffer(attribute, 0x1406, offset, 4, stride) # GL_FLOAT
elif type == "int":
self._shader_program.setAttributeBuffer(attribute, 0x1404, offset, 1, stride) #GL_INT
elif type == "float":
self._shader_program.setAttributeBuffer(attribute, 0x1406, offset, 1, stride) #GL_FLOAT
self._shader_program.enableAttributeArray(attribute)
def disableAttribute(self, name: str) -> None:
"""Disable a vertex attribute so it is no longer used.
:param name: The name of the attribute to use.
"""
if not self._shader_program:
return
if name not in self._attribute_indices:
return
self._shader_program.disableAttributeArray(self._attribute_indices[name])
def bind(self) -> None:
"""Bind the shader to use it for rendering."""
if self._bound:
return
if not self._shader_program or not self._shader_program.isLinked():
return
self._shader_program.bind()
self._bound = True
for uniform in self._uniform_values:
self._setUniformValueDirect(uniform, self._uniform_values[uniform])
for texture_unit, texture in self._textures.items():
texture.bind(texture_unit)
def release(self) -> None:
"""Release the shader so it will no longer be used for rendering."""
if not self._shader_program or not self._bound:
return
self._shader_program.release()
self._bound = False
for texture_unit, texture in self._textures.items():
texture.release(texture_unit)
def addBinding(self, key: str, value: str) -> None:
"""Add a uniform value binding.
Uniform value bindings are used to provide an abstraction between uniforms as set
from code and uniforms as used from shaders. Each binding specifies a uniform name
as key that should be mapped to a string that can be used to look up the value of
the uniform.
:param key: The name of the uniform to bind.
:param value: The string used to look up values for this uniform.
"""
self._bindings[value] = key
def removeBinding(self, key: str) -> None:
"""Remove a uniform value binding.
:param key: The uniform to remove.
"""
if key not in self._bindings:
return
del self._bindings[key]
def updateBindings(self, **kwargs) -> None:
"""Update the values of bindings.
:param kwargs: Keyword arguments.
Each key should correspond to a binding name, with the
value being the value of the uniform.
:note By default, these values are not cached as they are expected to be continuously
updated.
"""
for key, value in kwargs.items():
if key in self._bindings and value is not None:
self.setUniformValue(self._bindings[key], value, cache = False)
def addAttributeBinding(self, key: str, value: str) -> None:
"""Add an attribute binding.
Attribute bindings are similar to uniform value bindings, except they specify what
what attribute name binds to which attribute in the shader.
TODO: Actually use these bindings. However, that kind of depends on a more freeform
MeshData object as freeform bindings are rather useless when we only have 5 supported
attributes.
:param key: The identifier used in the shader for the attribute.
:param value: The name to bind to this attribute.
"""
self._attribute_bindings[key] = value
def removeAttributeBinding(self, key: str) -> None:
"""Remove an attribute binding.
:param key: The name of the attribute binding to remove.
"""
if key not in self._attribute_bindings:
return
del self._attribute_bindings[key]
def _matrixToQMatrix4x4(self, m):
return QMatrix4x4(m.getFlatData())
def _setUniformValueDirect(self, uniform: int, value: Union[Vector, Matrix, Color, List[float], List[List[float]], float, int]) -> None:
if type(value) is Matrix:
cast(QOpenGLShaderProgram, self._shader_program).setUniformValue(uniform, self._matrixToQMatrix4x4(
cast(Matrix, value)))
elif type(value) is Vector:
value = cast(Vector, value)
cast(QOpenGLShaderProgram, self._shader_program).setUniformValue(uniform, QVector3D(value.x, value.y, value.z))
elif type(value) is Color:
value = cast(Color, value)
cast(QOpenGLShaderProgram, self._shader_program).setUniformValue(uniform,
QColor(round(value.r * 255), round(value.g * 255), round(value.b * 255), round(value.a * 255)))
elif type(value) is list and type(cast(List[List[float]], value)[0]) is list and len(
cast(List[List[float]], value)[0]) == 4:
value = cast(List[List[float]], value)
cast(QOpenGLShaderProgram, self._shader_program).setUniformValue(uniform,
self._matrixToQMatrix4x4(Matrix(value)))
elif type(value) is list and len(cast(List[float], value)) == 4:
value = cast(List[float], value)
cast(QOpenGLShaderProgram, self._shader_program).setUniformValue(uniform, QVector4D(value[0], value[1], value[2], value[3]))
elif type(value) is list and type(cast(List[List[float]], value)[0]) is list and len(cast(List[List[float]], value)[0]) == 2:
value = cast(List[List[float]], value)
cast(QOpenGLShaderProgram, self._shader_program).setUniformValueArray(uniform, [QVector2D(i[0], i[1]) for i in value])
elif type(value) is list and len(cast(List[float], value)) == 2:
value = cast(List[float], value)
cast(QOpenGLShaderProgram, self._shader_program).setUniformValue(uniform, QVector2D(value[0], value[1]))
elif type(value) is list and len(cast(List[float], value)) == 3:
value = cast(List[float], value)
cast(QOpenGLShaderProgram, self._shader_program).setUniformValue(uniform, QVector3D(value[0], value[1], value[2]))
else:
cast(QOpenGLShaderProgram, self._shader_program).setUniformValue(uniform, cast(Union[float, int], value))
|
