vtkGLSLModPixelDebugger.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 vtkGLSLModPixelDebugger_h
#define vtkGLSLModPixelDebugger_h

#include "vtkGLSLModifierBase.h"

#include "vtkOpenGLRenderer.h"         // for ivar
#include "vtkRenderingOpenGL2Module.h" // for export macro
#include "vtkStringToken.h"            // for ivar

VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkInformationObjectBaseKey;
class vtkOpenGLRenderer;

class VTKRENDERINGOPENGL2_EXPORT vtkGLSLModPixelDebugger : public vtkGLSLModifierBase
{
public:
  static vtkGLSLModPixelDebugger* New();
  vtkTypeMacro(vtkGLSLModPixelDebugger, vtkGLSLModifierBase);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetSubstitutionJSONFileName(const std::string& filename)
  {
    this->SubstitutionJSONFileName = filename;
  }

  // vtkGLSLModifierBase virtuals:
  bool ReplaceShaderValues(vtkOpenGLRenderer* renderer, std::string& vertexShader,
    std::string& tessControlShader, std::string& tessEvalShader, std::string& geometryShader,
    std::string& fragmentShader, vtkAbstractMapper* mapper, vtkActor* actor) override;
  bool SetShaderParameters(vtkOpenGLRenderer* renderer, vtkShaderProgram* program,
    vtkAbstractMapper* mapper, vtkActor* actor, vtkOpenGLVertexArrayObject* VAO = nullptr) override;
  bool IsUpToDate(vtkOpenGLRenderer* vtkNotUsed(renderer), vtkAbstractMapper* vtkNotUsed(mapper),
    vtkActor* vtkNotUsed(actor)) override
  {
    return this->HashSubstitutionJSONFileContents() ==
      this->LastSubstitutionJSONFileContentsToken &&
      this->HashGLSLFilesContents() == this->LastGLSLFilesContentsToken;
  }

protected:
  vtkGLSLModPixelDebugger();
  ~vtkGLSLModPixelDebugger() override;

  std::string SubstitutionJSONFileName;

  vtkStringToken LastSubstitutionJSONFileContentsToken; // computed internally
  vtkStringToken LastGLSLFilesContentsToken;            // computed internally

  vtkStringToken HashSubstitutionJSONFileContents();
  vtkStringToken HashGLSLFilesContents();

private:
  vtkGLSLModPixelDebugger(const vtkGLSLModPixelDebugger&) = delete;
  void operator=(const vtkGLSLModPixelDebugger&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif