vtkShaderProperty.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkShaderProperty_h
#define vtkShaderProperty_h
 
#include "vtkNew.h" // For iVars
#include "vtkObject.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkUniforms;
 
class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkShaderProperty : public vtkObject
{
public:
  vtkTypeMacro(vtkShaderProperty, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkShaderProperty* New();

  void DeepCopy(vtkShaderProperty* p);

  vtkMTimeType GetShaderMTime();


  bool HasVertexShaderCode();
  bool HasFragmentShaderCode();
  bool HasGeometryShaderCode();
  bool HasTessControlShaderCode();
  bool HasTessEvalShaderCode();
  vtkSetStringMacro(VertexShaderCode);
  vtkGetStringMacro(VertexShaderCode);
  vtkSetStringMacro(FragmentShaderCode);
  vtkGetStringMacro(FragmentShaderCode);
  vtkSetStringMacro(GeometryShaderCode);
  vtkGetStringMacro(GeometryShaderCode);
  vtkSetStringMacro(TessControlShaderCode);
  vtkGetStringMacro(TessControlShaderCode);
  vtkSetStringMacro(TessEvaluationShaderCode);
  vtkGetStringMacro(TessEvaluationShaderCode);


  vtkGetObjectMacro(FragmentCustomUniforms, vtkUniforms);
  vtkGetObjectMacro(VertexCustomUniforms, vtkUniforms);
  vtkGetObjectMacro(GeometryCustomUniforms, vtkUniforms);
  vtkGetObjectMacro(TessControlCustomUniforms, vtkUniforms);
  vtkGetObjectMacro(TessEvaluationCustomUniforms, vtkUniforms);


  virtual void AddVertexShaderReplacement(const std::string& originalValue,
    bool replaceFirst, // do this replacement before the default
    const std::string& replacementValue, bool replaceAll) = 0;
  virtual void AddFragmentShaderReplacement(const std::string& originalValue,
    bool replaceFirst, // do this replacement before the default
    const std::string& replacementValue, bool replaceAll) = 0;
  virtual void AddGeometryShaderReplacement(const std::string& originalValue,
    bool replaceFirst, // do this replacement before the default
    const std::string& replacementValue, bool replaceAll) = 0;
  virtual void AddTessControlShaderReplacement(const std::string& originalValue,
    bool replaceFirst, // do this replacement before the default
    const std::string& replacementValue, bool replaceAll) = 0;
  virtual void AddTessEvaluationShaderReplacement(const std::string& originalValue,
    bool replaceFirst, // do this replacement before the default
    const std::string& replacementValue, bool replaceAll) = 0;
  virtual int GetNumberOfShaderReplacements() = 0;
  virtual std::string GetNthShaderReplacementTypeAsString(vtkIdType index) = 0;
  virtual void GetNthShaderReplacement(vtkIdType index, std::string& name, bool& replaceFirst,
    std::string& replacementValue, bool& replaceAll) = 0;
  virtual void ClearVertexShaderReplacement(
    const std::string& originalValue, bool replaceFirst) = 0;
  virtual void ClearFragmentShaderReplacement(
    const std::string& originalValue, bool replaceFirst) = 0;
  virtual void ClearGeometryShaderReplacement(
    const std::string& originalValue, bool replaceFirst) = 0;
  virtual void ClearTessControlShaderReplacement(
    const std::string& originalValue, bool replaceFirst) = 0;
  virtual void ClearTessEvaluationShaderReplacement(
    const std::string& originalValue, bool replaceFirst) = 0;
  virtual void ClearAllVertexShaderReplacements() = 0;
  virtual void ClearAllFragmentShaderReplacements() = 0;
  virtual void ClearAllGeometryShaderReplacements() = 0;
  virtual void ClearAllTessControlShaderReplacements() = 0;
  virtual void ClearAllTessEvalShaderReplacements() = 0;
  virtual void ClearAllShaderReplacements() = 0;
 
protected:
  vtkShaderProperty();
  ~vtkShaderProperty() override;
 
  char* VertexShaderCode;
  char* FragmentShaderCode;
  char* GeometryShaderCode;
  char* TessControlShaderCode;
  char* TessEvaluationShaderCode;
 
  vtkNew<vtkUniforms> FragmentCustomUniforms;
  vtkNew<vtkUniforms> VertexCustomUniforms;
  vtkNew<vtkUniforms> GeometryCustomUniforms;
  vtkNew<vtkUniforms> TessControlCustomUniforms;
  vtkNew<vtkUniforms> TessEvaluationCustomUniforms;
 
private:
  vtkShaderProperty(const vtkShaderProperty&) = delete;
  void operator=(const vtkShaderProperty&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif