OpenSceneGraph  3.4.0
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
osg::Program::PerContextProgram Class Reference

PerContextProgram (PCP) is an OSG-internal encapsulation of glPrograms per-GL context. More...

Inheritance diagram for osg::Program::PerContextProgram:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 PerContextProgram (const Program *program, unsigned int contextID, GLuint programHandle=0)
 Use "0" as programHandle to let the PeContextProgram execute "glCreateProgram"and "glDeleteProgram".
GLuint getHandle () const
const osg::ProgramgetProgram () const
void setDefineString (const std::string &defStr)
const std::string & getDefineString () const
void requestLink ()
virtual void linkProgram (osg::State &state)
virtual bool validateProgram ()
bool needsLink () const
bool isLinked () const
virtual bool getInfoLog (std::string &infoLog) const
bool loadedBinary () const
 Was glProgramBinary called successfully?
virtual ProgramBinarycompileProgramBinary (osg::State &state)
 Compile a program binary.
virtual void useProgram () const
void resetAppliedUniforms () const
void apply (const Uniform &uniform) const
const ActiveUniformMapgetActiveUniforms () const
const ActiveVarInfoMapgetActiveAttribs () const
const UniformBlockMapgetUniformBlocks () const
GLint getUniformLocation (unsigned int uniformNameID) const
GLint getUniformLocation (const std::string &uniformName) const
 Alternative version of getUniformLocation( unsigned int uniformNameID ) retrofited into OSG for backward compatibility with osgCal, after uniform ids were refactored from std::strings to GLints in OSG version 2.9.10.
GLint getAttribLocation (const std::string &name) const
void addShaderToAttach (Shader *shader)
void addShaderToDetach (Shader *shader)

Protected Types

typedef std::pair
< osg::ref_ptr< const
osg::Uniform >, unsigned int > 
UniformModifiedCountPair
typedef std::map< unsigned int,
UniformModifiedCountPair
LastAppliedUniformList
typedef std::vector< ref_ptr
< Shader > > 
ShaderList

Protected Member Functions

virtual ~PerContextProgram ()

Protected Attributes

const Program_program
 Pointer to our parent Program.
osg::ref_ptr< GLExtensions_extensions
 Pointer to this context's extension functions.
GLuint _glProgramHandle
 Handle to the actual OpenGL glProgram.
std::string _defineStr
 Define string passed on to Shaders to help configure them.
bool _needsLink
 Does our glProgram need to be linked?
bool _isLinked
 Is our glProgram successfully linked?
bool _loadedBinary
 Was glProgramBinary called successfully?
const unsigned int _contextID
bool _ownsProgramHandle
 Does the glProgram handle belongs to this class?
ActiveUniformMap _uniformInfoMap
ActiveVarInfoMap _attribInfoMap
UniformBlockMap _uniformBlockMap
LastAppliedUniformList _lastAppliedUniformList
ShaderList _shadersToDetach
ShaderList _shadersToAttach

Detailed Description

PerContextProgram (PCP) is an OSG-internal encapsulation of glPrograms per-GL context.


Member Typedef Documentation

typedef std::vector< ref_ptr<Shader> > osg::Program::PerContextProgram::ShaderList [protected]
typedef std::pair<osg::ref_ptr<const osg::Uniform>, unsigned int> osg::Program::PerContextProgram::UniformModifiedCountPair [protected]

Constructor & Destructor Documentation

osg::Program::PerContextProgram::PerContextProgram ( const Program program,
unsigned int  contextID,
GLuint  programHandle = 0 
)

Use "0" as programHandle to let the PeContextProgram execute "glCreateProgram"and "glDeleteProgram".

virtual osg::Program::PerContextProgram::~PerContextProgram ( ) [protected, virtual]

Member Function Documentation

void osg::Program::PerContextProgram::apply ( const Uniform uniform) const [inline]

Compile a program binary.

For this to work setProgramBinary must have been called on the osg::Program with an empty ProgramBinary prior to compileGLObjects being called. compileProgramBinary should be called after the program has been "exercised" by rendering with it. The ProgramBinary can then be saved to disk for faster subsequent compiling.

GLint osg::Program::PerContextProgram::getAttribLocation ( const std::string &  name) const [inline]
const std::string& osg::Program::PerContextProgram::getDefineString ( ) const [inline]
GLuint osg::Program::PerContextProgram::getHandle ( ) const [inline]
virtual bool osg::Program::PerContextProgram::getInfoLog ( std::string &  infoLog) const [virtual]
GLint osg::Program::PerContextProgram::getUniformLocation ( unsigned int  uniformNameID) const [inline]
GLint osg::Program::PerContextProgram::getUniformLocation ( const std::string &  uniformName) const [inline]

Alternative version of getUniformLocation( unsigned int uniformNameID ) retrofited into OSG for backward compatibility with osgCal, after uniform ids were refactored from std::strings to GLints in OSG version 2.9.10.

Drawbacks: This method is not particularly fast. It has to access mutexed static map of uniform ids. So don't overuse it or your app performance will suffer.

References osg::Uniform::getNameID(), and getUniformLocation().

Referenced by getUniformLocation().

Was glProgramBinary called successfully?

void osg::Program::PerContextProgram::setDefineString ( const std::string &  defStr) [inline]

Member Data Documentation

const unsigned int osg::Program::PerContextProgram::_contextID [protected]

Define string passed on to Shaders to help configure them.

Pointer to this context's extension functions.

Handle to the actual OpenGL glProgram.

Is our glProgram successfully linked?

Was glProgramBinary called successfully?

Does our glProgram need to be linked?

Does the glProgram handle belongs to this class?

Pointer to our parent Program.


The documentation for this class was generated from the following file:

osg logo
Generated at Tue Dec 8 2015 00:16:43 for the OpenSceneGraph by doxygen 1.7.6.1.