Source/Contrib/ComputeBase/ComputeShader/OSGComputeShaderAlgorithmBase.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2013 by the OpenSG Forum                 *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  * contact: dirk@opensg.org, gerrit.voss@vossg.org, carsten_neumann@gmx.net  *
  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 /*****************************************************************************\
  40  *****************************************************************************
  41  **                                                                         **
  42  **                  This file is automatically generated.                  **
  43  **                                                                         **
  44  **          Any changes made to this file WILL be lost when it is          **
  45  **           regenerated, which can become necessary at any time.          **
  46  **                                                                         **
  47  **     Do not change this file, changes should be done in the derived      **
  48  **     class ComputeShaderAlgorithm
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGCOMPUTESHADERALGORITHMBASE_H_
  55 #define _OSGCOMPUTESHADERALGORITHMBASE_H_
  56 #ifdef __sgi
  57 #pragma once
  58 #endif
  59
  60
  61 #include "OSGConfig.h"
  62 #include "OSGContribComputeBaseDef.h"
  63
  64 //#include "OSGBaseTypes.h"
  65
  66 #include "OSGComputeAlgorithm.h" // Parent
  67
  68 #include "OSGTextureImageChunkFields.h" // TextureImages type
  69 #include "OSGChunkMaterialFields.h"     // ChunkMaterial type
  70 #include "OSGComputeShaderChunkFields.h" // ComputeShader type
  71 #include "OSGVecFields.h"               // DispatchConfig type
  72 #include "OSGSysFields.h"               // UseMemoryBarrier type
  73 #include "OSGBaseFields.h"              // MemoryBarrier type
  74
  75 #include "OSGComputeShaderAlgorithmFields.h"
  76
  77 OSG_BEGIN_NAMESPACE
  78
  79
  80 class ComputeShaderAlgorithm;
  81
  82 //! \brief ComputeShaderAlgorithm Base Class.
  83
  84 class OSG_CONTRIBCOMPUTEBASE_DLLMAPPING ComputeShaderAlgorithmBase : public ComputeAlgorithm
  85 {
  86   public:
  87
  88     typedef ComputeAlgorithm Inherited;
  89     typedef ComputeAlgorithm ParentContainer;
  90
  91     typedef Inherited::TypeObject TypeObject;
  92     typedef TypeObject::InitPhase InitPhase;
  93
  94     OSG_GEN_INTERNALPTR(ComputeShaderAlgorithm);
  95
  96     /*==========================  PUBLIC  =================================*/
  97
  98   public:
  99
 100     enum
 101     {
 102         TextureImagesFieldId = Inherited::NextFieldId,
 103         ChunkMaterialFieldId = TextureImagesFieldId + 1,
 104         ComputeShaderFieldId = ChunkMaterialFieldId + 1,
 105         DispatchConfigFieldId = ComputeShaderFieldId + 1,
 106         WorkGroupSizeFieldId = DispatchConfigFieldId + 1,
 107         UseMemoryBarrierFieldId = WorkGroupSizeFieldId + 1,
 108         UseVariableWorkGroupSizeFieldId = UseMemoryBarrierFieldId + 1,
 109         MemoryBarrierFieldId = UseVariableWorkGroupSizeFieldId + 1,
 110         NextFieldId = MemoryBarrierFieldId + 1
 111     };
 112
 113     static const OSG::BitVector TextureImagesFieldMask =
 114         (TypeTraits<BitVector>::One << TextureImagesFieldId);
 115     static const OSG::BitVector ChunkMaterialFieldMask =
 116         (TypeTraits<BitVector>::One << ChunkMaterialFieldId);
 117     static const OSG::BitVector ComputeShaderFieldMask =
 118         (TypeTraits<BitVector>::One << ComputeShaderFieldId);
 119     static const OSG::BitVector DispatchConfigFieldMask =
 120         (TypeTraits<BitVector>::One << DispatchConfigFieldId);
 121     static const OSG::BitVector WorkGroupSizeFieldMask =
 122         (TypeTraits<BitVector>::One << WorkGroupSizeFieldId);
 123     static const OSG::BitVector UseMemoryBarrierFieldMask =
 124         (TypeTraits<BitVector>::One << UseMemoryBarrierFieldId);
 125     static const OSG::BitVector UseVariableWorkGroupSizeFieldMask =
 126         (TypeTraits<BitVector>::One << UseVariableWorkGroupSizeFieldId);
 127     static const OSG::BitVector MemoryBarrierFieldMask =
 128         (TypeTraits<BitVector>::One << MemoryBarrierFieldId);
 129     static const OSG::BitVector NextFieldMask =
 130         (TypeTraits<BitVector>::One << NextFieldId);
 131
 132     typedef MFUnrecTextureImageChunkPtr MFTextureImagesType;
 133     typedef SFUnrecChunkMaterialPtr SFChunkMaterialType;
 134     typedef SFUnrecComputeShaderChunkPtr SFComputeShaderType;
 135     typedef SFVec3i           SFDispatchConfigType;
 136     typedef SFVec3i           SFWorkGroupSizeType;
 137     typedef SFBool            SFUseMemoryBarrierType;
 138     typedef SFBool            SFUseVariableWorkGroupSizeType;
 139     typedef SFGLenum          SFMemoryBarrierType;
 140
 141     /*---------------------------------------------------------------------*/
 142     /*! \name                    Class Get                                 */
 143     /*! \{                                                                 */
 144
 145     static FieldContainerType &getClassType   (void);
 146     static UInt32              getClassTypeId (void);
 147     static UInt16              getClassGroupId(void);
 148
 149     /*! \}                                                                 */
 150     /*---------------------------------------------------------------------*/
 151     /*! \name                FieldContainer Get                            */
 152     /*! \{                                                                 */
 153
 154     virtual       FieldContainerType &getType         (void);
 155     virtual const FieldContainerType &getType         (void) const;
 156
 157     virtual       UInt32              getContainerSize(void) const;
 158
 159     /*! \}                                                                 */
 160     /*---------------------------------------------------------------------*/
 161     /*! \name                    Field Get                                 */
 162     /*! \{                                                                 */
 163
 164             const MFUnrecTextureImageChunkPtr *getMFTextureImages  (void) const;
 165                   MFUnrecTextureImageChunkPtr *editMFTextureImages  (void);
 166             const SFUnrecChunkMaterialPtr *getSFChunkMaterial  (void) const;
 167                   SFUnrecChunkMaterialPtr *editSFChunkMaterial  (void);
 168             const SFUnrecComputeShaderChunkPtr *getSFComputeShader  (void) const;
 169                   SFUnrecComputeShaderChunkPtr *editSFComputeShader  (void);
 170
 171                   SFVec3i             *editSFDispatchConfig (void);
 172             const SFVec3i             *getSFDispatchConfig  (void) const;
 173
 174                   SFVec3i             *editSFWorkGroupSize  (void);
 175             const SFVec3i             *getSFWorkGroupSize   (void) const;
 176
 177                   SFBool              *editSFUseMemoryBarrier(void);
 178             const SFBool              *getSFUseMemoryBarrier (void) const;
 179
 180                   SFBool              *editSFUseVariableWorkGroupSize(void);
 181             const SFBool              *getSFUseVariableWorkGroupSize (void) const;
 182
 183                   SFGLenum            *editSFMemoryBarrier  (void);
 184             const SFGLenum            *getSFMemoryBarrier   (void) const;
 185
 186
 187                   TextureImageChunk * getTextureImages  (const UInt32 index) const;
 188
 189                   ChunkMaterial * getChunkMaterial  (void) const;
 190
 191                   ComputeShaderChunk * getComputeShader  (void) const;
 192
 193                   Vec3i               &editDispatchConfig (void);
 194             const Vec3i               &getDispatchConfig  (void) const;
 195
 196                   Vec3i               &editWorkGroupSize  (void);
 197             const Vec3i               &getWorkGroupSize   (void) const;
 198
 199                   bool                &editUseMemoryBarrier(void);
 200                   bool                 getUseMemoryBarrier (void) const;
 201
 202                   bool                &editUseVariableWorkGroupSize(void);
 203                   bool                 getUseVariableWorkGroupSize (void) const;
 204
 205                   GLenum              &editMemoryBarrier  (void);
 206             const GLenum              &getMemoryBarrier   (void) const;
 207
 208     /*! \}                                                                 */
 209     /*---------------------------------------------------------------------*/
 210     /*! \name                    Field Set                                 */
 211     /*! \{                                                                 */
 212
 213             void setChunkMaterial  (ChunkMaterial * const value);
 214             void setComputeShader  (ComputeShaderChunk * const value);
 215             void setDispatchConfig (const Vec3i &value);
 216             void setWorkGroupSize  (const Vec3i &value);
 217             void setUseMemoryBarrier(const bool value);
 218             void setUseVariableWorkGroupSize(const bool value);
 219             void setMemoryBarrier  (const GLenum &value);
 220
 221     /*! \}                                                                 */
 222     /*---------------------------------------------------------------------*/
 223     /*! \name                Ptr Field Set                                 */
 224     /*! \{                                                                 */
 225
 226     /*! \}                                                                 */
 227     /*---------------------------------------------------------------------*/
 228     /*! \name                Ptr MField Set                                */
 229     /*! \{                                                                 */
 230
 231     void pushToTextureImages           (TextureImageChunk * const value   );
 232     void assignTextureImages          (const MFUnrecTextureImageChunkPtr &value);
 233     void removeFromTextureImages (UInt32               uiIndex );
 234     void removeObjFromTextureImages(TextureImageChunk * const value   );
 235     void clearTextureImages            (void                         );
 236
 237     /*! \}                                                                 */
 238     /*---------------------------------------------------------------------*/
 239     /*! \name                   Binary Access                              */
 240     /*! \{                                                                 */
 241
 242     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 243     virtual void   copyToBin  (BinaryDataHandler &pMem,
 244                                ConstFieldMaskArg  whichField);
 245     virtual void   copyFromBin(BinaryDataHandler &pMem,
 246                                ConstFieldMaskArg  whichField);
 247
 248
 249     /*! \}                                                                 */
 250     /*---------------------------------------------------------------------*/
 251     /*! \name                   Construction                               */
 252     /*! \{                                                                 */
 253
 254     static  ComputeShaderAlgorithmTransitPtr  create          (void);
 255     static  ComputeShaderAlgorithm           *createEmpty     (void);
 256
 257     static  ComputeShaderAlgorithmTransitPtr  createLocal     (
 258                                                BitVector bFlags = FCLocal::All);
 259
 260     static  ComputeShaderAlgorithm            *createEmptyLocal(
 261                                               BitVector bFlags = FCLocal::All);
 262
 263     static  ComputeShaderAlgorithmTransitPtr  createDependent  (BitVector bFlags);
 264
 265     /*! \}                                                                 */
 266     /*---------------------------------------------------------------------*/
 267     /*! \name                       Copy                                   */
 268     /*! \{                                                                 */
 269
 270     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 271     virtual FieldContainerTransitPtr shallowCopyLocal(
 272                                        BitVector bFlags = FCLocal::All) const;
 273     virtual FieldContainerTransitPtr shallowCopyDependent(
 274                                                       BitVector bFlags) const;
 275
 276     /*! \}                                                                 */
 277     /*=========================  PROTECTED  ===============================*/
 278
 279   protected:
 280
 281     static TypeObject _type;
 282
 283     static       void   classDescInserter(TypeObject &oType);
 284     static const Char8 *getClassname     (void             );
 285
 286     /*---------------------------------------------------------------------*/
 287     /*! \name                      Fields                                  */
 288     /*! \{                                                                 */
 289
 290     MFUnrecTextureImageChunkPtr _mfTextureImages;
 291     SFUnrecChunkMaterialPtr _sfChunkMaterial;
 292     SFUnrecComputeShaderChunkPtr _sfComputeShader;
 293     SFVec3i           _sfDispatchConfig;
 294     SFVec3i           _sfWorkGroupSize;
 295     SFBool            _sfUseMemoryBarrier;
 296     SFBool            _sfUseVariableWorkGroupSize;
 297     SFGLenum          _sfMemoryBarrier;
 298
 299     /*! \}                                                                 */
 300     /*---------------------------------------------------------------------*/
 301     /*! \name                   Constructors                               */
 302     /*! \{                                                                 */
 303
 304     ComputeShaderAlgorithmBase(void);
 305     ComputeShaderAlgorithmBase(const ComputeShaderAlgorithmBase &source);
 306
 307     /*! \}                                                                 */
 308     /*---------------------------------------------------------------------*/
 309     /*! \name                   Destructors                                */
 310     /*! \{                                                                 */
 311
 312     virtual ~ComputeShaderAlgorithmBase(void);
 313
 314     /*! \}                                                                 */
 315     /*---------------------------------------------------------------------*/
 316     /*! \name                     onCreate                                */
 317     /*! \{                                                                 */
 318
 319     void onCreate(const ComputeShaderAlgorithm *source = NULL);
 320
 321     /*! \}                                                                 */
 322     /*---------------------------------------------------------------------*/
 323     /*! \name                    Generic Field Access                      */
 324     /*! \{                                                                 */
 325
 326      GetFieldHandlePtr  getHandleTextureImages   (void) const;
 327      EditFieldHandlePtr editHandleTextureImages  (void);
 328      GetFieldHandlePtr  getHandleChunkMaterial   (void) const;
 329      EditFieldHandlePtr editHandleChunkMaterial  (void);
 330      GetFieldHandlePtr  getHandleComputeShader   (void) const;
 331      EditFieldHandlePtr editHandleComputeShader  (void);
 332      GetFieldHandlePtr  getHandleDispatchConfig  (void) const;
 333      EditFieldHandlePtr editHandleDispatchConfig (void);
 334      GetFieldHandlePtr  getHandleWorkGroupSize   (void) const;
 335      EditFieldHandlePtr editHandleWorkGroupSize  (void);
 336      GetFieldHandlePtr  getHandleUseMemoryBarrier (void) const;
 337      EditFieldHandlePtr editHandleUseMemoryBarrier(void);
 338      GetFieldHandlePtr  getHandleUseVariableWorkGroupSize (void) const;
 339      EditFieldHandlePtr editHandleUseVariableWorkGroupSize(void);
 340      GetFieldHandlePtr  getHandleMemoryBarrier   (void) const;
 341      EditFieldHandlePtr editHandleMemoryBarrier  (void);
 342
 343     /*! \}                                                                 */
 344     /*---------------------------------------------------------------------*/
 345     /*! \name                       Sync                                   */
 346     /*! \{                                                                 */
 347
 348 #ifdef OSG_MT_CPTR_ASPECT
 349     virtual void execSyncV(      FieldContainer    &oFrom,
 350                                  ConstFieldMaskArg  whichField,
 351                                  AspectOffsetStore &oOffsets,
 352                                  ConstFieldMaskArg  syncMode  ,
 353                            const UInt32             uiSyncInfo);
 354
 355             void execSync (      ComputeShaderAlgorithmBase *pFrom,
 356                                  ConstFieldMaskArg  whichField,
 357                                  AspectOffsetStore &oOffsets,
 358                                  ConstFieldMaskArg  syncMode  ,
 359                            const UInt32             uiSyncInfo);
 360 #endif
 361
 362     /*! \}                                                                 */
 363     /*---------------------------------------------------------------------*/
 364     /*! \name                       Edit                                   */
 365     /*! \{                                                                 */
 366
 367     /*! \}                                                                 */
 368     /*---------------------------------------------------------------------*/
 369     /*! \name                     Aspect Create                            */
 370     /*! \{                                                                 */
 371
 372 #ifdef OSG_MT_CPTR_ASPECT
 373     virtual FieldContainer *createAspectCopy(
 374                                     const FieldContainer *pRefAspect) const;
 375 #endif
 376
 377     /*! \}                                                                 */
 378     /*---------------------------------------------------------------------*/
 379     /*! \name                       Edit                                   */
 380     /*! \{                                                                 */
 381     /*! \}                                                                 */
 382     /*---------------------------------------------------------------------*/
 383     /*! \name                       Sync                                   */
 384     /*! \{                                                                 */
 385
 386     virtual void resolveLinks(void);
 387
 388     /*! \}                                                                 */
 389     /*==========================  PRIVATE  ================================*/
 390
 391   private:
 392     /*---------------------------------------------------------------------*/
 393
 394     // prohibit default functions (move to 'public' if you need one)
 395     void operator =(const ComputeShaderAlgorithmBase &source);
 396 };
 397
 398 typedef ComputeShaderAlgorithmBase *ComputeShaderAlgorithmBaseP;
 399
 400 OSG_END_NAMESPACE
 401
 402 #endif /* _OSGCOMPUTESHADERALGORITHMBASE_H_ */