OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreHighLevelGpuProgram.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-2014 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 __HighLevelGpuProgram_H__
29 #define __HighLevelGpuProgram_H__
30 
31 #include "OgrePrerequisites.h"
32 #include "OgreGpuProgram.h"
33 
34 namespace Ogre {
35 
64  {
65  protected:
71  mutable bool mConstantDefsBuilt;
72 
74  virtual void loadHighLevel(void);
76  virtual void unloadHighLevel(void);
80  virtual void loadHighLevelImpl(void);
83  virtual void createLowLevelImpl(void) = 0;
85  virtual void unloadHighLevelImpl(void) = 0;
87  virtual void populateParameterNames(GpuProgramParametersSharedPtr params);
94  virtual void buildConstantDefinitions() const = 0;
95 
97  void loadImpl();
99  void unloadImpl();
100  public:
102  HighLevelGpuProgram(ResourceManager* creator, const String& name, ResourceHandle handle,
103  const String& group, bool isManual = false, ManualResourceLoader* loader = 0);
105 
106 
114  GpuProgramParametersSharedPtr createParameters(void);
116  GpuProgram* _getBindingDelegate(void) { return mAssemblerProgram.getPointer(); }
117 
122  const GpuNamedConstants& getConstantDefinitions() const;
123 
124  virtual size_t calculateSize(void) const;
125 
126 
127 
128 
129  };
133 }
134 #endif
bool mHighLevelLoaded
Whether the high-level program (and it's parameter defs) is loaded.
#define _OgreExport
Definition: OgrePlatform.h:255
Defines a program which runs on the GPU such as a vertex or fragment program.
Interface describing a manual resource loader.
Definition: OgreResource.h:498
GpuProgram * _getBindingDelegate(void)
Returns the GpuProgram which should be bound to the pipeline.
Struct collecting together the information for named constants.
unsigned long long int ResourceHandle
Definition: OgreResource.h:39
Defines a generic resource handler.
GpuProgramPtr mAssemblerProgram
The underlying assembler program.
_StringBase String
Definition: OgreCommon.h:53
Abstract base class representing a high-level program (a vertex or fragment program).
bool mConstantDefsBuilt
Have we built the name->index parameter map yet?