OpenSceneGraph  3.0.1
Public Member Functions | Protected Types | Protected Member Functions | 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]

Public Member Functions

 PerContextProgram (const Program *program, unsigned int contextID)
GLuint getHandle () const
void requestLink ()
void linkProgram (osg::State &state)
bool validateProgram ()
bool needsLink () const
bool isLinked () const
bool getInfoLog (std::string &infoLog) const
bool loadedBinary () const
 Was glProgramBinary called successfully?
ProgramBinarycompileProgramBinary (osg::State &state)
 Compile a program binary.
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)
- Public Member Functions inherited from osg::Referenced
 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.
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Protected Types

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

Protected Member Functions

 ~PerContextProgram ()
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

const Program_program
 Pointer to our parent Program.
osg::ref_ptr< GL2Extensions_extensions
 Pointer to this context's extension functions.
GLuint _glProgramHandle
 Handle to the actual OpenGL glProgram.
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
ActiveUniformMap _uniformInfoMap
ActiveVarInfoMap _attribInfoMap
UniformBlockMap _uniformBlockMap
LastAppliedUniformList _lastAppliedUniformList
ShaderList _shadersToDetach
ShaderList _shadersToAttach
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Additional Inherited Members

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

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 
)
osg::Program::PerContextProgram::~PerContextProgram ( )
protected

Member Function Documentation

void osg::Program::PerContextProgram::addShaderToAttach ( Shader shader)
inline
void osg::Program::PerContextProgram::addShaderToDetach ( Shader shader)
inline
void osg::Program::PerContextProgram::apply ( const Uniform uniform) const
inline
ProgramBinary* osg::Program::PerContextProgram::compileProgramBinary ( osg::State state)

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.

const ActiveVarInfoMap& osg::Program::PerContextProgram::getActiveAttribs ( ) const
inline
const ActiveUniformMap& osg::Program::PerContextProgram::getActiveUniforms ( ) const
inline
GLint osg::Program::PerContextProgram::getAttribLocation ( const std::string &  name) const
inline
GLuint osg::Program::PerContextProgram::getHandle ( ) const
inline
bool osg::Program::PerContextProgram::getInfoLog ( std::string &  infoLog) const
const UniformBlockMap& osg::Program::PerContextProgram::getUniformBlocks ( ) const
inline
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().

bool osg::Program::PerContextProgram::isLinked ( ) const
inline
void osg::Program::PerContextProgram::linkProgram ( osg::State state)
bool osg::Program::PerContextProgram::loadedBinary ( ) const
inline

Was glProgramBinary called successfully?

bool osg::Program::PerContextProgram::needsLink ( ) const
inline
void osg::Program::PerContextProgram::requestLink ( )
void osg::Program::PerContextProgram::resetAppliedUniforms ( ) const
inline
void osg::Program::PerContextProgram::useProgram ( ) const
bool osg::Program::PerContextProgram::validateProgram ( )

Member Data Documentation

ActiveVarInfoMap osg::Program::PerContextProgram::_attribInfoMap
protected
const unsigned int osg::Program::PerContextProgram::_contextID
protected
osg::ref_ptr<GL2Extensions> osg::Program::PerContextProgram::_extensions
protected

Pointer to this context's extension functions.

GLuint osg::Program::PerContextProgram::_glProgramHandle
protected

Handle to the actual OpenGL glProgram.

bool osg::Program::PerContextProgram::_isLinked
protected

Is our glProgram successfully linked?

LastAppliedUniformList osg::Program::PerContextProgram::_lastAppliedUniformList
mutableprotected
bool osg::Program::PerContextProgram::_loadedBinary
protected

Was glProgramBinary called successfully?

bool osg::Program::PerContextProgram::_needsLink
protected

Does our glProgram need to be linked?

const Program* osg::Program::PerContextProgram::_program
protected

Pointer to our parent Program.

ShaderList osg::Program::PerContextProgram::_shadersToAttach
protected
ShaderList osg::Program::PerContextProgram::_shadersToDetach
protected
UniformBlockMap osg::Program::PerContextProgram::_uniformBlockMap
protected
ActiveUniformMap osg::Program::PerContextProgram::_uniformInfoMap
protected

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

osg logo
Generated at Tue Sep 4 2012 06:15:28 for the OpenSceneGraph by doxygen 1.8.1.2.