VTK  9.2.5
vtkShaderProgram.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4
5 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
6 All rights reserved.
7 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
8
9 This software is distributed WITHOUT ANY WARRANTY; without even
10 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
11 PURPOSE. See the above copyright notice for more information.
12
13=========================================================================*/
24#ifndef vtkShaderProgram_h
25#define vtkShaderProgram_h
26
27#include "vtkObject.h"
28#include "vtkRenderingOpenGL2Module.h" // for export macro
29
30#include <map> // For member variables.
31#include <string> // For member variables.
32
33class vtkMatrix3x3;
34class vtkMatrix4x4;
36class vtkShader;
37class VertexArrayObject;
38class vtkWindow;
39
47class VTKRENDERINGOPENGL2_EXPORT vtkShaderProgram : public vtkObject
48{
49public:
52 void PrintSelf(ostream& os, vtkIndent indent) override;
53
55
58 vtkGetObjectMacro(VertexShader, vtkShader);
61
63
66 vtkGetObjectMacro(FragmentShader, vtkShader);
69
71
74 vtkGetObjectMacro(GeometryShader, vtkShader);
77
79
82 vtkGetObjectMacro(TransformFeedback, vtkTransformFeedback);
85
87
90 vtkGetMacro(Compiled, bool);
91 vtkSetMacro(Compiled, bool);
92 vtkBooleanMacro(Compiled, bool);
94
98 std::string GetMD5Hash() const { return this->MD5Hash; }
99 void SetMD5Hash(const std::string& hash) { this->MD5Hash = hash; }
100
103 {
114 NoNormalize
115 };
116
121 bool isBound() const { return this->Bound; }
122
127
129 int GetHandle() const { return Handle; }
130
132 std::string GetError() const { return Error; }
133
138 bool EnableAttributeArray(const char* name);
139
144 bool DisableAttributeArray(const char* name);
145
161 bool UseAttributeArray(const char* name, int offset, size_t stride, int elementType,
162 int elementTupleSize, NormalizeOption normalize);
163
181 template <class T>
183 const char* name, const T& array, int tupleSize, NormalizeOption normalize);
184
186 bool SetUniformi(const char* name, int v);
187 bool SetUniformf(const char* name, float v);
188 bool SetUniform2i(const char* name, const int v[2]);
189 bool SetUniform2f(const char* name, const float v[2]);
190 bool SetUniform3f(const char* name, const float v[3]);
191 bool SetUniform3f(const char* name, const double v[3]);
192 bool SetUniform4f(const char* name, const float v[4]);
193 bool SetUniform3uc(const char* name, const unsigned char v[3]); // maybe remove
194 bool SetUniform4uc(const char* name, const unsigned char v[4]); // maybe remove
195 bool SetUniformMatrix(const char* name, vtkMatrix3x3* v);
196 bool SetUniformMatrix(const char* name, vtkMatrix4x4* v);
197 bool SetUniformMatrix3x3(const char* name, float* v);
198 bool SetUniformMatrix4x4(const char* name, float* v);
199
201 bool SetUniform1iv(const char* name, const int count, const int* f);
202 bool SetUniform1fv(const char* name, const int count, const float* f);
203 bool SetUniform2fv(const char* name, const int count, const float* f);
204 bool SetUniform2fv(const char* name, const int count, const float (*f)[2]);
205 bool SetUniform3fv(const char* name, const int count, const float* f);
206 bool SetUniform3fv(const char* name, const int count, const float (*f)[3]);
207 bool SetUniform4fv(const char* name, const int count, const float* f);
208 bool SetUniform4fv(const char* name, const int count, const float (*f)[4]);
209 bool SetUniformMatrix4x4v(const char* name, const int count, float* v);
210
211 // How many outputs does this program produce
212 // only valid for OpenGL 3.2 or later
213 vtkSetMacro(NumberOfOutputs, unsigned int);
214
226 static bool Substitute(
227 std::string& source, const std::string& search, const std::string& replace, bool all = true);
228
240 static bool Substitute(
241 vtkShader* shader, const std::string& search, const std::string& replace, bool all = true);
242
248 bool IsUniformUsed(const char*);
249
254 bool IsAttributeUsed(const char* name);
255
256 // maps of std::string are super slow when calling find
257 // with a string literal or const char * as find
258 // forces construction/copy/destruction of a
259 // std::string copy of the const char *
260 // In spite of the doubters this can really be a
261 // huge CPU hog.
262 struct cmp_str
263 {
264 bool operator()(const char* a, const char* b) const { return strcmp(a, b) < 0; }
265 };
266
268
285 vtkSetFilePathMacro(FileNamePrefixForDebugging);
286 vtkGetFilePathMacro(FileNamePrefixForDebugging);
288
290
296 {
299 UserGroup, // always will be last
300 };
304
305 // returns the location for a uniform or attribute in
306 // this program. Is cached for performance.
307 int FindUniform(const char* name);
308 int FindAttributeArray(const char* name);
309
310protected:
313
314 /***************************************************************
315 * The following functions are only for use by the shader cache
316 * which is why they are protected and that class is a friend
317 * you need to use the shader cache to compile/link/bind your shader
318 * do not try to do it yourself as it will screw up the cache
319 ***************************************************************/
321
328 bool AttachShader(const vtkShader* shader);
329
335 bool DetachShader(const vtkShader* shader);
336
340 virtual int CompileShader();
341
347 bool Link();
348
353 bool Bind();
354
356 void Release();
357
358 /************* end **************************************/
359
364
365 // hash of the shader program
366 std::string MD5Hash;
367
369 const char* name, void* buffer, int type, int tupleSize, NormalizeOption normalize);
374
375 bool Linked;
376 bool Bound;
378
379 // for glsl 1.5 or later, how many outputs
380 // does this shader create
381 // they will be bound in order to
382 // fragOutput0 fragOutput1 etc...
383 unsigned int NumberOfOutputs;
384
385 std::string Error;
386
387 // since we are using const char * arrays we have to
388 // free our memory :-)
389 void ClearMaps();
390 std::map<const char*, int, cmp_str> AttributeLocs;
391 std::map<const char*, int, cmp_str> UniformLocs;
392
393 std::map<int, vtkMTimeType> UniformGroupMTimes;
394
395 friend class VertexArrayObject;
396
397private:
398 vtkShaderProgram(const vtkShaderProgram&) = delete;
399 void operator=(const vtkShaderProgram&) = delete;
400
401 char* FileNamePrefixForDebugging;
402};
403
404#endif
a simple class to control print indentation
Definition: vtkIndent.h:40
represent and manipulate 3x3 transformation matrices
Definition: vtkMatrix3x3.h:37
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:42
abstract base class for most VTK objects
Definition: vtkObject.h:63
manage Shader Programs within a context
The ShaderProgram uses one or more Shader objects.
bool Link()
Attempt to link the shader program.
bool SetUniform4fv(const char *name, const int count, const float *f)
void Release()
Releases the shader program from the current context.
bool SetUniform4fv(const char *name, const int count, const float(*f)[4])
vtkShader * FragmentShader
~vtkShaderProgram() override
void SetFragmentShader(vtkShader *)
Get the fragment shader for this program.
std::string GetError() const
Get the error message (empty if none) for the shader program.
bool SetUniform2fv(const char *name, const int count, const float *f)
bool IsUniformUsed(const char *)
methods to inquire as to what uniforms/attributes are used by this shader.
bool Bind()
Bind the program in order to use it.
bool SetAttributeArray(const char *name, const T &array, int tupleSize, NormalizeOption normalize)
Upload the supplied array of tightly packed values to the named attribute.
vtkSetFilePathMacro(FileNamePrefixForDebugging)
When developing shaders, it's often convenient to tweak the shader and re-render incrementally.
void SetVertexShader(vtkShader *)
Get the vertex shader for this program.
bool SetUniform2i(const char *name, const int v[2])
vtkTransformFeedback * TransformFeedback
bool SetUniform3f(const char *name, const float v[3])
int FindAttributeArray(const char *name)
std::string GetMD5Hash() const
Set/Get the md5 hash of this program.
bool SetUniform4uc(const char *name, const unsigned char v[4])
std::map< const char *, int, cmp_str > UniformLocs
bool SetUniform4f(const char *name, const float v[4])
bool SetUniform2f(const char *name, const float v[2])
bool SetUniformMatrix4x4v(const char *name, const int count, float *v)
bool SetUniformMatrix(const char *name, vtkMatrix4x4 *v)
UniformGroups
Set/Get times that can be used to track when a set of uniforms was last updated.
bool SetUniform1iv(const char *name, const int count, const int *f)
Set the name uniform array to f with count elements.
bool AttachShader(const vtkShader *shader)
Attach the supplied shader to this program.
int FindUniform(const char *name)
bool SetAttributeArrayInternal(const char *name, void *buffer, int type, int tupleSize, NormalizeOption normalize)
static vtkShaderProgram * New()
int GetHandle() const
Get the handle of the shader program.
NormalizeOption
Options for attribute normalization.
@ Normalize
The values range across the limits of the numeric type.
bool SetUniform3f(const char *name, const double v[3])
void SetMD5Hash(const std::string &hash)
bool EnableAttributeArray(const char *name)
Enable the named attribute array.
vtkShader * VertexShader
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
bool isBound() const
Check if the program is currently bound, or not.
void SetUniformGroupUpdateTime(int, vtkMTimeType tm)
Set/Get times that can be used to track when a set of uniforms was last updated.
bool SetUniformMatrix(const char *name, vtkMatrix3x3 *v)
std::map< const char *, int, cmp_str > AttributeLocs
bool DetachShader(const vtkShader *shader)
Detach the supplied shader from this program.
bool SetUniform3fv(const char *name, const int count, const float *f)
bool SetUniformf(const char *name, float v)
bool SetUniformMatrix4x4(const char *name, float *v)
bool SetUniform2fv(const char *name, const int count, const float(*f)[2])
vtkShader * GeometryShader
bool SetUniformMatrix3x3(const char *name, float *v)
bool DisableAttributeArray(const char *name)
Disable the named attribute array.
bool SetUniform3uc(const char *name, const unsigned char v[3])
bool IsAttributeUsed(const char *name)
Return true if the compiled and linked shader has an attribute matching name.
bool UseAttributeArray(const char *name, int offset, size_t stride, int elementType, int elementTupleSize, NormalizeOption normalize)
Use the named attribute array with the bound BufferObject.
bool SetUniformi(const char *name, int v)
Set the name uniform value to int v.
unsigned int NumberOfOutputs
bool SetUniform1fv(const char *name, const int count, const float *f)
vtkMTimeType GetUniformGroupUpdateTime(int)
Set/Get times that can be used to track when a set of uniforms was last updated.
vtkGetFilePathMacro(FileNamePrefixForDebugging)
When developing shaders, it's often convenient to tweak the shader and re-render incrementally.
void SetGeometryShader(vtkShader *)
Get the geometry shader for this program.
std::map< int, vtkMTimeType > UniformGroupMTimes
bool SetUniform3fv(const char *name, const int count, const float(*f)[3])
void ReleaseGraphicsResources(vtkWindow *win)
release any graphics resources this class is using.
static bool Substitute(std::string &source, const std::string &search, const std::string &replace, bool all=true)
perform in place string substitutions, indicate if a substitution was done this is useful for buildin...
virtual int CompileShader()
Compile this shader program and attached shaders.
void SetTransformFeedback(vtkTransformFeedback *tfc)
Get/Set a TransformFeedbackCapture object on this shader program.
static bool Substitute(vtkShader *shader, const std::string &search, const std::string &replace, bool all=true)
Perform in-place string substitutions on the shader source string and indicate if one or all substitu...
Vertex or Fragment shader, combined into a ShaderProgram.
Definition: vtkShader.h:38
Manages a TransformFeedback buffer.
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
bool operator()(const char *a, const char *b) const
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287