VTK  9.2.6
vtkShaderProperty.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkShaderProperty.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 =========================================================================*/
122 #ifndef vtkShaderProperty_h
123 #define vtkShaderProperty_h
124 
125 #include "vtkNew.h" // For iVars
126 #include "vtkObject.h"
127 #include "vtkRenderingCoreModule.h" // For export macro
128 
129 class vtkUniforms;
130 
131 class VTKRENDERINGCORE_EXPORT vtkShaderProperty : public vtkObject
132 {
133 public:
134  vtkTypeMacro(vtkShaderProperty, vtkObject);
135  void PrintSelf(ostream& os, vtkIndent indent) override;
136 
141 
146 
158 
160 
169  vtkSetStringMacro(VertexShaderCode);
170  vtkGetStringMacro(VertexShaderCode);
171  vtkSetStringMacro(FragmentShaderCode);
172  vtkGetStringMacro(FragmentShaderCode);
173  vtkSetStringMacro(GeometryShaderCode);
174  vtkGetStringMacro(GeometryShaderCode);
176 
178 
182  vtkGetObjectMacro(FragmentCustomUniforms, vtkUniforms);
183  vtkGetObjectMacro(VertexCustomUniforms, vtkUniforms);
184  vtkGetObjectMacro(GeometryCustomUniforms, vtkUniforms);
186 
188 
195  virtual void AddVertexShaderReplacement(const std::string& originalValue,
196  bool replaceFirst, // do this replacement before the default
197  const std::string& replacementValue, bool replaceAll) = 0;
198  virtual void AddFragmentShaderReplacement(const std::string& originalValue,
199  bool replaceFirst, // do this replacement before the default
200  const std::string& replacementValue, bool replaceAll) = 0;
201  virtual void AddGeometryShaderReplacement(const std::string& originalValue,
202  bool replaceFirst, // do this replacement before the default
203  const std::string& replacementValue, bool replaceAll) = 0;
204  virtual int GetNumberOfShaderReplacements() = 0;
206  virtual void GetNthShaderReplacement(vtkIdType index, std::string& name, bool& replaceFirst,
207  std::string& replacementValue, bool& replaceAll) = 0;
209  const std::string& originalValue, bool replaceFirst) = 0;
211  const std::string& originalValue, bool replaceFirst) = 0;
213  const std::string& originalValue, bool replaceFirst) = 0;
217  virtual void ClearAllShaderReplacements() = 0;
219 
220 protected:
222  ~vtkShaderProperty() override;
223 
227 
231 
232 private:
233  vtkShaderProperty(const vtkShaderProperty&) = delete;
234  void operator=(const vtkShaderProperty&) = delete;
235 };
236 
237 #endif
a simple class to control print indentation
Definition: vtkIndent.h:119
abstract base class for most VTK objects
Definition: vtkObject.h:82
represent GPU shader properties
bool HasFragmentShaderCode()
Allow the program to set the shader codes used directly instead of using the built in templates.
void DeepCopy(vtkShaderProperty *p)
Assign one property to another.
virtual int GetNumberOfShaderReplacements()=0
This function enables you to apply your own substitutions to the shader creation process.
~vtkShaderProperty() override
vtkMTimeType GetShaderMTime()
GetShaderMTime returns the last time a modification was made that affected the code of the shader (ei...
virtual void ClearGeometryShaderReplacement(const std::string &originalValue, bool replaceFirst)=0
This function enables you to apply your own substitutions to the shader creation process.
virtual void ClearAllGeometryShaderReplacements()=0
This function enables you to apply your own substitutions to the shader creation process.
virtual void ClearAllFragmentShaderReplacements()=0
This function enables you to apply your own substitutions to the shader creation process.
virtual void ClearAllVertexShaderReplacements()=0
This function enables you to apply your own substitutions to the shader creation process.
virtual void AddVertexShaderReplacement(const std::string &originalValue, bool replaceFirst, const std::string &replacementValue, bool replaceAll)=0
This function enables you to apply your own substitutions to the shader creation process.
bool HasGeometryShaderCode()
Allow the program to set the shader codes used directly instead of using the built in templates.
virtual void AddGeometryShaderReplacement(const std::string &originalValue, bool replaceFirst, const std::string &replacementValue, bool replaceAll)=0
This function enables you to apply your own substitutions to the shader creation process.
vtkNew< vtkUniforms > GeometryCustomUniforms
bool HasVertexShaderCode()
Allow the program to set the shader codes used directly instead of using the built in templates.
static vtkShaderProperty * New()
Construct object with no shader replacements.
virtual void ClearAllShaderReplacements()=0
This function enables you to apply your own substitutions to the shader creation process.
virtual void ClearFragmentShaderReplacement(const std::string &originalValue, bool replaceFirst)=0
This function enables you to apply your own substitutions to the shader creation process.
vtkNew< vtkUniforms > FragmentCustomUniforms
virtual void GetNthShaderReplacement(vtkIdType index, std::string &name, bool &replaceFirst, std::string &replacementValue, bool &replaceAll)=0
This function enables you to apply your own substitutions to the shader creation process.
virtual std::string GetNthShaderReplacementTypeAsString(vtkIdType index)=0
This function enables you to apply your own substitutions to the shader creation process.
virtual void AddFragmentShaderReplacement(const std::string &originalValue, bool replaceFirst, const std::string &replacementValue, bool replaceAll)=0
This function enables you to apply your own substitutions to the shader creation process.
vtkNew< vtkUniforms > VertexCustomUniforms
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void ClearVertexShaderReplacement(const std::string &originalValue, bool replaceFirst)=0
This function enables you to apply your own substitutions to the shader creation process.
helper class to set custom uniform variables in GPU shaders.
Definition: vtkUniforms.h:43
@ name
Definition: vtkX3D.h:225
@ index
Definition: vtkX3D.h:252
@ string
Definition: vtkX3D.h:496
int vtkIdType
Definition: vtkType.h:332
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287