DtHbaoDrawable.h

Go to the documentation of this file.

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

#pragma once


#include <vrvPostProcessor/vrvPostProcessor.h>
#include <vrvPostProcessor/DtPostProcessorDrawable.h>

#include <vrvUtil/DtVirtualBaseClassCreator.h>

#include <vrvMath/DtVector2.h>

#include <vrvUtil/DtSignalConnectionManager.h>

#include <osg/observer_ptr>
#include <osg/GraphicsContext>
#include <osg/Texture>

//NVIDIA's HBAO library https://developer.nvidia.com/shadowworks
#include <GFSDK/GFSDK_SSAO.h>

namespace osg
{
   class Texture2D;
   class State;
}

namespace makVrv
{
   class DtDe;
   class DtGlProgram;
   class DtGlRenderTexture;
   class DtNvidiaHbaoGlObject;

   class DtHbaoDrawable;
   typedef DtVirtualBaseClassCreator<DtHbaoDrawable> DtHbaoDrawableCreator;

   template <>
   inline const char* creatorTypeName<DtHbaoDrawable>(void) { return "DtHbaoDrawableCreator"; }

   struct HbaoParameters
   {
   public:

      int viewWidth = 0;
      int viewHeight = 0;

      float radius = 2.0f; // The AO radius in meters
      float bias = 0.1f; // To hide low-tessellation artifacts // 0.0~0.5
      float exponent = 2.0f; // The final AO output is pow(AO, powerExponent) // 1.0~4.0
      bool blurEnable = true; // To blur the AO with an edge-preserving blur
      int blurRadius = GFSDK_SSAO_BLUR_RADIUS_4; // BLUR_RADIUS_2 or BLUR_RADIUS_4
      float blurSharpness = 4.0f;  // The higher, the more the blur preserves edges // 0.0~16.0                                 
                                                                  
      bool sharpnessProfileEnable = false;                       // To make the blur sharper in the foreground  
      float sharpnessProfileScale = 4.0f;                        // Sharpness scale factor for ViewDepths <= ForegroundViewDepth  
      float sharpnessProfileForegroundViewDepth = 0.0;           // Maximum view depth of the foreground depth range  
      float sharpnessProfileBackgroundViewDepth = 1.0;           // Minimum view depth of the background depth range  

      float smallScaleAo = 1.0f; // Scale factor for the small-scale AO, the greater the darker // 0.0~2.0
      float largeScaleAo = 1.0f; // Scale factor for the large-scale AO, the greater the darker // 0.0~2.0

      bool foregroundAoEnable = false;  // To limit the occlusion scale in the foreground
      float foregroundAoDepth = 0.0f;// View-space depth at which the AO footprint should get clamped
      bool backgroundAoEnable = false;   // To add larger-scale occlusion in the distance
      float backgroundAoDepth = 0.0f;    // View-space depth at which the AO footprint should stop falling off with depth
      
      //Depth storage needs to be 32-bit so that zoomed in views work.
      int depthStorage = GFSDK_SSAO_FP32_VIEW_DEPTHS;               // Quality / performance tradeoff
      int depthClampMode = GFSDK_SSAO_CLAMP_TO_EDGE;             // To hide possible false-occlusion artifacts near screen borders
      bool depthThresholdEnable = false;                     // To return white AO for ViewDepths > MaxViewDepth
      float depthThresholdMaxViewDepth = 0.0f;               // Custom view-depth threshold
      float depthThresholdSharpness = 100.0f;                  // The higher, the sharper are the AO-to-white transitions

   };

   class DT_DLL_VRVPOSTPROCESSOR DtHbaoDrawable : public DtPostProcessorDrawable
   {
   public:
      virtual ~DtHbaoDrawable();

      DtHbaoDrawable() = delete;

      DtHbaoDrawable(const DtHbaoDrawable&) = delete;

      DtHbaoDrawable& operator=(const DtHbaoDrawable&) = delete;

   protected:
      DtHbaoDrawable(DtDe &de);

      friend DtHbaoDrawableCreator;

   public:
      virtual void drawImplementation(osg::RenderInfo& renderInfo) const override;

      virtual void reloadShaders();

      //virtual void releaseGLObjects(osg::State* state = 0) const;

      virtual void setDepthTexture(osg::Texture* texture);

      virtual void setBaseTexture(osg::Texture* texture);

      virtual void setOcclusionTexture(osg::Texture* inputTex);
       
      virtual void setViewSize(int width, int height);

   protected:
      
      virtual void createProgramIfNecessary(void) const;

      virtual void cleanupGpuMemory(void);

      virtual void releaseHbaoRenderTexture();

      void updateHbaoSettings() const;

      void createTextureViewsIfNecessary(osg::State* state) const;

   protected:

      osg::ref_ptr<osg::Texture> myBaseTexture;
      osg::ref_ptr<osg::Texture> myDepthTexture;
      osg::ref_ptr<osg::Texture> myOcclusionTex;

      mutable GLuint myDepthTextureId;
      mutable std::vector<GLuint> myDepthTexViews;
      mutable bool myShadingRateIsSupported;

      mutable DtGlProgram* myMutableHbaoProgram;

      mutable int myMutableVrvSsaoTexLoc;
      mutable int myMutableVrvOcclusionTexLoc;
      
      mutable bool myMutableTapsDirty;
      
      mutable osg::observer_ptr<const osg::GraphicsContext> myInitGraphicsContext;
      mutable DtGlRenderTexture* myMutableHbaoTexture;

      mutable DtNvidiaHbaoGlObject* myNvidiaHbaoResources = nullptr;

      mutable HbaoParameters myMutableParameters;

      mutable DtSignalConnectionManager myMutableConnections;

      mutable bool myMutableShadersDirtyFlag;
   };
}