OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreGpuProgramUsage.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 __GpuProgramUsage_H__
29 #define __GpuProgramUsage_H__
30 
31 #include "OgrePrerequisites.h"
32 #include "OgreGpuProgram.h"
33 #include "OgreHeaderPrefix.h"
34 
35 namespace Ogre
36 {
37  class Pass;
38 
74  {
75  protected:
80 
83 
86 
87  void recreateParameters();
88 
89  public:
93  GpuProgramUsage(GpuProgramType gptype, Pass* parent);
94 
96  GpuProgramUsage(const GpuProgramUsage& rhs, Pass* newparent);
97 
98  ~GpuProgramUsage();
99 
101  GpuProgramType getType(void) const { return mType; }
102 
113  void setProgramName(const String& name, bool resetParams = true);
120  void setProgram(GpuProgramPtr& prog);
122  const GpuProgramPtr& getProgram() const { return mProgram; }
124  const String& getProgramName(void) const { return mProgram->getName(); }
125 
131  void setParameters(GpuProgramParametersSharedPtr params);
134  GpuProgramParametersSharedPtr getParameters(void);
135 
137  void _load(void);
139  void _unload(void);
140 
141  size_t calculateSize(void) const;
142 
143  // Resource Listener
144  void unloadingComplete(Resource* prog);
145  void loadingComplete(Resource* prog);
146 
147  };
150 }
151 
152 #include "OgreHeaderSuffix.h"
153 
154 #endif
GpuProgramParametersSharedPtr mParameters
Program parameters.
#define _OgreExport
Definition: OgrePlatform.h:255
GpuProgramType
Enumerates the types of programs which can run on the GPU.
bool mRecreateParams
Whether to recreate parameters next load.
const String & getProgramName(void) const
Gets the program being used.
Class defining a single pass of a Technique (of a Material), i.e.
Definition: OgrePass.h:78
const GpuProgramPtr & getProgram() const
Gets the program being used.
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
This class makes the usage of a vertex and fragment programs (low-level or high-level), with a given set of parameters, explicit.
Abstract class representing a loadable resource (e.g.
Definition: OgreResource.h:77
GpuProgramPtr mProgram
The program link.
_StringBase String
Definition: OgreCommon.h:53
GpuProgramType getType(void) const
Gets the type of program we're trying to link to.