/usr/include/OGRE/OgreGpuProgramManager.h is in libogre-dev 1.7.4-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 | /*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
Copyright (c) 2000-2011 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __GpuProgramManager_H_
#define __GpuProgramManager_H_
// Precompiler options
#include "OgrePrerequisites.h"
#include "OgreResourceManager.h"
#include "OgreException.h"
#include "OgreGpuProgram.h"
#include "OgreSingleton.h"
namespace Ogre {
/** \addtogroup Core
* @{
*/
/** \addtogroup Resources
* @{
*/
class _OgreExport GpuProgramManager : public ResourceManager, public Singleton<GpuProgramManager>
{
public:
typedef set<String>::type SyntaxCodes;
typedef map<String, GpuSharedParametersPtr>::type SharedParametersMap;
protected:
SharedParametersMap mSharedParametersMap;
/// Specialised create method with specific parameters
virtual Resource* createImpl(const String& name, ResourceHandle handle,
const String& group, bool isManual, ManualResourceLoader* loader,
GpuProgramType gptype, const String& syntaxCode) = 0;
public:
GpuProgramManager();
virtual ~GpuProgramManager();
/** Loads a GPU program from a file of assembly.
@remarks
This method creates a new program of the type specified as the second parameter.
As with all types of ResourceManager, this class will search for the file in
all resource locations it has been configured to look in.
@param name The name of the GpuProgram
@param groupName The name of the resource group
@param filename The file to load
@param gptype The type of program to create
@param syntaxCode The name of the syntax to be used for this program e.g. arbvp1, vs_1_1
*/
virtual GpuProgramPtr load(const String& name, const String& groupName,
const String& filename, GpuProgramType gptype,
const String& syntaxCode);
/** Loads a GPU program from a string of assembly code.
@remarks
The assembly code must be compatible with this manager - call the
getSupportedSyntax method for details of the supported syntaxes
@param name The identifying name to give this program, which can be used to
retrieve this program later with getByName.
@param groupName The name of the resource group
@param code A string of assembly code which will form the program to run
@param gptype The type of program to create.
@param syntaxCode The name of the syntax to be used for this program e.g. arbvp1, vs_1_1
*/
virtual GpuProgramPtr loadFromString(const String& name, const String& groupName,
const String& code, GpuProgramType gptype,
const String& syntaxCode);
/** Returns the syntaxes that this manager supports. */
virtual const SyntaxCodes& getSupportedSyntax(void) const;
/** Returns whether a given syntax code (e.g. "ps_1_3", "fp20", "arbvp1") is supported. */
virtual bool isSyntaxSupported(const String& syntaxCode) const;
/** Creates a new GpuProgramParameters instance which can be used to bind
parameters to your programs.
@remarks
Program parameters can be shared between multiple programs if you wish.
*/
virtual GpuProgramParametersSharedPtr createParameters(void);
/** Create a new, unloaded GpuProgram from a file of assembly.
@remarks
Use this method in preference to the 'load' methods if you wish to define
a GpuProgram, but not load it yet; useful for saving memory.
@par
This method creates a new program of the type specified as the second parameter.
As with all types of ResourceManager, this class will search for the file in
all resource locations it has been configured to look in.
@param name The name of the program
@param groupName The name of the resource group
@param filename The file to load
@param syntaxCode The name of the syntax to be used for this program e.g. arbvp1, vs_1_1
@param gptype The type of program to create
*/
virtual GpuProgramPtr createProgram(const String& name,
const String& groupName, const String& filename,
GpuProgramType gptype, const String& syntaxCode);
/** Create a GPU program from a string of assembly code.
@remarks
Use this method in preference to the 'load' methods if you wish to define
a GpuProgram, but not load it yet; useful for saving memory.
@par
The assembly code must be compatible with this manager - call the
getSupportedSyntax method for details of the supported syntaxes
@param name The identifying name to give this program, which can be used to
retrieve this program later with getByName.
@param groupName The name of the resource group
@param code A string of assembly code which will form the program to run
@param gptype The type of program to create.
@param syntaxCode The name of the syntax to be used for this program e.g. arbvp1, vs_1_1
*/
virtual GpuProgramPtr createProgramFromString(const String& name,
const String& groupName, const String& code,
GpuProgramType gptype, const String& syntaxCode);
/** General create method, using specific create parameters
instead of name / value pairs.
*/
virtual ResourcePtr create(const String& name, const String& group,
GpuProgramType gptype, const String& syntaxCode, bool isManual = false,
ManualResourceLoader* loader = 0);
/** Overrides the standard ResourceManager getByName method.
@param name The name of the program to retrieve
@param preferHighLevelPrograms If set to true (the default), high level programs will be
returned in preference to low-level programs.
*/
ResourcePtr getByName(const String& name, bool preferHighLevelPrograms = true);
/** Create a new set of shared parameters, which can be used across many
GpuProgramParameters objects of different structures.
@param name The name to give the shared parameters so you can refer to them
later.
*/
virtual GpuSharedParametersPtr createSharedParameters(const String& name);
/** Retrieve a set of shared parameters, which can be used across many
GpuProgramParameters objects of different structures.
*/
virtual GpuSharedParametersPtr getSharedParameters(const String& name) const;
/** Get (const) access to the available shared parameter sets.
*/
virtual const SharedParametersMap& getAvailableSharedParameters() const;
/** Override standard Singleton retrieval.
@remarks
Why do we do this? Well, it's because the Singleton
implementation is in a .h file, which means it gets compiled
into anybody who includes it. This is needed for the
Singleton template to work, but we actually only want it
compiled into the implementation of the class based on the
Singleton, not all of them. If we don't change this, we get
link errors when trying to use the Singleton-based class from
an outside dll.
@par
This method just delegates to the template version anyway,
but the implementation stays in this single compilation unit,
preventing link errors.
*/
static GpuProgramManager& getSingleton(void);
/** Override standard Singleton retrieval.
@remarks
Why do we do this? Well, it's because the Singleton
implementation is in a .h file, which means it gets compiled
into anybody who includes it. This is needed for the
Singleton template to work, but we actually only want it
compiled into the implementation of the class based on the
Singleton, not all of them. If we don't change this, we get
link errors when trying to use the Singleton-based class from
an outside dll.
@par
This method just delegates to the template version anyway,
but the implementation stays in this single compilation unit,
preventing link errors.
*/
static GpuProgramManager* getSingletonPtr(void);
};
/** @} */
/** @} */
}
#endif
|