Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OgreGpuProgram.h

Go to the documentation of this file.
00001 /*
00002 -----------------------------------------------------------------------------
00003 This source file is part of OGRE
00004     (Object-oriented Graphics Rendering Engine)
00005 For the latest info, see http://ogre.sourceforge.net/
00006 
00007 Copyright (c) 2000-2005 The OGRE Team
00008 Also see acknowledgements in Readme.html
00009 
00010 This program is free software; you can redistribute it and/or modify it under
00011 the terms of the GNU Lesser General Public License as published by the Free Software
00012 Foundation; either version 2 of the License, or (at your option) any later
00013 version.
00014 
00015 This program is distributed in the hope that it will be useful, but WITHOUT
00016 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00017 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
00018 
00019 You should have received a copy of the GNU Lesser General Public License along with
00020 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00021 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
00022 http://www.gnu.org/copyleft/lesser.txt.
00023 -----------------------------------------------------------------------------
00024 */
00025 #ifndef __GpuProgram_H_
00026 #define __GpuProgram_H_
00027 
00028 // Precompiler options
00029 #include "OgrePrerequisites.h"
00030 #include "OgreResource.h"
00031 #include "OgreSharedPtr.h"
00032 #include "OgreIteratorWrappers.h"
00033 
00034 namespace Ogre {
00035 
00037     enum GpuProgramType
00038     {
00039         GPT_VERTEX_PROGRAM,
00040         GPT_FRAGMENT_PROGRAM
00041     };
00042 
00043     
00055     class _OgreExport GpuProgramParameters
00056     {
00057     public:
00061         enum AutoConstantType
00062         {
00064             ACT_WORLD_MATRIX,
00066             ACT_WORLD_MATRIX_ARRAY_3x4,
00068             ACT_WORLD_MATRIX_ARRAY,
00070             ACT_VIEW_MATRIX,
00072             ACT_PROJECTION_MATRIX,
00074             ACT_VIEWPROJ_MATRIX,
00076             ACT_WORLDVIEW_MATRIX,
00078             ACT_WORLDVIEWPROJ_MATRIX,
00080             ACT_INVERSE_WORLD_MATRIX,
00082             ACT_INVERSE_VIEW_MATRIX,
00084             ACT_INVERSE_WORLDVIEW_MATRIX,
00086             ACT_INVERSETRANSPOSE_WORLD_MATRIX,
00088             ACT_INVERSETRANSPOSE_WORLDVIEW_MATRIX,
00090             ACT_LIGHT_DIFFUSE_COLOUR,
00092             ACT_LIGHT_SPECULAR_COLOUR,
00094             ACT_LIGHT_ATTENUATION,
00096             ACT_LIGHT_POSITION,
00098             ACT_LIGHT_DIRECTION,
00100             ACT_LIGHT_POSITION_OBJECT_SPACE,
00102             ACT_LIGHT_DIRECTION_OBJECT_SPACE,
00107             ACT_LIGHT_DISTANCE_OBJECT_SPACE,
00111             ACT_SHADOW_EXTRUSION_DISTANCE,
00113             ACT_CAMERA_POSITION_OBJECT_SPACE,
00115             ACT_AMBIENT_LIGHT_COLOUR, 
00117             ACT_TEXTURE_VIEWPROJ_MATRIX,
00119             ACT_CUSTOM,
00121             ACT_CAMERA_POSITION,
00125             ACT_TIME_0_X,
00127             ACT_COSTIME_0_X,
00129             ACT_SINTIME_0_X,
00131             ACT_TANTIME_0_X,
00135             ACT_TIME_0_X_PACKED,
00140             ACT_TIME_0_1,
00142             ACT_COSTIME_0_1,
00144             ACT_SINTIME_0_1,
00146             ACT_TANTIME_0_1,
00150             ACT_TIME_0_1_PACKED,
00155             ACT_TIME_0_2PI,
00157             ACT_COSTIME_0_2PI,
00159             ACT_SINTIME_0_2PI,
00161             ACT_TANTIME_0_2PI,
00165             ACT_TIME_0_2PI_PACKED,
00167             ACT_FPS,
00169 
00172             ACT_VIEWPORT_WIDTH,
00176             ACT_VIEWPORT_HEIGHT,
00180             ACT_INVERSE_VIEWPORT_WIDTH,
00184             ACT_INVERSE_VIEWPORT_HEIGHT,
00185 
00187 
00190             ACT_VIEW_DIRECTION,
00194             ACT_VIEW_SIDE_VECTOR,
00198             ACT_VIEW_UP_VECTOR,
00202             ACT_FOV,
00206             ACT_NEAR_CLIP_DISTANCE,
00210             ACT_FAR_CLIP_DISTANCE,
00211 
00213 
00216             ACT_INVERSE_VIEWPROJ_MATRIX,
00220             ACT_INVERSETRANSPOSE_VIEWPROJ_MATRIX,
00224             ACT_TRANSPOSE_VIEWPROJ_MATRIX,
00225 
00229             ACT_TRANSPOSE_VIEW_MATRIX,
00233             ACT_INVERSETRANSPOSE_VIEW_MATRIX,
00234 
00238             ACT_TRANSPOSE_PROJECTION_MATRIX,
00242             ACT_INVERSE_PROJECTION_MATRIX,
00246             ACT_INVERSETRANSPOSE_PROJECTION_MATRIX,
00247 
00251             ACT_TRANSPOSE_WORLDVIEWPROJ_MATRIX,
00255             ACT_INVERSE_WORLDVIEWPROJ_MATRIX,
00259             ACT_INVERSETRANSPOSE_WORLDVIEWPROJ_MATRIX,
00260             
00264             ACT_TRANSPOSE_WORLDVIEW_MATRIX,
00268             ACT_INVERSE_TRANSPOSE_WORLDVIEW_MATRIX,
00269  
00273             ACT_TRANSPOSE_WORLD_MATRIX,
00277             ACT_INVERSE_TRANSPOSE_WORLD_MATRIX
00278  
00279         };
00281         class AutoConstantEntry
00282         {
00283         public:
00285             AutoConstantType paramType;
00287             size_t index;
00289             union{
00290                 size_t data;
00291                 Real fData;
00292             };
00293 
00294             AutoConstantEntry(AutoConstantType theType, size_t theIndex, size_t theData)
00295                 : paramType(theType), index(theIndex), data(theData) {}
00296 
00297             AutoConstantEntry(AutoConstantType theType, size_t theIndex, Real theData)
00298                 : paramType(theType), index(theIndex), fData(theData) {}
00299 
00300         };
00305         struct RealConstantEntry
00306         {
00307             float val[4];
00308             bool isSet;
00309             RealConstantEntry() : isSet(false) {}
00310         };
00315         struct IntConstantEntry
00316         {
00317             int val[4];
00318             bool isSet;
00319             IntConstantEntry() : isSet(false) {}
00320         };
00321     protected:
00322         // Constant lists
00323         typedef std::vector<RealConstantEntry> RealConstantList;
00324         typedef std::vector<IntConstantEntry> IntConstantList;
00325         // Auto parameter storage
00326         typedef std::vector<AutoConstantEntry> AutoConstantList;
00328         RealConstantList mRealConstants;
00330         IntConstantList mIntConstants;
00332         AutoConstantList mAutoConstants;
00334         typedef std::map<String, size_t> ParamNameMap;
00335         ParamNameMap mParamNameMap;
00337         bool mTransposeMatrices;
00339         bool mAutoAddParamName;
00340 
00341     public:
00342         GpuProgramParameters();
00343         ~GpuProgramParameters() {}
00344 
00350         void setConstant(size_t index, const Vector4& vec);
00358         void setConstant(size_t index, const Vector3& vec);
00365         void setConstant(size_t index, const Matrix4& m);
00373         void setConstant(size_t index, const Matrix4* m, size_t numEntries);
00380         void setConstant(size_t index, const float *val, size_t count);
00387         void setConstant(size_t index, const double *val, size_t count);
00393         void setConstant(size_t index, const ColourValue& colour);
00394         
00409         void setConstant(size_t index, const int *val, size_t count);
00410 
00412         void resetRealConstants(void) { mRealConstants.clear(); }
00414         void resetIntConstants(void) { mIntConstants.clear(); }
00415 
00416         typedef ConstVectorIterator<RealConstantList> RealConstantIterator;
00417         typedef ConstVectorIterator<IntConstantList> IntConstantIterator;
00419         RealConstantIterator getRealConstantIterator(void) const;
00421         IntConstantIterator getIntConstantIterator(void) const;
00422 
00427         RealConstantEntry* getRealConstantEntry(const size_t index);
00432         IntConstantEntry* getIntConstantEntry(const size_t index);
00433         
00437         RealConstantEntry* getNamedRealConstantEntry(const String& name);
00441         IntConstantEntry* getNamedIntConstantEntry(const String& name);
00443         size_t getRealConstantCount(void) const { return mRealConstants.size(); }
00445         size_t getIntConstantCount(void) const { return mIntConstants.size(); }
00447         bool hasRealConstantParams(void) const { return !(mRealConstants.empty()); }
00449         bool hasIntConstantParams(void) const { return !(mIntConstants.empty()); }
00450 
00464         void setAutoConstant(size_t index, AutoConstantType acType, size_t extraInfo = 0);
00465         void setAutoConstantReal(size_t index, AutoConstantType acType, Real rData);
00470         void setConstantFromTime(size_t index, Real factor);
00471 
00473         void clearAutoConstants(void);
00474         typedef ConstVectorIterator<AutoConstantList> AutoConstantIterator;
00476         AutoConstantIterator getAutoConstantIterator(void) const;
00478         bool hasAutoConstants(void) const { return !(mAutoConstants.empty()); }
00480         void _updateAutoParamsNoLights(const AutoParamDataSource& source);
00482         void _updateAutoParamsLightsOnly(const AutoParamDataSource& source);
00483 
00495         void setAutoAddParamName(bool state) { mAutoAddParamName = state; }
00496 
00516         void setNamedConstant(const String& name, Real val);
00536         void setNamedConstant(const String& name, int val);
00541         void setNamedConstant(const String& name, const Vector4& vec);
00554         void setNamedConstant(const String& name, const Vector3& vec);
00559         void setNamedConstant(const String& name, const Matrix4& m);
00567         void setNamedConstant(const String& name, const Matrix4* m, size_t numEntries);
00588         void setNamedConstant(const String& name, const float *val, size_t count);
00609         void setNamedConstant(const String& name, const double *val, size_t count);
00614         void setNamedConstant(const String& name, const ColourValue& colour);
00615         
00636         void setNamedConstant(const String& name, const int *val, size_t count);
00637 
00652         void setNamedAutoConstant(const String& name, AutoConstantType acType, size_t extraInfo = 0);
00653 
00661         void setNamedConstantFromTime(const String& name, Real factor);
00663         void _mapParameterNameToIndex(const String& name, size_t index);
00664 
00666         size_t getParamIndex(const String& name);
00667 
00668 
00676         void setTransposeMatrices(bool val) { mTransposeMatrices = val; } 
00678         bool getTransposeMatrices(void) const { return mTransposeMatrices; } 
00679 
00683         void copyConstantsFrom(const GpuProgramParameters& source);
00684         
00685     };
00686 
00688     typedef SharedPtr<GpuProgramParameters> GpuProgramParametersSharedPtr;
00689 
00690     // Forward declaration 
00691     class GpuProgramPtr;
00692 
00702     class _OgreExport GpuProgram : public Resource
00703     {
00704     protected:
00706         class _OgreExport CmdType : public ParamCommand
00707         {
00708         public:
00709             String doGet(const void* target) const;
00710             void doSet(void* target, const String& val);
00711         };
00712         class _OgreExport CmdSyntax : public ParamCommand
00713         {
00714         public:
00715             String doGet(const void* target) const;
00716             void doSet(void* target, const String& val);
00717         };
00718         class _OgreExport CmdSkeletal : public ParamCommand
00719         {
00720         public:
00721             String doGet(const void* target) const;
00722             void doSet(void* target, const String& val);
00723         };
00724         // Command object for setting / getting parameters
00725         static CmdType msTypeCmd;
00726         static CmdSyntax msSyntaxCmd;
00727         static CmdSkeletal msSkeletalCmd;
00728     
00730         GpuProgramType mType;
00732         String mFilename;
00734         String mSource;
00736         bool mLoadFromFile;
00738         String mSyntaxCode;
00740         bool mSkeletalAnimation;
00742         GpuProgramParametersSharedPtr mDefaultParams;
00744         bool mPassSurfaceAndLightStates;
00745 
00754         void setupBaseParamDictionary(void);
00755 
00757         size_t calculateSize(void) const { return 0; } // TODO 
00758 
00760         void loadImpl(void);
00761     public:
00762 
00763         GpuProgram(ResourceManager* creator, const String& name, ResourceHandle handle,
00764             const String& group, bool isManual = false, ManualResourceLoader* loader = 0);
00765 
00766         virtual ~GpuProgram() {}
00767 
00772         virtual void setSourceFile(const String& filename);
00773 
00778         virtual void setSource(const String& source);
00779 
00781         virtual const String& getSyntaxCode(void) const { return mSyntaxCode; }
00782 
00784         virtual void setSyntaxCode(const String& syntax);
00785 
00787         virtual const String& getSourceFile(void) const { return mFilename; }
00789         virtual const String& getSource(void) const { return mSource; }
00791         virtual void setType(GpuProgramType t);
00793         virtual GpuProgramType getType(void) const { return mType; }
00794 
00799         virtual GpuProgram* _getBindingDelegate(void) { return this; }
00800 
00802         virtual bool isSupported(void) const;
00803 
00811         virtual GpuProgramParametersSharedPtr createParameters(void);
00812 
00819         virtual void setSkeletalAnimationIncluded(bool included) 
00820         { mSkeletalAnimation = included; }
00821 
00828         virtual bool isSkeletalAnimationIncluded(void) const { return mSkeletalAnimation; }
00829 
00840         virtual GpuProgramParametersSharedPtr getDefaultParameters(void);
00841 
00850         virtual void setSurfaceAndPassLightStates(bool state)
00851             { mPassSurfaceAndLightStates = state; }
00852 
00856         virtual bool getPassSurfaceAndLightStates(void) const { return mPassSurfaceAndLightStates; }
00857 
00858     protected:
00860         virtual void loadFromSource(void) = 0;
00861 
00862     };
00863 
00864 
00871     class _OgreExport GpuProgramPtr : public SharedPtr<GpuProgram> 
00872     {
00873     public:
00874         GpuProgramPtr() : SharedPtr<GpuProgram>() {}
00875         explicit GpuProgramPtr(GpuProgram* rep) : SharedPtr<GpuProgram>(rep) {}
00876         GpuProgramPtr(const GpuProgramPtr& r) : SharedPtr<GpuProgram>(r) {} 
00877         GpuProgramPtr(const ResourcePtr& r) : SharedPtr<GpuProgram>()
00878         {
00879             // lock & copy other mutex pointer
00880             OGRE_LOCK_MUTEX(*r.OGRE_AUTO_MUTEX_NAME)
00881             OGRE_COPY_AUTO_SHARED_MUTEX(r.OGRE_AUTO_MUTEX_NAME)
00882             pRep = static_cast<GpuProgram*>(r.getPointer());
00883             pUseCount = r.useCountPointer();
00884             if (pUseCount)
00885             {
00886                 ++(*pUseCount);
00887             }
00888         }
00889 
00891         GpuProgramPtr& operator=(const ResourcePtr& r)
00892         {
00893             if (pRep == static_cast<GpuProgram*>(r.getPointer()))
00894                 return *this;
00895             release();
00896             // lock & copy other mutex pointer
00897             OGRE_LOCK_MUTEX(*r.OGRE_AUTO_MUTEX_NAME)
00898             OGRE_COPY_AUTO_SHARED_MUTEX(r.OGRE_AUTO_MUTEX_NAME)
00899             pRep = static_cast<GpuProgram*>(r.getPointer());
00900             pUseCount = r.useCountPointer();
00901             if (pUseCount)
00902             {
00903                 ++(*pUseCount);
00904             }
00905             return *this;
00906         }
00908         GpuProgramPtr& operator=(const HighLevelGpuProgramPtr& r);
00909     };
00910 }
00911 
00912 #endif

Copyright © 2000-2005 by The OGRE Team
Last modified Sun Apr 10 23:21:16 2005