src/OpenGl/OpenGl_ShaderManager.hxx

   1 // Created on: 2013-09-26
   2 // Created by: Denis BOGOLEPOV
   3 // Copyright (c) 2013-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _OpenGl_ShaderManager_HeaderFile
  17 #define _OpenGl_ShaderManager_HeaderFile
  18
  19 #include <Graphic3d_ShaderProgram_Handle.hxx>
  20
  21 #include <NCollection_DataMap.hxx>
  22 #include <NCollection_Sequence.hxx>
  23
  24 #include <Handle_OpenGl_ShaderManager.hxx>
  25 #include <OpenGl_SetOfShaderPrograms.hxx>
  26 #include <OpenGl_ShaderStates.hxx>
  27 #include <OpenGl_AspectFace.hxx>
  28 #include <OpenGl_AspectLine.hxx>
  29 #include <OpenGl_AspectText.hxx>
  30 #include <OpenGl_AspectMarker.hxx>
  31 #include <OpenGl_Texture.hxx>
  32 #include <Visual3d_TypeOfModel.hxx>
  33
  34 class OpenGl_View;
  35
  36 //! List of shader programs.
  37 typedef NCollection_Sequence<Handle(OpenGl_ShaderProgram)> OpenGl_ShaderProgramList;
  38
  39 //! Map to declare per-program states of OCCT materials.
  40 typedef NCollection_DataMap<Handle(OpenGl_ShaderProgram), OpenGl_MaterialState> OpenGl_MaterialStates;
  41
  42 //! This class is responsible for managing shader programs.
  43 class OpenGl_ShaderManager : public Standard_Transient
  44 {
  45   friend class OpenGl_ShaderProgram;
  46
  47 public:
  48
  49   //! Creates new empty shader manager.
  50   Standard_EXPORT OpenGl_ShaderManager (OpenGl_Context* theContext);
  51
  52   //! Releases resources of shader manager.
  53   Standard_EXPORT virtual ~OpenGl_ShaderManager();
  54
  55   //! Release all resources.
  56   Standard_EXPORT void clear();
  57
  58   //! Creates new shader program or re-use shared instance.
  59   //! @param theProxy    [IN]  program definition
  60   //! @param theShareKey [OUT] sharing key
  61   //! @param theProgram  [OUT] OpenGL program
  62   //! @return true on success
  63   Standard_EXPORT Standard_Boolean Create (const Handle(Graphic3d_ShaderProgram)& theProxy,
  64                                            TCollection_AsciiString&               theShareKey,
  65                                            Handle(OpenGl_ShaderProgram)&          theProgram);
  66
  67   //! Unregisters specified shader program.
  68   Standard_EXPORT void Unregister (TCollection_AsciiString&      theShareKey,
  69                                    Handle(OpenGl_ShaderProgram)& theProgram);
  70
  71   //! Returns list of registered shader programs.
  72   Standard_EXPORT const OpenGl_ShaderProgramList& ShaderPrograms() const;
  73
  74   //! Returns true if no program objects are registered in the manager.
  75   Standard_EXPORT Standard_Boolean IsEmpty() const;
  76
  77   //! Bind program for filled primitives rendering
  78   Standard_Boolean BindProgram (const OpenGl_AspectFace*            theAspect,
  79                                 const Handle(OpenGl_Texture)&       theTexture,
  80                                 const Standard_Boolean              theToLightOn,
  81                                 const Standard_Boolean              theHasVertColor,
  82                                 const Handle(OpenGl_ShaderProgram)& theCustomProgram)
  83   {
  84     if (!theCustomProgram.IsNull()
  85      || myContext->caps->ffpEnable)
  86     {
  87       return bindProgramWithState (theCustomProgram, theAspect);
  88     }
  89
  90     const Standard_Integer        aBits    = getProgramBits (theTexture, theHasVertColor);
  91     Handle(OpenGl_ShaderProgram)& aProgram = getStdProgram (theToLightOn, aBits);
  92     return bindProgramWithState (aProgram, theAspect);
  93   }
  94
  95   //! Bind program for line rendering
  96   Standard_Boolean BindProgram (const OpenGl_AspectLine*            theAspect,
  97                                 const Handle(OpenGl_Texture)&       theTexture,
  98                                 const Standard_Boolean              theToLightOn,
  99                                 const Standard_Boolean              theHasVertColor,
 100                                 const Handle(OpenGl_ShaderProgram)& theCustomProgram)
 101   {
 102     if (!theCustomProgram.IsNull()
 103      || myContext->caps->ffpEnable)
 104     {
 105       return bindProgramWithState (theCustomProgram, theAspect);
 106     }
 107
 108     const Standard_Integer        aBits    = getProgramBits (theTexture, theHasVertColor);
 109     Handle(OpenGl_ShaderProgram)& aProgram = getStdProgram (theToLightOn, aBits);
 110     return bindProgramWithState (aProgram, theAspect);
 111   }
 112
 113   //! Bind program for point rendering
 114   Standard_Boolean BindProgram (const OpenGl_AspectMarker*          theAspect,
 115                                 const Handle(OpenGl_Texture)&       theTexture,
 116                                 const Standard_Boolean              theToLightOn,
 117                                 const Standard_Boolean              theHasVertColor,
 118                                 const Handle(OpenGl_ShaderProgram)& theCustomProgram)
 119   {
 120     if (!theCustomProgram.IsNull()
 121      || myContext->caps->ffpEnable)
 122     {
 123       return bindProgramWithState (theCustomProgram, theAspect);
 124     }
 125
 126     const Standard_Integer        aBits    = getProgramBits (theTexture, theHasVertColor) | OpenGl_PO_Point;
 127     Handle(OpenGl_ShaderProgram)& aProgram = getStdProgram (theToLightOn, aBits);
 128     return bindProgramWithState (aProgram, theAspect);
 129   }
 130
 131   //! Bind program for rendering alpha-textured font.
 132   Standard_Boolean BindProgram (const OpenGl_AspectText*            theAspect,
 133                                 const Handle(OpenGl_ShaderProgram)& theCustomProgram)
 134   {
 135     if (!theCustomProgram.IsNull()
 136      || myContext->caps->ffpEnable)
 137     {
 138       return bindProgramWithState (theCustomProgram, theAspect);
 139     }
 140
 141     if (myFontProgram.IsNull())
 142     {
 143       prepareStdProgramFont();
 144     }
 145     return bindProgramWithState (myFontProgram, theAspect);
 146   }
 147
 148 public:
 149
 150   //! Returns current state of OCCT light sources.
 151   Standard_EXPORT const OpenGl_LightSourceState& LightSourceState() const;
 152
 153   //! Updates state of OCCT light sources.
 154   Standard_EXPORT void UpdateLightSourceStateTo (const OpenGl_ListOfLight* theLights);
 155
 156   //! Pushes current state of OCCT light sources to specified program.
 157   Standard_EXPORT void PushLightSourceState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
 158
 159 public:
 160
 161   //! Returns current state of OCCT projection transform.
 162   Standard_EXPORT const OpenGl_ProjectionState& ProjectionState() const;
 163
 164   //! Updates state of OCCT projection transform.
 165   Standard_EXPORT void UpdateProjectionStateTo (const OpenGl_Mat4& theProjectionMatrix);
 166
 167   //! Pushes current state of OCCT projection transform to specified program.
 168   Standard_EXPORT void PushProjectionState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
 169
 170 public:
 171
 172   //! Returns current state of OCCT model-world transform.
 173   Standard_EXPORT const OpenGl_ModelWorldState& ModelWorldState() const;
 174
 175   //! Updates state of OCCT model-world transform.
 176   Standard_EXPORT void UpdateModelWorldStateTo (const OpenGl_Mat4& theModelWorldMatrix);
 177
 178   //! Pushes current state of OCCT model-world transform to specified program.
 179   Standard_EXPORT void PushModelWorldState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
 180
 181 public:
 182
 183   //! Returns current state of OCCT world-view transform.
 184   Standard_EXPORT const OpenGl_WorldViewState& WorldViewState() const;
 185
 186   //! Updates state of OCCT world-view transform.
 187   Standard_EXPORT void UpdateWorldViewStateTo (const OpenGl_Mat4& theWorldViewMatrix);
 188
 189   //! Pushes current state of OCCT world-view transform to specified program.
 190   Standard_EXPORT void PushWorldViewState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
 191
 192 public:
 193
 194   //! Updates state of OCCT clipping planes.
 195   Standard_EXPORT void UpdateClippingState();
 196
 197   //! Reverts state of OCCT clipping planes.
 198   Standard_EXPORT void RevertClippingState();
 199
 200   //! Pushes current state of OCCT clipping planes to specified program.
 201   Standard_EXPORT void PushClippingState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
 202
 203 public:
 204
 205   //! Resets state of OCCT material for all programs.
 206   Standard_EXPORT void ResetMaterialStates();
 207
 208   //! Updates state of OCCT material for specified program.
 209   Standard_EXPORT void UpdateMaterialStateTo (const Handle(OpenGl_ShaderProgram)& theProgram,
 210                                               const OpenGl_Element*               theAspect);
 211
 212   //! Pushes current state of OCCT material to specified program.
 213   Standard_EXPORT void PushMaterialState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
 214
 215   //! Returns current state of OCCT material for specified program.
 216   Standard_EXPORT const OpenGl_MaterialState* MaterialState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
 217
 218 public:
 219
 220   //! Pushes current state of OCCT graphics parameters to specified program.
 221   Standard_EXPORT void PushState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
 222
 223 public:
 224
 225   //! Overwrites context
 226   void SetContext (OpenGl_Context* theCtx)
 227   {
 228     myContext = theCtx;
 229   }
 230
 231   //! Sets shading model.
 232   Standard_EXPORT void SetShadingModel(const Visual3d_TypeOfModel theModel);
 233
 234   //! Sets last view manger used with.
 235   //! Helps to handle matrix states in multi-view configurations.
 236   void SetLastView (const OpenGl_View* theLastView)
 237   {
 238     myLastView = theLastView;
 239   }
 240
 241   //! Returns true when provided view is the same as cached one.
 242   bool IsSameView (const OpenGl_View* theView) const
 243   {
 244     return myLastView == theView;
 245   }
 246
 247 protected:
 248
 249   //! Define program bits.
 250   Standard_Integer getProgramBits (const Handle(OpenGl_Texture)& theTexture,
 251                                    const Standard_Boolean        theHasVertColor)
 252   {
 253     Standard_Integer aBits = 0;
 254     if (myContext->Clipping().IsClippingOrCappingOn())
 255     {
 256       aBits |= OpenGl_PO_ClipPlanes;
 257     }
 258     if (!theTexture.IsNull())
 259     {
 260       // GL_RED to be handled
 261       aBits |= theTexture->GetFormat() == GL_ALPHA ? OpenGl_PO_TextureA : OpenGl_PO_TextureRGB;
 262     }
 263     if (theHasVertColor)
 264     {
 265       aBits |= OpenGl_PO_VertColor;
 266     }
 267     return aBits;
 268   }
 269
 270   //! Prepare standard GLSL program.
 271   Handle(OpenGl_ShaderProgram)& getStdProgram (const Standard_Boolean theToLightOn,
 272                                                const Standard_Integer theBits)
 273   {
 274     if (theToLightOn)
 275     {
 276       Handle(OpenGl_ShaderProgram)& aProgram = myLightPrograms->ChangeValue (theBits);
 277       if (aProgram.IsNull())
 278       {
 279         prepareStdProgramLight (aProgram, theBits);
 280       }
 281       return aProgram;
 282     }
 283
 284     Handle(OpenGl_ShaderProgram)& aProgram = myFlatPrograms.ChangeValue (theBits);
 285     if (aProgram.IsNull())
 286     {
 287       prepareStdProgramFlat (aProgram, theBits);
 288     }
 289     return aProgram;
 290   }
 291
 292   //! Prepare standard GLSL program for textured font.
 293   Standard_EXPORT Standard_Boolean prepareStdProgramFont();
 294
 295   //! Prepare standard GLSL program without lighting.
 296   Standard_EXPORT Standard_Boolean prepareStdProgramFlat (Handle(OpenGl_ShaderProgram)& theProgram,
 297                                                           const Standard_Integer        theBits);
 298
 299   //! Prepare standard GLSL program with lighting.
 300   Standard_Boolean prepareStdProgramLight (Handle(OpenGl_ShaderProgram)& theProgram,
 301                                            const Standard_Integer        theBits)
 302   {
 303     return myShadingModel == Visual3d_TOM_FRAGMENT
 304          ? prepareStdProgramPhong   (theProgram, theBits)
 305          : prepareStdProgramGouraud (theProgram, theBits);
 306   }
 307
 308   //! Prepare standard GLSL program with per-vertex lighting.
 309   Standard_EXPORT Standard_Boolean prepareStdProgramGouraud (Handle(OpenGl_ShaderProgram)& theProgram,
 310                                                              const Standard_Integer        theBits);
 311
 312   //! Prepare standard GLSL program with per-pixel lighting.
 313   Standard_EXPORT Standard_Boolean prepareStdProgramPhong (Handle(OpenGl_ShaderProgram)& theProgram,
 314                                                            const Standard_Integer        theBits);
 315
 316   //! Define computeLighting GLSL function depending on current lights configuration
 317   //! @param theHasVertColor flag to use getVertColor() instead of Ambient and Diffuse components of active material
 318   Standard_EXPORT TCollection_AsciiString stdComputeLighting (const Standard_Boolean theHasVertColor);
 319
 320   //! Bind specified program to current context and apply state.
 321   Standard_EXPORT Standard_Boolean bindProgramWithState (const Handle(OpenGl_ShaderProgram)& theProgram,
 322                                                          const OpenGl_Element*               theAspect);
 323
 324   //! Set pointer myLightPrograms to active lighting programs set from myMapOfLightPrograms
 325   Standard_EXPORT void switchLightPrograms();
 326
 327 protected:
 328
 329   Visual3d_TypeOfModel               myShadingModel;       //!< lighting shading model
 330   OpenGl_ShaderProgramList           myProgramList;        //!< The list of shader programs
 331   Handle(OpenGl_SetOfShaderPrograms) myLightPrograms;      //!< pointer to active lighting programs matrix
 332   OpenGl_SetOfShaderPrograms         myFlatPrograms;       //!< programs matrix without  lighting
 333   Handle(OpenGl_ShaderProgram)       myFontProgram;        //!< standard program for textured text
 334   OpenGl_MapOfShaderPrograms         myMapOfLightPrograms; //!< map of lighting programs depending on shading model and lights configuration
 335
 336   OpenGl_Context*                    myContext;            //!< OpenGL context
 337
 338 protected:
 339
 340   OpenGl_MaterialStates              myMaterialStates;     //!< Per-program state of OCCT material
 341   OpenGl_ProjectionState             myProjectionState;    //!< State of OCCT projection  transformation
 342   OpenGl_ModelWorldState             myModelWorldState;    //!< State of OCCT model-world transformation
 343   OpenGl_WorldViewState              myWorldViewState;     //!< State of OCCT world-view  transformation
 344   OpenGl_ClippingState               myClippingState;      //!< State of OCCT clipping planes
 345   OpenGl_LightSourceState            myLightSourceState;   //!< State of OCCT light sources
 346
 347 private:
 348
 349   const OpenGl_View*                 myLastView;           //!< Pointer to the last view shader manager used with
 350
 351 public:
 352
 353   DEFINE_STANDARD_RTTI (OpenGl_ShaderManager)
 354
 355 };
 356
 357 #endif // _OpenGl_ShaderManager_HeaderFile