Source/System/State/Shader/Chunks/OSGShaderExecutableChunk.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 by the OpenSG Forum                 *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGSHADEREXECUTABLECHUNK_H_
  40 #define _OSGSHADEREXECUTABLECHUNK_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGShaderProgram.h"
  46 #include "OSGShaderExecutableChunkBase.h"
  47
  48 OSG_BEGIN_NAMESPACE
  49
  50 class ShaderProgramChunk;
  51 class ShaderCache;
  52 class SimpleSHLChunk;
  53
  54 /*! \brief ShaderExecutableChunk class. See \ref
  55            PageSystemShaderExecutableChunk for a description.
  56     \ingroup GrpSystemShaderChunks
  57     \ingroup GrpLibOSGSystem
  58     \includebasedoc
  59  */
  60
  61 class OSG_SYSTEM_DLLMAPPING ShaderExecutableChunk :
  62     public ShaderExecutableChunkBase
  63 {
  64   protected:
  65
  66     /*==========================  PUBLIC  =================================*/
  67
  68   public:
  69
  70     typedef ShaderExecutableChunkBase            Inherited;
  71     typedef ShaderExecutableChunk                Self;
  72
  73     static const UInt32 KeepProgActive = ShaderProgram::KeepProgActive;
  74
  75     static const UInt32 ProgActive     = ShaderProgram::ProgActive;
  76
  77     /*---------------------------------------------------------------------*/
  78     /*! \name                 Chunk Class Access                           */
  79     /*! \{                                                                 */
  80
  81     virtual const StateChunkClass *getClass(void) const;
  82
  83     /*! \}                                                                 */
  84     /*---------------------------------------------------------------------*/
  85     /*! \name              Static Chunk Class Access                       */
  86     /*! \{                                                                 */
  87
  88     static       UInt32           getStaticClassId(void);
  89     static const StateChunkClass *getStaticClass  (void);
  90
  91     /*! \}                                                                 */
  92     /*---------------------------------------------------------------------*/
  93     /*! \name                    Chunk Id                                  */
  94     /*! \{                                                                 */
  95
  96     virtual UInt16 getChunkId(void);
  97
  98     /*! \}                                                                 */
  99     /*---------------------------------------------------------------------*/
 100     /*! \name                      Sync                                    */
 101     /*! \{                                                                 */
 102
 103     virtual void changed(ConstFieldMaskArg whichField,
 104                          UInt32            origin,
 105                          BitVector         details    );
 106
 107     /*! \}                                                                 */
 108     /*---------------------------------------------------------------------*/
 109     /*! \name                     Output                                   */
 110     /*! \{                                                                 */
 111
 112     virtual void activate                (DrawEnv    *pEnv,
 113                                           UInt32      uiIdx = 0);
 114
 115     virtual void changeFrom              (DrawEnv    *pEnv,
 116                                           StateChunk *pOld,
 117                                           UInt32      uiIdx = 0);
 118
 119     virtual void deactivate              (DrawEnv    *pEnv,
 120                                           UInt32      uiIdx = 0);
 121
 122     virtual void updateObjectDependencies(DrawEnv    *pEnv,
 123                                           UInt32      index = 0);
 124
 125     /*! \}                                                                 */
 126     /*---------------------------------------------------------------------*/
 127     /*! \name                     Output                                   */
 128     /*! \{                                                                 */
 129
 130     void merge(const ShaderProgramChunk *pChunk);
 131
 132     /*! \}                                                                 */
 133     /*---------------------------------------------------------------------*/
 134     /*! \name                     Output                                   */
 135     /*! \{                                                                 */
 136
 137     virtual void dump(      UInt32     uiIndent = 0,
 138                       const BitVector  bvFlags  = 0) const;
 139
 140     /*! \}                                                                 */
 141     /*=========================  PROTECTED  ===============================*/
 142
 143   protected:
 144
 145     static       UInt32 _extSHL;
 146
 147     static const UInt32 UsesAttribs = 0x0001;
 148
 149     /*---------------------------------------------------------------------*/
 150
 151     static volatile UInt16 _uiChunkCounter;
 152
 153     UInt16 _uiChunkId;
 154
 155     typedef MFFragmentShaderType      ::const_iterator FragmentShaderIt;
 156     typedef MFGeometryShaderType      ::const_iterator GeometryShaderIt;
 157     typedef MFTessEvaluationShaderType::const_iterator TessEvalShaderIt;
 158     typedef MFTessControlShaderType   ::const_iterator TessControlShaderIt;
 159     typedef MFVertexShaderType        ::const_iterator VertexShaderIt;
 160
 161     /*---------------------------------------------------------------------*/
 162     /*! \name                  Constructors                                */
 163     /*! \{                                                                 */
 164
 165     ShaderExecutableChunk(void);
 166     ShaderExecutableChunk(const ShaderExecutableChunk &source);
 167
 168     /*! \}                                                                 */
 169     /*---------------------------------------------------------------------*/
 170     /*! \name                   Destructors                                */
 171     /*! \{                                                                 */
 172
 173     virtual ~ShaderExecutableChunk(void);
 174
 175     /*! \}                                                                 */
 176     /*---------------------------------------------------------------------*/
 177     /*! \name                      Init                                    */
 178     /*! \{                                                                 */
 179
 180     static void initMethod(InitPhase ePhase);
 181
 182     /*! \}                                                                 */
 183     /*---------------------------------------------------------------------*/
 184     /*! \name                       Sync                                   */
 185     /*! \{                                                                 */
 186
 187     virtual void resolveLinks(void);
 188
 189     /*! \}                                                                 */
 190     /*---------------------------------------------------------------------*/
 191     /*! \name                      Init                                    */
 192     /*! \{                                                                 */
 193
 194            UInt32 handleGL       (DrawEnv                 *pEnv,
 195                                   UInt32                   id,
 196                                   Window::GLObjectStatusE  mode,
 197                                   UInt64                   uiOptions);
 198     static void   handleDestroyGL(DrawEnv                 *pEnv,
 199                                   UInt32                   id,
 200                                   Window::GLObjectStatusE  mode     );
 201
 202     /*! \}                                                                 */
 203     /*---------------------------------------------------------------------*/
 204     /*! \name                      Init                                    */
 205     /*! \{                                                                 */
 206
 207     void onCreate      (const ShaderExecutableChunk *source      = NULL);
 208     void onCreateAspect(const ShaderExecutableChunk *createAspect,
 209                         const ShaderExecutableChunk *source      = NULL);
 210     void onDestroy(           UInt32                 uiId              );
 211
 212     /*! \}                                                                 */
 213     /*---------------------------------------------------------------------*/
 214     /*! \name                      Init                                    */
 215     /*! \{                                                                 */
 216
 217     void updateVariableLocations  (DrawEnv *pEnv,
 218                                    UInt32   uiProgram);
 219     void updateVariables          (DrawEnv *pEnv,
 220                                    UInt32   uiProgram);
 221     void updateParameters         (DrawEnv *pEnv,
 222                                    UInt32   uiProgram);
 223     void updateAttribBindings     (DrawEnv *pEnv,
 224                                    UInt32   uiProgram);
 225
 226     void updateProceduralVariables(DrawEnv *pEnv,
 227                                    UInt32   uiUpdateDependents);
 228
 229     void remergeVariables         (void                       );
 230
 231     /*! \}                                                                 */
 232     /*---------------------------------------------------------------------*/
 233     /*! \name                      Init                                    */
 234     /*! \{                                                                 */
 235
 236     const MFFragmentShaderType       *getMFFragmentShader      (void);
 237     const MFGeometryShaderType       *getMFGeometryShader      (void);
 238     const MFTessEvaluationShaderType *getMFTessEvaluationShader(void);
 239     const MFTessControlShaderType    *getMFTessControlShader   (void);
 240     const MFVertexShaderType         *getMFVertexShader        (void);
 241
 242     /*! \}                                                                 */
 243     /*==========================  PRIVATE  ================================*/
 244
 245   private:
 246
 247     // class. Used for indexing in State
 248     static StateChunkClass _class;
 249
 250     friend class FieldContainer;
 251     friend class ShaderExecutableChunkBase;
 252     friend class ShaderCache;
 253     friend class SimpleSHLChunk;
 254
 255     // prohibit default functions (move to 'public' if you need one)
 256     void operator =(const ShaderExecutableChunk &source);
 257 };
 258
 259 typedef ShaderExecutableChunk *ShaderExecutableChunkP;
 260
 261 OSG_END_NAMESPACE
 262
 263 #include "OSGShaderExecutableChunkBase.inl"
 264 #include "OSGShaderExecutableChunk.inl"
 265
 266 #endif /* _OSGSHADEREXECUTABLECHUNK_H_ */