OGRE  1.9.0
OgreGpuProgramUsage.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 __GpuProgramUsage_H__
29#define __GpuProgramUsage_H__
30
31#include "OgrePrerequisites.h"
32#include "OgreGpuProgram.h"
33#include "OgreHeaderPrefix.h"
34
35namespace Ogre
36{
37 class Pass;
38
74 {
75 protected:
80
83
86
88
89 public:
94
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
#define _OgreExport
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),...
const String & getProgramName(void) const
Gets the program being used.
void unloadingComplete(Resource *prog)
Called whenever the resource has been unloaded.
GpuProgramParametersSharedPtr getParameters(void)
Gets the parameters being used here.
void setProgramName(const String &name, bool resetParams=true)
Sets the name of the program to use.
bool mRecreateParams
Whether to recreate parameters next load.
void setProgram(GpuProgramPtr &prog)
Sets the program to use.
GpuProgramUsage(GpuProgramType gptype, Pass *parent)
Default constructor.
void setParameters(GpuProgramParametersSharedPtr params)
Sets the program parameters that should be used; because parameters can be shared between multiple us...
size_t calculateSize(void) const
void _load(void)
Load this usage (and ensure program is loaded)
GpuProgramPtr mProgram
The program link.
const GpuProgramPtr & getProgram() const
Gets the program being used.
GpuProgramUsage(const GpuProgramUsage &rhs, Pass *newparent)
Copy constructor.
GpuProgramType getType(void) const
Gets the type of program we're trying to link to.
GpuProgramParametersSharedPtr mParameters
Program parameters.
void _unload(void)
Unload this usage.
void loadingComplete(Resource *prog)
Called whenever the resource finishes loading.
Class defining a single pass of a Technique (of a Material), i.e.
Definition OgrePass.h:81
Abstract class representing a loadable resource (e.g.
virtual const String & getName(void) const
Gets resource name.
GpuProgramType
Enumerates the types of programs which can run on the GPU.
_StringBase String