OpenSceneGraph
Public Member Functions | Protected Types | Protected Attributes | List of all members
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]
Collaboration diagram for osg::Program::PerContextProgram:
Collaboration graph
[legend]

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. More...
 
virtual void useProgram () const
 
void resetAppliedUniforms () const
 
void apply (const Uniform &uniform) const
 
const ActiveUniformMap & getActiveUniforms () const
 
const ActiveVarInfoMap & getActiveAttribs () const
 
const UniformBlockMap & getUniformBlocks () 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. More...
 
GLint getAttribLocation (const std::string &name) const
 
void addShaderToAttach (Shader *shader)
 
void addShaderToDetach (Shader *shader)
 
- Public Member Functions inherited from osg::Referenced
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

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 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. More...
 
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
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 
OpenThreads::Mutex_refMutex
 
int _refCount
 
void * _observerSet
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 
- Protected Member Functions inherited from osg::Referenced
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Detailed Description

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

Member Function Documentation

◆ compileProgramBinary()

virtual ProgramBinary* osg::Program::PerContextProgram::compileProgramBinary ( osg::State state)
virtual

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.

◆ getUniformLocation()

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.

Member Data Documentation

◆ _defineStr

std::string osg::Program::PerContextProgram::_defineStr
protected

Define string passed on to Shaders to help configure them.


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