vtkOpenGLShaderComputation.h

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkOpenGLShaderComputation.h,v $

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
// .NAME vtkOpenGLShaderComputation - OpenGL actor
// .SECTION Description
// vtkOpenGLShaderComputation is a way to perform GPU computations on vtk data.
// vtkOpenGLShaderComputation interfaces to the OpenGL rendering library.

#ifndef __vtkOpenGLShaderComputation_h
#define __vtkOpenGLShaderComputation_h

// VTK includes
#include "vtkAddon.h"
#include "vtkImageData.h"
#include "vtkRenderWindow.h"
#include "vtkVariant.h"

// STD includes
#include <map>

class VTK_ADDON_EXPORT vtkOpenGLShaderComputation : public vtkObject
{
protected:

public:
  static vtkOpenGLShaderComputation *New();
  vtkTypeMacro(vtkOpenGLShaderComputation,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  /* Explicitly deleted functions belong in the public interface */
  vtkOpenGLShaderComputation(const vtkOpenGLShaderComputation&) = delete;
  void operator=(const vtkOpenGLShaderComputation&) = delete;

  // Description:
  // Loads the required extensions
  void Initialize(vtkRenderWindow *renderWindow);

  // Description:
  // Checks the framebuffer and prints error if bad.
  // Return true if framebuffer is complete.
  bool FramebufferComplete();

  // Description:
  // Make this the target for OpenGL operations
  void MakeCurrent();

  // Description:
  // Rebuild the shader program if needed
  bool UpdateProgram();

  // Description:
  // Manage the OpenGL offscreen rendering framebuffer for computing
  // Select this mode to render into a buffer that matches the ResultImageData
  // and can be read back with ReadResult.  Otherwise use
  // vtkOpenGLTextureImage::AttachAsDrawTarget to set a texture
  // as the draw target.
  bool AcquireResultRenderbuffer();
  void ReleaseResultRenderbuffer();

  // Description:
  // Perform the actual computation
  // Updates the program if needed and then
  // renders to the current framebuffer configuration
  // Slice will be passed as a uniform float
  void Compute(float slice=0.);

  // Description:
  // Add a uniform value TODO: support types other than float
  void SetUniform(std::string name, float uniform);

  // Description:
  // Copy the framebuffer pixels into the result image
  void ReadResult();

  // Description:
  // The strings defining the shaders
  vtkGetStringMacro(VertexShaderSource);
  vtkSetStringMacro(VertexShaderSource);
  vtkGetStringMacro(FragmentShaderSource);
  vtkSetStringMacro(FragmentShaderSource);

  // Description:
  // The results of the computation.
  // Must be set with the desired dimensions before calling Compute.
  vtkGetObjectMacro(ResultImageData, vtkImageData);
  vtkSetObjectMacro(ResultImageData, vtkImageData);

  // Description:
  // Used internally to manage OpenGL context and extensions
  vtkGetObjectMacro(RenderWindow, vtkRenderWindow);
  vtkSetObjectMacro(RenderWindow, vtkRenderWindow);

  // Description:
  // Has the context been set up with a render window?
  vtkGetMacro(Initialized, bool);

  // Description:
  // Has there been an error since the class was created.
  // After an error, generally the cleanest thing to do is delete the class,
  // and create a new instance.
  vtkGetMacro(ErrorOccurred, bool);

protected:
  vtkOpenGLShaderComputation();
  ~vtkOpenGLShaderComputation() override;

private:

  bool Initialized;
  bool ErrorOccurred;
  char *VertexShaderSource;
  char *FragmentShaderSource;
  vtkImageData *ResultImageData;

  vtkTypeUInt32 ProgramObject; // vtkTypeUInt32 same as GLuint: https://www.opengl.org/wiki/OpenGL_Type
  unsigned long ProgramObjectMTime;
  vtkTypeUInt32 FramebufferID;
  vtkTypeUInt32 ColorRenderbufferID;
  vtkTypeUInt32 DepthRenderbufferID;

  vtkRenderWindow *RenderWindow;

  std::map<std::string, vtkVariant> Uniforms;
};

#endif