OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreHighLevelGpuProgramManager.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 __HighLevelGpuProgramManager_H__
29 #define __HighLevelGpuProgramManager_H__
30 
31 #include "OgrePrerequisites.h"
32 #include "OgreResourceManager.h"
33 #include "OgreSingleton.h"
34 #include "OgreGpuProgram.h"
35 #include "OgreHeaderPrefix.h"
36 
37 namespace Ogre {
38 
47  {
48  public:
50  virtual ~HighLevelGpuProgramFactory();
52  virtual const String& getLanguage(void) const = 0;
53  virtual HighLevelGpuProgram* create(ResourceManager* creator,
54  const String& name, ResourceHandle handle,
55  const String& group, bool isManual, ManualResourceLoader* loader) = 0;
56  virtual void destroy(HighLevelGpuProgram* prog) = 0;
57  };
58 
73  : public ResourceManager, public Singleton<HighLevelGpuProgramManager>
74  {
75  public:
77  protected:
80 
85 
86  HighLevelGpuProgramFactory* getFactory(const String& language);
87 
89  Resource* createImpl(const String& name, ResourceHandle handle,
90  const String& group, bool isManual, ManualResourceLoader* loader,
91  const NameValuePairList* createParams);
92  public:
96  void addFactory(HighLevelGpuProgramFactory* factory);
98  void removeFactory(HighLevelGpuProgramFactory* factory);
99 
101  bool isLanguageSupported(const String& lang);
102 
106 
118  HighLevelGpuProgramPtr createProgram(
119  const String& name, const String& groupName,
120  const String& language, GpuProgramType gptype);
121 
137  static HighLevelGpuProgramManager& getSingleton(void);
153  static HighLevelGpuProgramManager* getSingletonPtr(void);
154 
155 
156  };
160 }
161 
162 #include "OgreHeaderSuffix.h"
163 
164 #endif
#define _OgreExport
Definition: OgrePlatform.h:255
map< String, String >::type NameValuePairList
Name / value parameter pair (first = name, second = value)
Definition: OgreCommon.h:580
Template class for creating single-instance global classes.
Definition: OgreSingleton.h:64
GpuProgramType
Enumerates the types of programs which can run on the GPU.
static String AUTODETECT_RESOURCE_GROUP_NAME
Special resource group name which causes resource group to be automatically determined based on searc...
Interface describing a manual resource loader.
Definition: OgreResource.h:498
HighLevelGpuProgramFactory * mNullFactory
Factory for dealing with programs for languages we can't create.
HighLevelGpuProgramFactory * mUnifiedFactory
Factory for unified high-level programs.
This ResourceManager manages high-level vertex and fragment programs.
Interface definition for factories of HighLevelGpuProgram.
FactoryMap mFactories
Factories capable of creating HighLevelGpuProgram instances.
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Abstract class representing a loadable resource (e.g.
Definition: OgreResource.h:77
map< String, HighLevelGpuProgramFactory * >::type FactoryMap
unsigned long long int ResourceHandle
Definition: OgreResource.h:39
Defines a generic resource handler.
_StringBase String
Definition: OgreCommon.h:53
Abstract base class representing a high-level program (a vertex or fragment program).