OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreGLSLProgramCommon.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 __GLSLProgramCommon_H__
29 #define __GLSLProgramCommon_H__
30 
32 #include "OgreGpuProgram.h"
36 
37 namespace Ogre {
38 
39  class GLSLGpuProgram;
40 
42  struct GLUniformReference
43  {
45  GLint mLocation;
49  const GpuConstantDefinition* mConstantDef;
50  };
51 
53  typedef GLUniformReferenceList::iterator GLUniformReferenceIterator;
55  typedef GLUniformBufferList::iterator GLUniformBufferIterator;
56 
62  {
63  protected:
66 
69 
84 
90  GLint mLinked;
95 
97  void buildGLUniformReferences(void);
99 
101  GLint mCustomAttributesIndexes[VES_COUNT][OGRE_MAX_TEXTURE_COORD_SETS];
103 #define NULL_CUSTOM_ATTRIBUTES_INDEX -2
104 #define NOT_FOUND_CUSTOM_ATTRIBUTES_INDEX -1
106 
107  Ogre::String getCombinedName(void);
109  void getMicrocodeFromCache(void);
111  virtual void compileAndLink(void) = 0;
113  virtual void _useProgram(void) = 0;
114 
117 
118  VertexElementSemantic getAttributeSemanticEnum(String type);
119  const char * getAttributeSemanticString(VertexElementSemantic semantic);
120 
121  public:
123  GLSLProgramCommon(GLSLGpuProgram* vertexProgram, GLSLGpuProgram* geometryProgram, GLSLGpuProgram* fragmentProgram, GLSLGpuProgram* hullProgram, GLSLGpuProgram* domainProgram, GLSLGpuProgram* computeProgram);
124  virtual ~GLSLProgramCommon(void);
125 
128  virtual void activate(void) = 0;
129 
133  virtual void updateUniforms(GpuProgramParametersSharedPtr params, uint16 mask, GpuProgramType fromProgType) = 0;
137  virtual void updateUniformBlocks(GpuProgramParametersSharedPtr params, uint16 mask, GpuProgramType fromProgType) = 0;
141  virtual void updatePassIterationUniforms(GpuProgramParametersSharedPtr params) = 0;
143  virtual void extractLayoutQualifiers(void);
145  GLuint getGLProgramHandle(void) const { return mGLProgramHandle; }
152  void setSkeletalAnimationIncluded(bool included) { mSkeletalAnimation = included; }
153 
160  bool isSkeletalAnimationIncluded(void) const { return mSkeletalAnimation; }
161 
163  virtual GLint getAttributeIndex(VertexElementSemantic semantic, uint index);
165  bool isAttributeValid(VertexElementSemantic semantic, uint index);
166 
167  GLSLGpuProgram* getVertexProgram() const { return mVertexProgram; }
168  GLSLGpuProgram* getFragmentProgram() const { return mFragmentProgram; }
169  GLSLGpuProgram* getGeometryProgram() const { return mGeometryProgram; }
170  GLSLGpuProgram* getHullProgram() const { return mHullProgram; }
171  GLSLGpuProgram* getDomainProgram() const { return mDomainProgram; }
172  GLSLGpuProgram* getComputeProgram() const { return mComputeProgram; }
173  GL3PlusVertexArrayObject* getVertexArrayObject() { return mVertexArrayObject; }
174  };
175 }
176 
177 #endif // __GLSLProgramCommon_H__
GLSLGpuProgram * mVertexProgram
Linked vertex program.
GLint mLinked
Flag indicating that the program or pipeline object has been successfully linked. ...
GLSLGpuProgram * getFragmentProgram() const
std::vector< GLUniformReference, A > type
GLSLGpuProgram * getDomainProgram() const
const GpuConstantDefinition * mConstantDef
The constant definition it relates to.
GpuProgramType
Enumerates the types of programs which can run on the GPU.
GLUniformReferenceList mGLUniformReferences
Container of uniform references that are active in the program object.
VertexElementSemantic
Vertex element semantics, used to identify the meaning of vertex buffer contents. ...
GLSLGpuProgram * mDomainProgram
Linked domain(evaluation) program.
GLSL low level compiled shader object - this class is used to get at the linked program object and pr...
GLSLGpuProgram * getComputeProgram() const
GLSLGpuProgram * getVertexProgram() const
void setSkeletalAnimationIncluded(bool included)
Sets whether the linked program includes the required instructions to perform skeletal animation...
set< GLuint >::type AttributeSet
GL3PlusVertexArrayObject * getVertexArrayObject()
Specialisation of VertexDeclaration for OpenGL Vertex Array Object usage.
#define OGRE_MAX_TEXTURE_COORD_SETS
Define number of texture coordinate sets allowed per vertex.
Definition: OgreConfig.h:68
GLuint getGLProgramHandle(void) const
Get the GL Handle for the program object.
vector< HardwareUniformBufferSharedPtr >::type GLUniformBufferList
GL3PlusVertexArrayObject * mVertexArrayObject
GL handle for the vertex array object.
GLUniformBufferList::iterator GLUniformBufferIterator
GLUniformReferenceList::iterator GLUniformReferenceIterator
GLSLGpuProgram * mComputeProgram
Linked compute program.
SemanticToStringMap mSemanticTypeMap
GLSLGpuProgram * mHullProgram
Linked hull(control) program.
GLSLGpuProgram * mFragmentProgram
Linked fragment program.
#define _OgreGL3PlusExport
bool mUniformRefsBuilt
Flag to indicate that uniform references have already been built.
GLUniformBufferList mGLUniformBufferReferences
Container of uniform buffer references that are active in the program object.
GLSLGpuProgram * getGeometryProgram() const
GLSLGpuProgram * getHullProgram() const
vector< GLUniformReference >::type GLUniformReferenceList
bool mTriedToLinkAndFailed
Flag indicating that the program or pipeline object has tried to link and failed. ...
C++ encapsulation of GLSL Program Object.
_StringBase String
Definition: OgreCommon.h:53
The number of VertexElementSemantic elements (note - the first value VES_POSITION is 1) ...
unsigned short uint16
Definition: OgrePlatform.h:421
bool isSkeletalAnimationIncluded(void) const
Returns whether the linked program includes the required instructions to perform skeletal animation...
GpuProgramType mSourceProgType
Which type of program params will this value come from?
GLSLGpuProgram * mGeometryProgram
Linked geometry program.
GLuint mGLProgramHandle
GL handle for the program object.
unsigned int uint
bool mSkeletalAnimation
Flag indicating skeletal animation is being performed.
map< String, VertexElementSemantic >::type SemanticToStringMap