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-2013 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 
88 
89  public:
94 
96  GpuProgramUsage(const GpuProgramUsage& rhs, Pass* newparent);
97 
99 
101  GpuProgramType getType(void) const { return mType; }
102 
113  void setProgramName(const String& name, bool resetParams = true);
122  const GpuProgramPtr& getProgram() const { return mProgram; }
124  const String& getProgramName(void) const { return mProgram->getName(); }
125 
135 
137  void _load(void);
139  void _unload(void);
140 
141  size_t calculateSize(void) const;
142 
143  // Resource Listener
146 
147  };
150 }
151 
152 #include "OgreHeaderSuffix.h"
153 
154 #endif
OgreHeaderSuffix.h
Ogre::GpuProgramUsage::~GpuProgramUsage
~GpuProgramUsage()
Ogre::Resource::getName
virtual const String & getName(void) const
Gets resource name.
Definition: OgreResource.h:312
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:59
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::GpuProgramUsage::getProgramName
const String & getProgramName(void) const
Gets the program being used.
Definition: OgreGpuProgramUsage.h:124
Ogre::GpuProgramUsage::setParameters
void setParameters(GpuProgramParametersSharedPtr params)
Sets the program parameters that should be used; because parameters can be shared between multiple us...
Ogre::GpuProgramUsage::GpuProgramUsage
GpuProgramUsage(const GpuProgramUsage &rhs, Pass *newparent)
Copy constructor.
Ogre::GpuProgramUsage::GpuProgramUsage
GpuProgramUsage(GpuProgramType gptype, Pass *parent)
Default constructor.
Ogre::GpuProgramUsage::loadingComplete
void loadingComplete(Resource *prog)
Called whenever the resource finishes loading.
Ogre::GpuProgramUsage::getType
GpuProgramType getType(void) const
Gets the type of program we're trying to link to.
Definition: OgreGpuProgramUsage.h:101
Ogre::GpuProgramUsage::mRecreateParams
bool mRecreateParams
Whether to recreate parameters next load.
Definition: OgreGpuProgramUsage.h:85
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::Pass
Class defining a single pass of a Technique (of a Material), i.e.
Definition: OgrePass.h:81
Ogre::GpuProgramUsage::recreateParameters
void recreateParameters()
Ogre::GpuProgramUsage::getProgram
const GpuProgramPtr & getProgram() const
Gets the program being used.
Definition: OgreGpuProgramUsage.h:122
Ogre::GpuProgramType
GpuProgramType
Enumerates the types of programs which can run on the GPU.
Definition: OgreGpuProgram.h:51
Ogre::GpuProgramUsage::setProgramName
void setProgramName(const String &name, bool resetParams=true)
Sets the name of the program to use.
Ogre::GpuProgramUsage::mType
GpuProgramType mType
Definition: OgreGpuProgramUsage.h:76
OgreHeaderPrefix.h
OgrePrerequisites.h
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::GpuProgramUsage::mProgram
GpuProgramPtr mProgram
The program link.
Definition: OgreGpuProgramUsage.h:79
Ogre::SharedPtr< GpuProgram >
Ogre::Resource
Abstract class representing a loadable resource (e.g.
Definition: OgreResource.h:80
Ogre::GpuProgramUsage::getParameters
GpuProgramParametersSharedPtr getParameters(void)
Gets the parameters being used here.
Ogre::GpuProgramUsage::mParameters
GpuProgramParametersSharedPtr mParameters
Program parameters.
Definition: OgreGpuProgramUsage.h:82
OgreGpuProgram.h
Ogre::Resource::Listener
Definition: OgreResource.h:84
Ogre::GpuProgramUsage::unloadingComplete
void unloadingComplete(Resource *prog)
Called whenever the resource has been unloaded.
Ogre::GpuProgramUsage::_unload
void _unload(void)
Unload this usage.
Ogre::GpuProgramUsage
This class makes the usage of a vertex and fragment programs (low-level or high-level),...
Definition: OgreGpuProgramUsage.h:74
Ogre::GpuProgramUsage::calculateSize
size_t calculateSize(void) const
Ogre::GpuProgramUsage::_load
void _load(void)
Load this usage (and ensure program is loaded)
Ogre::GpuProgramUsage::setProgram
void setProgram(GpuProgramPtr &prog)
Sets the program to use.
Ogre::GpuProgramUsage::mParent
Pass * mParent
Definition: OgreGpuProgramUsage.h:77

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.