SoGLShaderProgram.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef SO_GLSHADER_PROGRAM_H
#define SO_GLSHADER_PROGRAM_H
 
 
 
#include "SoShaderSystem.h"
#include "Inventor/misc/SoGLShader.h"
#include "Inventor/misc/SoUniformParameterBase.h"
#include <Inventor/SbString.h>
#include <mlGLResources.h>
#include <list>
#include <map>
#include <string>
#include "SoShaderTypes.h"
 
class SoGLShaderObject;
 
class INVENTOR_SHADER_API SoGLShaderProgram : public SoGLShader, public SoUniformParameterBase
{
   typedef SoGLShader inherited;
 
   protected:
 
      ml::GLSLProgram  _programRes;
 
      GLint _geometryInputType;
      GLint _geometryOutputType;
      GLint _geometryVerticesOut;
 
   public:
 
      SoGLShaderProgram();
 
      ~SoGLShaderProgram() override;
 
      void  reset() override;
 
      void          addShaderObject(SoGLShaderObject *shaderObject);
      void          removeShaderObject(SoGLShaderObject *shaderObject);
      void          removeAllShaderObjects();
 
      void          enable();
      void          disable();
 
      void          scheduleLinking();
 
      void          setGeometryInputType(GLint type) {
         if (_geometryInputType != type) { _geometryInputType = type; scheduleLinking(); }
      }
      void          setGeometryOutputType(GLint type) {
         if (_geometryOutputType != type) { _geometryOutputType = type; scheduleLinking(); }
      }
      void          setGeometryVerticesOut(GLint number) {
         if (_geometryVerticesOut != number) { _geometryVerticesOut = number; scheduleLinking(); }
      }
 
      virtual void          updateUniformsFromState(SoState*) {};
      virtual void          preLinkSetup() {};
      virtual void          postLinkSetup() {};
 
      virtual SbBool        isActiveUniform(const SbString &name);
 
      virtual void          clearAssignedTextureUnits() { _assignedTextureUnits = 0; }
 
      int                   getNumAssignedTextureUnits() { return _assignedTextureUnits; }
      void                  setNumAssignedTextureUnits(int num) { _assignedTextureUnits = num; }
 
      int           addTextureSampler(const SbString &name) override;
 
      void          set1f(const SbString &name, const float  value) override;
      void          set2f(const SbString &name, const float *value) override;
      void          set3f(const SbString &name, const float *value) override;
      void          set4f(const SbString &name, const float *value) override;
      void          set2f(const SbString &name, const float value0, const float value1) override;
      void          set3f(const SbString &name, const float value0, const float value1, const float value2) override;
      void          set4f(const SbString &name, const float value0, const float value1, const float value2, const float value3) override;
 
      void          set1fv(const SbString &name, const int num, const float *value) override;
      void          set2fv(const SbString &name, const int num, const float *value) override;
      void          set3fv(const SbString &name, const int num, const float *value) override;
      void          set4fv(const SbString &name, const int num, const float *value) override;
 
      void          set1i(const SbString &name, const int32_t  value) override;
      void          set2i(const SbString &name, const int32_t *value) override;
      void          set2i(const SbString &name, const SbVec2s &value) override;
      void          set3i(const SbString &name, const int32_t *value) override;
      void          set3i(const SbString &name, const SbVec3s &value) override;
      void          set4i(const SbString &name, const int32_t *value) override;
 
      void setMatrix3fv(const SbString & /*name*/, int /*num*/, const float * /*value*/, SbBool /*transpose*/ = FALSE) override;
      void setMatrix4fv(const SbString & /*name*/, int /*num*/, const float * /*value*/, SbBool /*transpose*/ = FALSE) override;
 
      void setName(const SbString& name) { _name = name; }
 
      const SbString& getName() const { return _name; }
 
      int shaderVersion(SoShader::ShaderType type) const;
 
   SoINTERNAL public:
 
      enum LinkageResult {
         LR_FAILURE = 0,
         LR_SUCCESS = 1,
         LR_SKIPPED = 2
      };
 
      ml::GLSLProgram &getProgramResource() {
         return _programRes;
      }
 
      GLuint        getProgramHandle() const {
         return _programRes.getHandle();
      }
 
      bool isValid();
 
      SbBool        isExecutable() const {
         return _isExecutable;
      }
 
      SbBool        shouldLink() const {
         return _shouldLink;
      }
 
      LinkageResult link();
 
      void updateUniformInfo(GLint programHandle);
 
      void setAlwaysReadErrorLog(bool flag) { _alwaysReadErrorLog = flag; }
      bool alwaysReadErrorLog() { return _alwaysReadErrorLog; }
 
      bool hadLinkError() { return _hadError; }
      const SbString& getErrorLog() { return _errorLog; }
 
   protected:
 
      std::list<SoGLShaderObject *> _shaderObjects;
      SbBool                        _shouldLink;
      SbBool                        _isExecutable;
 
      SbString                      _name;
 
      int                           _assignedTextureUnits;
 
      struct UniformInfo {
         GLint  location;
         GLenum type;
         GLint  size;
         UniformInfo() : location(-1), type(GL_INT), size(0) {}
         UniformInfo(GLint _location, GLenum _type, GLint _size) : location(_location), type(_type), size(_size) {}
      };
      std::map<std::string, UniformInfo> _uniformInfo;
 
      GLint getUniform(const SbString &name, GLenum type, int *num = nullptr);
 
      bool         _alwaysReadErrorLog;
      bool         _hadError;
      SbString     _errorLog;
};
 
#endif  // _SO_GL_SHADER_PROGRAM_