OgreGpuProgram.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __GpuProgram_H_
29 #define __GpuProgram_H_
30 
31 // Precompiler options
32 #include "OgrePrerequisites.h"
33 #include "OgreResource.h"
34 #include "OgreSharedPtr.h"
35 #include "OgreIteratorWrappers.h"
36 #include "OgreSerializer.h"
37 #include "OgreRenderOperation.h"
38 #include "OgreGpuProgramParams.h"
39 #include "OgreHeaderPrefix.h"
40 
41 namespace Ogre {
42 
51  {
58  };
59 
70  {
71  protected:
74  {
75  public:
76  String doGet(const void* target) const;
77  void doSet(void* target, const String& val);
78  };
80  {
81  public:
82  String doGet(const void* target) const;
83  void doSet(void* target, const String& val);
84  };
86  {
87  public:
88  String doGet(const void* target) const;
89  void doSet(void* target, const String& val);
90  };
92  {
93  public:
94  String doGet(const void* target) const;
95  void doSet(void* target, const String& val);
96  };
98  {
99  public:
100  String doGet(const void* target) const;
101  void doSet(void* target, const String& val);
102  };
104  {
105  public:
106  String doGet(const void* target) const;
107  void doSet(void* target, const String& val);
108  };
110  {
111  public:
112  String doGet(const void* target) const;
113  void doSet(void* target, const String& val);
114  };
116  {
117  public:
118  String doGet(const void* target) const;
119  void doSet(void* target, const String& val);
120  };
121  // Command object for setting / getting parameters
127  static CmdVTF msVTFCmd;
177 
178 
187  void setupBaseParamDictionary(void);
188 
191  bool isRequiredCapabilitiesSupported(void) const;
192 
194  void loadImpl(void);
195 
197  void createParameterMappingStructures(bool recreateIfExists = true) const;
199  void createLogicalParameterMappingStructures(bool recreateIfExists = true) const;
201  void createNamedParameterMappingStructures(bool recreateIfExists = true) const;
202 
203  public:
204 
205  GpuProgram(ResourceManager* creator, const String& name, ResourceHandle handle,
206  const String& group, bool isManual = false, ManualResourceLoader* loader = 0);
207 
208  virtual ~GpuProgram() {}
209 
214  virtual void setSourceFile(const String& filename);
215 
220  virtual void setSource(const String& source);
221 
223  virtual const String& getSyntaxCode(void) const { return mSyntaxCode; }
224 
226  virtual void setSyntaxCode(const String& syntax);
227 
229  virtual const String& getSourceFile(void) const { return mFilename; }
231  virtual const String& getSource(void) const { return mSource; }
233  virtual void setType(GpuProgramType t);
235  virtual GpuProgramType getType(void) const { return mType; }
236 
241  virtual GpuProgram* _getBindingDelegate(void) { return this; }
242 
244  virtual bool isSupported(void) const;
245 
253  virtual GpuProgramParametersSharedPtr createParameters(void);
254 
261  virtual void setSkeletalAnimationIncluded(bool included)
262  { mSkeletalAnimation = included; }
263 
270  virtual bool isSkeletalAnimationIncluded(void) const { return mSkeletalAnimation; }
271 
278  virtual void setMorphAnimationIncluded(bool included)
279  { mMorphAnimation = included; }
280 
288  virtual void setPoseAnimationIncluded(ushort poseCount)
289  { mPoseAnimation = poseCount; }
290 
297  virtual bool isMorphAnimationIncluded(void) const { return mMorphAnimation; }
298 
305  virtual bool isPoseAnimationIncluded(void) const { return mPoseAnimation > 0; }
309  virtual ushort getNumberOfPosesIncluded(void) const { return mPoseAnimation; }
313  virtual void setVertexTextureFetchRequired(bool r) { mVertexTextureFetch = r; }
317  virtual bool isVertexTextureFetchRequired(void) const { return mVertexTextureFetch; }
318 
322  virtual void setAdjacencyInfoRequired(bool r) { mNeedsAdjacencyInfo = r; }
326  virtual bool isAdjacencyInfoRequired(void) const { return mNeedsAdjacencyInfo; }
327 
338  virtual GpuProgramParametersSharedPtr getDefaultParameters(void);
339 
342  virtual bool hasDefaultParameters(void) const { return !mDefaultParams.isNull(); }
343 
350  virtual bool getPassSurfaceAndLightStates(void) const { return false; }
351 
360  virtual bool getPassFogStates(void) const { return true; }
361 
368  virtual bool getPassTransformStates(void) const { return false; }
369 
373  virtual const String& getLanguage(void) const;
374 
377  virtual bool hasCompileError(void) const { return mCompileError; }
378 
381  virtual void resetCompileError(void) { mCompileError = false; }
382 
391  virtual void setManualNamedConstants(const GpuNamedConstants& namedConstants);
392 
394  virtual const GpuNamedConstants& getNamedConstants() const { return *mConstantDefs.get(); }
395 
406  virtual void setManualNamedConstantsFile(const String& paramDefFile);
407 
411  virtual const String& getManualNamedConstantsFile() const { return mManualNamedConstantsFile; }
418  virtual const GpuNamedConstants& getConstantDefinitions() const { return *mConstantDefs.get(); }
419 
421  virtual size_t calculateSize(void) const;
422 
423  protected:
425  virtual void loadFromSource(void) = 0;
426 
427  };
430 }
431 
432 #include "OgreHeaderSuffix.h"
433 
434 #endif

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Oct 16 2013 14:35:42