DtEffect.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2023 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/


#pragma once

#include <string>
#include <vrvGraphics/vrvGraphics.h>
#include <boost/filesystem.hpp>

namespace makVrv
{
   class DT_DLL_VRVGRAPHICS DtEffect
   {
   public:

      struct VertexAttribPtrInfo
      {
         VertexAttribPtrInfo(const void* p, unsigned int t, unsigned int s)
         : pointer(p)
         , type(t)
         , size(s)
         {
         }

         const void* pointer; //Address 
         unsigned int type;   //The OpenGL type of the attribute.
         unsigned int size;   //The OpenGL width of the attribute 1-4

         bool operator==(const VertexAttribPtrInfo& rhs)
         {
            return pointer==rhs.pointer && type==rhs.type && size==rhs.size;
         }
      };

      DtEffect(const std::string& dataPath, const std::string& strDefines);

      virtual ~DtEffect();

      virtual void releaseResources();

      virtual void reloadShaders();

      bool enabled() const;

      //Start using the effect. Returns true if the effect is enabled.
      bool enable();

      //Stop using the effect.
      void disable();

      // Utility function
      static std::string loadShaderSource(const std::string& strFileFolder,
         const std::string& strFileName, const std::string& strDefines);

   protected:
      virtual void initializeShaderSource() = 0;
      virtual void updateUniformLocations() = 0;
      virtual void updateUniforms() = 0;

   protected:

      bool compileShaders();   

      static std::string preprocessShaderIncludes(const std::string& source,
         const boost::filesystem::path& filename, int level,
         const std::string& shaderFolderPath);

      static std::string loadShaderFile(const std::string& strFileName);

   protected:

      std::string myName;
      bool myEnabledFlag;
      unsigned int myProgram;
      unsigned int myVertexShader;
      unsigned int myFragmentShader;

      std::string myVertexShaderSource;
      std::string myVertexShaderName;
      std::string myFragmentShaderSource;
      std::string myFragmentShaderName;
      std::string myGeometryShaderSource;

      std::string myDataPath;
      const std::string myDefines;
   };

   class DT_DLL_VRVGRAPHICS DtEffectCreator
   {
   public:

      class CreateParameters
      {
         virtual ~CreateParameters()
         {
         }
      };

      DtEffectCreator();
      virtual ~DtEffectCreator();
      virtual DtEffect* create(const std::string& dataPath, const std::string& strDefines, CreateParameters* params = 0) = 0;
   };

}