OGRE  1.9.0
OgreHighLevelGpuProgramManager.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2014 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE 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 "OgreException.h"
36#include "OgreHeaderPrefix.h"
37
38namespace Ogre {
39
48 {
49 public:
53 virtual const String& getLanguage(void) const = 0;
55 const String& name, ResourceHandle handle,
56 const String& group, bool isManual, ManualResourceLoader* loader) = 0;
57 virtual void destroy(HighLevelGpuProgram* prog) = 0;
58 };
73 : public ResourceManager, public Singleton<HighLevelGpuProgramManager>
74 {
75 public:
77 protected:
80
85
87
90 const String& group, bool isManual, ManualResourceLoader* loader,
91 const NameValuePairList* createParams);
92 public:
99
101 bool isLanguageSupported(const String& lang);
102
105 HighLevelGpuProgramPtr getByName(const String& name, const String& groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME);
106
119 const String& name, const String& groupName,
120 const String& language, GpuProgramType gptype);
121
154
155
156 };
160}
161
162#include "OgreHeaderSuffix.h"
163
164#endif
#define _OgreExport
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Interface definition for factories of HighLevelGpuProgram.
virtual const String & getLanguage(void) const =0
Get the name of the language this factory creates programs for.
virtual HighLevelGpuProgram * create(ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader)=0
virtual void destroy(HighLevelGpuProgram *prog)=0
This ResourceManager manages high-level vertex and fragment programs.
HighLevelGpuProgramPtr getByName(const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
Get a resource by name.
FactoryMap mFactories
Factories capable of creating HighLevelGpuProgram instances.
map< String, HighLevelGpuProgramFactory * >::type FactoryMap
static HighLevelGpuProgramManager & getSingleton(void)
Override standard Singleton retrieval.
void removeFactory(HighLevelGpuProgramFactory *factory)
Remove a factory object for high-level programs of a given language.
HighLevelGpuProgramFactory * mUnifiedFactory
Factory for unified high-level programs.
HighLevelGpuProgramFactory * mNullFactory
Factory for dealing with programs for languages we can't create.
HighLevelGpuProgramFactory * getFactory(const String &language)
bool isLanguageSupported(const String &lang)
Returns whether a given high-level language is supported.
static HighLevelGpuProgramManager * getSingletonPtr(void)
Override standard Singleton retrieval.
HighLevelGpuProgramPtr createProgram(const String &name, const String &groupName, const String &language, GpuProgramType gptype)
Create a new, unloaded HighLevelGpuProgram.
void addFactory(HighLevelGpuProgramFactory *factory)
Add a new factory object for high-level programs of a given language.
Resource * createImpl(const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, const NameValuePairList *createParams)
Create a new resource instance compatible with this manager (no custom parameters are populated at th...
Abstract base class representing a high-level program (a vertex or fragment program).
Interface describing a manual resource loader.
Defines a generic resource handler.
Abstract class representing a loadable resource (e.g.
Template class for creating single-instance global classes.
map< String, String >::type NameValuePairList
Name / value parameter pair (first = name, second = value)
Definition OgreCommon.h:550
GpuProgramType
Enumerates the types of programs which can run on the GPU.
unsigned long long int ResourceHandle
_StringBase String
std::map< K, V, P, A > type