VTK
vtkOpenGLShaderCache.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkOpenGLTexture.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
22 #ifndef vtkOpenGLShaderCache_h
23 #define vtkOpenGLShaderCache_h
24 
25 #include "vtkRenderingOpenGL2Module.h" // For export macro
26 #include "vtkObject.h"
27 #include "vtkShader.h" // for vtkShader::Type
28 #include <map> // for methods
29 
31 class vtkShaderProgram;
32 class vtkWindow;
34 
35 class VTKRENDERINGOPENGL2_EXPORT vtkOpenGLShaderCache : public vtkObject
36 {
37 public:
40  void PrintSelf(ostream& os, vtkIndent indent) override;
41 
42  // make sure the specified shaders are compiled, linked, and bound
44  const char *vertexCode,
45  const char *fragmentCode,
46  const char *geometryCode,
47  vtkTransformFeedback *cap = nullptr);
48 
49  // make sure the specified shaders are compiled, linked, and bound
50  // will increment the reference count on the shaders if it
51  // needs to keep them around
53  std::map<vtkShader::Type,vtkShader *> shaders,
54  vtkTransformFeedback *cap = nullptr);
55 
56  // make sure the specified shaders are compiled, linked, and bound
58  vtkShaderProgram *shader, vtkTransformFeedback *cap = nullptr);
59 
66 
70  virtual void ReleaseGraphicsResources(vtkWindow *win);
71 
76  virtual void ClearLastShaderBound() { this->LastShaderBound = nullptr; }
77  vtkGetObjectMacro(LastShaderBound, vtkShaderProgram);
78 
79 protected:
82 
83  // perform System and Output replacements in place. Returns
84  // the number of outputs
85  virtual unsigned int ReplaceShaderValues(
86  std::string &VSSource,
87  std::string &FSSource,
88  std::string &GSSource);
89 
90  virtual vtkShaderProgram* GetShaderProgram(const char *vertexCode,
91  const char *fragmentCode,
92  const char *geometryCode);
94  std::map<vtkShader::Type,vtkShader *> shaders);
95  virtual int BindShader(vtkShaderProgram* shader);
96 
97  class Private;
98  Private *Internal;
100 
103 
104 private:
106  void operator=(const vtkOpenGLShaderCache&) = delete;
107 
108 };
109 
110 #endif
vtkOpenGLShaderCache::ReadyShaderProgram
virtual vtkShaderProgram * ReadyShaderProgram(std::map< vtkShader::Type, vtkShader * > shaders, vtkTransformFeedback *cap=nullptr)
vtkShader.h
vtkOpenGLShaderCache::ReplaceShaderValues
virtual unsigned int ReplaceShaderValues(std::string &VSSource, std::string &FSSource, std::string &GSSource)
vtkOpenGLShaderCache::ReleaseGraphicsResources
virtual void ReleaseGraphicsResources(vtkWindow *win)
Free up any resources being used by the provided shader.
vtkOpenGLShaderCache::OpenGLMajorVersion
int OpenGLMajorVersion
Definition: vtkOpenGLShaderCache.h:101
vtkOpenGLShaderCache::GetShaderProgram
virtual vtkShaderProgram * GetShaderProgram(const char *vertexCode, const char *fragmentCode, const char *geometryCode)
vtkOpenGLShaderCache::LastShaderBound
vtkShaderProgram * LastShaderBound
Definition: vtkOpenGLShaderCache.h:99
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkOpenGLShaderCache::GetShaderProgram
virtual vtkShaderProgram * GetShaderProgram(std::map< vtkShader::Type, vtkShader * > shaders)
vtkOpenGLShaderCache::~vtkOpenGLShaderCache
~vtkOpenGLShaderCache() override
vtkOpenGLShaderCache::Internal
Private * Internal
Definition: vtkOpenGLShaderCache.h:97
vtkOpenGLShaderCache::OpenGLMinorVersion
int OpenGLMinorVersion
Definition: vtkOpenGLShaderCache.h:102
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:38
vtkOpenGLShaderCache::vtkOpenGLShaderCache
vtkOpenGLShaderCache()
vtkOpenGLShaderCache::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkShaderProgram
The ShaderProgram uses one or more Shader objects.
Definition: vtkShaderProgram.h:48
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkOpenGLShaderCache::ReleaseCurrentShader
void ReleaseCurrentShader()
Release the current shader.
vtkOpenGLShaderCache
manage Shader Programs within a context
Definition: vtkOpenGLShaderCache.h:36
vtkOpenGLShaderCache::ReadyShaderProgram
virtual vtkShaderProgram * ReadyShaderProgram(vtkShaderProgram *shader, vtkTransformFeedback *cap=nullptr)
vtkObject.h
vtkX3D::string
@ string
Definition: vtkX3D.h:490
vtkOpenGLShaderCache::ReadyShaderProgram
virtual vtkShaderProgram * ReadyShaderProgram(const char *vertexCode, const char *fragmentCode, const char *geometryCode, vtkTransformFeedback *cap=nullptr)
vtkOpenGLShaderCache::BindShader
virtual int BindShader(vtkShaderProgram *shader)
vtkOpenGLShaderCache::New
static vtkOpenGLShaderCache * New()
vtkOpenGLRenderWindow
OpenGL rendering window.
Definition: vtkOpenGLRenderWindow.h:54
vtkOpenGLShaderCache::ClearLastShaderBound
virtual void ClearLastShaderBound()
Get/Clear the last Shader bound, called by shaders as they release their graphics resources.
Definition: vtkOpenGLShaderCache.h:76
vtkTransformFeedback
Manages a TransformFeedback buffer.
Definition: vtkTransformFeedback.h:41