openscenegraph
osg/Program
Go to the documentation of this file.
1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
2 * Copyright (C) 2003-2005 3Dlabs Inc. Ltd.
3 * Copyright (C) 2004-2005 Nathan Cournia
4 * Copyright (C) 2008 Zebra Imaging
5 * Copyright (C) 2010 Vires Simulationstechnologie GmbH
6 *
7 * This application is open source and may be redistributed and/or modified
8 * freely and without restriction, both in commercial and non commercial
9 * applications, as long as this copyright notice is maintained.
10 *
11 * This application is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14*/
15
16/* file: include/osg/Program
17 * author: Mike Weiblen 2008-01-02
18 * Holger Helmich 2010-10-21
19*/
20
21#ifndef OSG_PROGRAM
22#define OSG_PROGRAM 1
23
24#include <string>
25#include <vector>
26#include <map>
27
28#include <osg/buffered_value>
29#include <osg/ref_ptr>
30#include <osg/Uniform>
31#include <osg/Shader>
32#include <osg/StateAttribute>
33
34namespace osg {
35
36class State;
37
38
40
52{
53 public:
55
58
60
62 virtual int compare(const osg::StateAttribute& sa) const;
63
66 virtual void apply(osg::State& state) const;
67
69 virtual void setThreadSafeRefUnref(bool threadSafe);
70
72 virtual void compileGLObjects(osg::State& state) const;
73
75 virtual void resizeGLObjectBuffers(unsigned int maxSize);
76
80 virtual void releaseGLObjects(osg::State* state=0) const;
81
84
87 bool addShader( Shader* shader );
88
89 template<class T> bool addShader( const ref_ptr<T>& shader ) { return addShader(shader.get()); }
90
91 unsigned int getNumShaders() const { return static_cast<unsigned int>(_shaderList.size()); }
92
93 Shader* getShader( unsigned int i ) { return _shaderList[i].get(); }
94 const Shader* getShader( unsigned int i ) const { return _shaderList[i].get(); }
95
98 bool removeShader( Shader* shader );
99
100 template<class T> bool removeShader( const ref_ptr<T>& shader ) { return removeShader(shader.get()); }
101
103 void setParameter( GLenum pname, GLint value );
104 GLint getParameter( GLenum pname ) const;
105
107 void addBindAttribLocation( const std::string& name, GLuint index );
108
110 void removeBindAttribLocation( const std::string& name );
111
113 void addBindFragDataLocation( const std::string& name, GLuint index );
114
116 void removeBindFragDataLocation( const std::string& name );
117
122 void addBindUniformBlock(const std::string& name, GLuint index);
123
125 void removeBindUniformBlock(const std::string& name);
126
128 void removeTransformFeedBackVarying(const std::string& name)
129 {
130 for(std::vector<std::string>::iterator i=_feedbackout.begin(); i!=_feedbackout.end(); i++)
131 {
132 if (*i == name) {_feedbackout.erase(i);break; }
133 }
134 }
135
137 void addTransformFeedBackVarying(const std::string& outname)
138 {
139 _feedbackout.push_back(outname);
140 }
141
143 inline unsigned int getNumTransformFeedBackVaryings() const { return _feedbackout.size(); }
144
146 inline const std::string& getTransformFeedBackVarying(unsigned int i) const { return _feedbackout[i]; }
147
149 void setTransformFeedBackMode(GLenum e) {_feedbackmode=e;}
150
152 GLenum getTransformFeedBackMode() const {return _feedbackmode;}
153
155 void setShaderDefines(const ShaderDefines& shaderDefs) { _shaderDefines = shaderDefs; }
156 ShaderDefines& getShaderDefines() { return _shaderDefines; }
157 const ShaderDefines& getShaderDefines() const { return _shaderDefines; }
158
159
160
169 {
170 public:
171
173
176
178
180 void allocate(unsigned int size);
181
183 void assign(unsigned int size, const unsigned char* data);
184
186 void setFormat(GLenum format) {_format = format;}
187
189 GLenum getFormat() const {return _format;}
190
192 unsigned int getSize() const { return static_cast<unsigned int>(_data.size()); }
193
195 unsigned char* getData() { return _data.empty() ? 0 : &(_data.front()); }
196
198 const unsigned char* getData() const { return _data.empty() ? 0 : &(_data.front()); }
199
200 protected:
201 std::vector<unsigned char> _data;
202 GLenum _format;
203 };
204
205
209 void setProgramBinary(ProgramBinary* programBinary) { _programBinary = programBinary; }
210
212 ProgramBinary* getProgramBinary() { return _programBinary.get(); }
213
215 const ProgramBinary* getProgramBinary() const { return _programBinary.get(); }
216
217 typedef std::map<std::string,GLuint> AttribBindingList;
218 typedef std::map<std::string,GLuint> FragDataBindingList;
219 typedef std::map<std::string,GLuint> UniformBlockBindingList;
220
221 const AttribBindingList& getAttribBindingList() const { return _attribBindingList; }
222 const FragDataBindingList& getFragDataBindingList() const { return _fragDataBindingList; }
223 const UniformBlockBindingList& getUniformBlockBindingList() const { return _uniformBlockBindingList; }
224
226 bool isFixedFunction() const;
227
229 bool getGlProgramInfoLog(unsigned int contextID, std::string& log) const;
230
232 ActiveVarInfo() : _location(-1), _type(Uniform::UNDEFINED), _size(-1) {}
233 ActiveVarInfo( GLint loc, GLenum type, GLint size ) : _location(loc), _type(type), _size(size) {}
235 GLenum _type;
236 GLint _size;
237 };
238 typedef std::map< unsigned int, ActiveVarInfo > ActiveUniformMap;
239 typedef std::map< std::string, ActiveVarInfo > ActiveVarInfoMap;
240 //const ActiveUniformMap& getActiveUniforms(unsigned int contextID) const;
241 //const ActiveVarInfoMap& getActiveAttribs(unsigned int contextID) const;
243 {
244 UniformBlockInfo() : _index(GL_INVALID_INDEX), _size(0) {}
245 UniformBlockInfo(GLuint index, GLsizei size)
246 : _index(index), _size(size)
247 {
248 }
249 GLuint _index;
250 GLsizei _size;
251 };
252 typedef std::map<std::string, UniformBlockInfo> UniformBlockMap;
253
254 //const UniformBlockMap& getUniformBlocks(unsigned contextID) const;
255 public:
256
257 // make PerContextProgram a friend to allow it access Program's protected
258 // methods and member variables.
259 class PerContextProgram;
260 friend class PerContextProgram;
261
264 {
265 public:
267 PerContextProgram(const Program* program, unsigned int contextID, GLuint programHandle=0);
268
269 GLuint getHandle() const {return _glProgramHandle;}
270
271 const osg::Program* getProgram() const { return _program; }
272
273 void setDefineString(const std::string& defStr) { _defineStr = defStr; }
274 const std::string& getDefineString() const { return _defineStr; }
275
277 virtual void linkProgram(osg::State& state);
278 virtual bool validateProgram();
279 bool needsLink() const {return _needsLink;}
280 bool isLinked() const {return _isLinked;}
281 virtual bool getInfoLog( std::string& infoLog ) const;
282
284 bool loadedBinary() const {return _loadedBinary;}
285
293
294 virtual void useProgram() const;
295
297 {
298 _lastAppliedUniformList.clear();
299 }
300
301
302 inline void apply(const Uniform& uniform) const
303 {
304 GLint location = getUniformLocation(uniform.getNameID());
305 if (location>=0)
306 {
307 const Uniform* lastAppliedUniform = _lastAppliedUniformList[location].first.get();
308 if (lastAppliedUniform != &uniform)
309 {
310 // new attribute
311 uniform.apply(_extensions.get(),location);
312 _lastAppliedUniformList[location].first = &uniform;
313 _lastAppliedUniformList[location].second = uniform.getModifiedCount();
314 }
315 else if (_lastAppliedUniformList[location].second != uniform.getModifiedCount())
316 {
317 // existing attribute has been modified
318 uniform.apply(_extensions.get(),location);
319 _lastAppliedUniformList[location].first = &uniform;
320 _lastAppliedUniformList[location].second = uniform.getModifiedCount();
321 }
322 }
323 }
324
325 const ActiveUniformMap& getActiveUniforms() const {return _uniformInfoMap;}
326 const ActiveVarInfoMap& getActiveAttribs() const {return _attribInfoMap;}
327 const UniformBlockMap& getUniformBlocks() const {return _uniformBlockMap; }
328 inline GLint getUniformLocation( unsigned int uniformNameID ) const { ActiveUniformMap::const_iterator itr = _uniformInfoMap.find(uniformNameID); return (itr!=_uniformInfoMap.end()) ? itr->second._location : -1; }
329
338 inline GLint getUniformLocation( const std::string & uniformName ) const { return getUniformLocation( Uniform::getNameID( uniformName ) ); }
339
340 inline GLint getAttribLocation( const std::string& name ) const { ActiveVarInfoMap::const_iterator itr = _attribInfoMap.find(name); return (itr!=_attribInfoMap.end()) ? itr->second._location : -1; }
341
342 inline void addShaderToAttach(Shader *shader)
343 {
344 _shadersToAttach.push_back(shader);
345 }
346
347 inline void addShaderToDetach(Shader *shader)
348 {
349 _shadersToDetach.push_back(shader);
350 }
351
352 protected: /*methods*/
354
355 protected: /*data*/
360
363
365 std::string _defineStr;
366
373
374 const unsigned int _contextID;
375
378
382
383 typedef std::pair<osg::ref_ptr<const osg::Uniform>, unsigned int> UniformModifiedCountPair;
384 typedef std::map<unsigned int, UniformModifiedCountPair> LastAppliedUniformList;
386
387 typedef std::vector< ref_ptr<Shader> > ShaderList;
390
391 private:
392 PerContextProgram(); // disallowed
393 PerContextProgram(const PerContextProgram&); // disallowed
394 PerContextProgram& operator=(const PerContextProgram&); // disallowed
395 };
396
398 {
399 typedef std::vector< osg::ref_ptr<PerContextProgram> > PerContextPrograms;
400
401 ProgramObjects(const Program* program, unsigned int contextID);
402
403 unsigned int _contextID;
406
407 PerContextProgram* getPCP(const std::string& defineStr) const;
408 PerContextProgram* createPerContextProgram(const std::string& defineStr);
412 bool getGlProgramInfoLog(std::string& log) const;
413 };
414
417
418 protected: /*methods*/
419 virtual ~Program();
420
421 protected: /*data*/
422
427
428 typedef std::vector< ref_ptr<Shader> > ShaderList;
430
432
437
440 std::vector<std::string> _feedbackout;
441
443
444
445 private:
446 Program& operator=(const Program&); // disallowed
447
448};
449
450}
451
452#endif
#define GL_INVALID_INDEX
Definition GLDefines:320
Definition CopyOp:41
@ SHALLOW_COPY
Definition CopyOp:47
Definition GLObjects:47
Definition Object:61
Definition osg/Program:264
bool _needsLink
Definition osg/Program:368
PerContextProgram(const Program *program, unsigned int contextID, GLuint programHandle=0)
void addShaderToDetach(Shader *shader)
Definition osg/Program:347
bool isLinked() const
Definition osg/Program:280
UniformBlockMap _uniformBlockMap
Definition osg/Program:381
void apply(const Uniform &uniform) const
Definition osg/Program:302
const std::string & getDefineString() const
Definition osg/Program:274
std::vector< ref_ptr< Shader > > ShaderList
Definition osg/Program:387
virtual bool getInfoLog(std::string &infoLog) const
void setDefineString(const std::string &defStr)
Definition osg/Program:273
GLint getAttribLocation(const std::string &name) const
Definition osg/Program:340
bool _loadedBinary
Definition osg/Program:372
std::string _defineStr
Definition osg/Program:365
LastAppliedUniformList _lastAppliedUniformList
Definition osg/Program:385
std::map< unsigned int, UniformModifiedCountPair > LastAppliedUniformList
Definition osg/Program:384
virtual void useProgram() const
void resetAppliedUniforms() const
Definition osg/Program:296
virtual ProgramBinary * compileProgramBinary(osg::State &state)
std::pair< osg::ref_ptr< const osg::Uniform >, unsigned int > UniformModifiedCountPair
Definition osg/Program:383
osg::ref_ptr< GLExtensions > _extensions
Definition osg/Program:359
bool _isLinked
Definition osg/Program:370
ActiveVarInfoMap _attribInfoMap
Definition osg/Program:380
GLint getUniformLocation(const std::string &uniformName) const
Definition osg/Program:338
const unsigned int _contextID
Definition osg/Program:374
bool needsLink() const
Definition osg/Program:279
bool _ownsProgramHandle
Definition osg/Program:377
const UniformBlockMap & getUniformBlocks() const
Definition osg/Program:327
ShaderList _shadersToAttach
Definition osg/Program:389
const ActiveUniformMap & getActiveUniforms() const
Definition osg/Program:325
const osg::Program * getProgram() const
Definition osg/Program:271
GLuint _glProgramHandle
Definition osg/Program:362
void addShaderToAttach(Shader *shader)
Definition osg/Program:342
GLint getUniformLocation(unsigned int uniformNameID) const
Definition osg/Program:328
ActiveUniformMap _uniformInfoMap
Definition osg/Program:379
const Program * _program
Definition osg/Program:357
ShaderList _shadersToDetach
Definition osg/Program:388
bool loadedBinary() const
Definition osg/Program:284
const ActiveVarInfoMap & getActiveAttribs() const
Definition osg/Program:326
GLuint getHandle() const
Definition osg/Program:269
virtual void linkProgram(osg::State &state)
Definition osg/Program:169
unsigned char * getData()
Definition osg/Program:195
GLenum _format
Definition osg/Program:202
GLenum getFormat() const
Definition osg/Program:189
void assign(unsigned int size, const unsigned char *data)
void setFormat(GLenum format)
Definition osg/Program:186
ProgramBinary(const ProgramBinary &rhs, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
unsigned int getSize() const
Definition osg/Program:192
void allocate(unsigned int size)
const unsigned char * getData() const
Definition osg/Program:198
std::vector< unsigned char > _data
Definition osg/Program:201
META_Object(osg, ProgramBinary)
Definition osg/Program:52
unsigned int getNumShaders() const
Definition osg/Program:91
std::map< std::string, GLuint > UniformBlockBindingList
Definition osg/Program:219
Shader * getShader(unsigned int i)
Definition osg/Program:93
virtual void apply(osg::State &state) const
void addTransformFeedBackVarying(const std::string &outname)
Definition osg/Program:137
ShaderDefines & getShaderDefines()
Definition osg/Program:156
GLint _geometryOutputType
Definition osg/Program:436
osg::ref_ptr< ProgramBinary > _programBinary
Definition osg/Program:431
virtual void releaseGLObjects(osg::State *state=0) const
std::map< std::string, GLuint > FragDataBindingList
Definition osg/Program:218
bool addShader(const ref_ptr< T > &shader)
Definition osg/Program:89
std::map< std::string, GLuint > AttribBindingList
Definition osg/Program:217
GLenum getTransformFeedBackMode() const
Definition osg/Program:152
void addBindFragDataLocation(const std::string &name, GLuint index)
GLenum _feedbackmode
Definition osg/Program:439
const ShaderDefines & getShaderDefines() const
Definition osg/Program:157
UniformBlockBindingList _uniformBlockBindingList
Definition osg/Program:426
virtual int compare(const osg::StateAttribute &sa) const
ShaderList _shaderList
Definition osg/Program:429
std::vector< ref_ptr< Shader > > ShaderList
Definition osg/Program:428
bool isFixedFunction() const
virtual void setThreadSafeRefUnref(bool threadSafe)
Program(const Program &rhs, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
const Shader * getShader(unsigned int i) const
Definition osg/Program:94
const std::string & getTransformFeedBackVarying(unsigned int i) const
Definition osg/Program:146
void removeBindAttribLocation(const std::string &name)
AttribBindingList _attribBindingList
Definition osg/Program:424
bool addShader(Shader *shader)
void removeBindFragDataLocation(const std::string &name)
void addBindUniformBlock(const std::string &name, GLuint index)
GLint _geometryInputType
Definition osg/Program:435
FragDataBindingList _fragDataBindingList
Definition osg/Program:425
unsigned int getNumTransformFeedBackVaryings() const
Definition osg/Program:143
std::vector< std::string > _feedbackout
Definition osg/Program:440
void setTransformFeedBackMode(GLenum e)
Definition osg/Program:149
ProgramBinary * getProgramBinary()
Definition osg/Program:212
void removeBindUniformBlock(const std::string &name)
std::map< std::string, ActiveVarInfo > ActiveVarInfoMap
Definition osg/Program:239
bool removeShader(Shader *shader)
void removeTransformFeedBackVarying(const std::string &name)
Definition osg/Program:128
virtual ~Program()
PerContextProgram * getPCP(State &state) const
virtual void resizeGLObjectBuffers(unsigned int maxSize)
void setProgramBinary(ProgramBinary *programBinary)
Definition osg/Program:209
GLint getParameter(GLenum pname) const
const ProgramBinary * getProgramBinary() const
Definition osg/Program:215
const UniformBlockBindingList & getUniformBlockBindingList() const
Definition osg/Program:223
osg::buffered_value< osg::ref_ptr< ProgramObjects > > _pcpList
Definition osg/Program:423
bool removeShader(const ref_ptr< T > &shader)
Definition osg/Program:100
void setParameter(GLenum pname, GLint value)
void addBindAttribLocation(const std::string &name, GLuint index)
virtual void compileGLObjects(osg::State &state) const
GLint _geometryVerticesOut
Definition osg/Program:434
META_StateAttribute(osg, Program, PROGRAM)
std::map< unsigned int, ActiveVarInfo > ActiveUniformMap
Definition osg/Program:238
const AttribBindingList & getAttribBindingList() const
Definition osg/Program:221
const FragDataBindingList & getFragDataBindingList() const
Definition osg/Program:222
void setShaderDefines(const ShaderDefines &shaderDefs)
Definition osg/Program:155
std::map< std::string, UniformBlockInfo > UniformBlockMap
Definition osg/Program:252
void dirtyProgram()
bool getGlProgramInfoLog(unsigned int contextID, std::string &log) const
ShaderDefines _shaderDefines
Definition osg/Program:442
Definition Referenced:44
Definition Shader:89
Definition StateAttribute:77
Definition State:80
Definition Uniform:414
static unsigned int getNameID(const std::string &name)
bool get(float &f) const
void apply(const GLExtensions *ext, GLint location) const
unsigned int getModifiedCount() const
Definition Uniform:909
Definition buffered_value:27
Definition ref_ptr:32
T * get() const
Definition ref_ptr:117
author: Julien Valentin 2017 (mp3butcher@hotmail.com)
Definition AlphaFunc:19
std::set< std::string > ShaderDefines
Definition Shader:37
#define OSG_EXPORT
Definition osg/Export:39
Definition osg/Program:231
ActiveVarInfo(GLint loc, GLenum type, GLint size)
Definition osg/Program:233
GLint _location
Definition osg/Program:234
ActiveVarInfo()
Definition osg/Program:232
GLint _size
Definition osg/Program:236
GLenum _type
Definition osg/Program:235
Definition osg/Program:398
PerContextProgram * getPCP(const std::string &defineStr) const
PerContextPrograms _perContextPrograms
Definition osg/Program:405
std::vector< osg::ref_ptr< PerContextProgram > > PerContextPrograms
Definition osg/Program:399
bool getGlProgramInfoLog(std::string &log) const
void addShaderToAttach(Shader *shader)
unsigned int _contextID
Definition osg/Program:403
ProgramObjects(const Program *program, unsigned int contextID)
void addShaderToDetach(Shader *shader)
const Program * _program
Definition osg/Program:404
PerContextProgram * createPerContextProgram(const std::string &defineStr)
Definition osg/Program:243
UniformBlockInfo(GLuint index, GLsizei size)
Definition osg/Program:245
UniformBlockInfo()
Definition osg/Program:244
GLsizei _size
Definition osg/Program:250
GLuint _index
Definition osg/Program:249