OpenSceneGraph  3.0.1
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
osg::Program Class Reference

osg::Program is an application-level abstraction of an OpenGL glProgram. More...

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

Classes

struct  ActiveVarInfo
 
class  PerContextProgram
 PerContextProgram (PCP) is an OSG-internal encapsulation of glPrograms per-GL context. More...
 
class  ProgramBinary
 Simple class for wrapping up the data used in glProgramBinary and glGetProgramBinary. More...
 
struct  UniformBlockInfo
 

Public Types

typedef std::map< std::string,
GLuint > 
AttribBindingList
 
typedef std::map< std::string,
GLuint > 
FragDataBindingList
 
typedef std::map< std::string,
GLuint > 
UniformBlockBindingList
 
typedef std::map< unsigned int,
ActiveVarInfo
ActiveUniformMap
 
typedef std::map< std::string,
ActiveVarInfo
ActiveVarInfoMap
 
typedef std::map< std::string,
UniformBlockInfo
UniformBlockMap
 
- Public Types inherited from osg::StateAttribute
enum  Values {
  OFF = 0x0, ON = 0x1, OVERRIDE = 0x2, PROTECTED = 0x4,
  INHERIT = 0x8
}
 list values which can be used to set either GLModeValues or OverrideValues. More...
 
enum  Type {
  TEXTURE, POLYGONMODE, POLYGONOFFSET, MATERIAL,
  ALPHAFUNC, ANTIALIAS, COLORTABLE, CULLFACE,
  FOG, FRONTFACE, LIGHT, POINT,
  LINEWIDTH, LINESTIPPLE, POLYGONSTIPPLE, SHADEMODEL,
  TEXENV, TEXENVFILTER, TEXGEN, TEXMAT,
  LIGHTMODEL, BLENDFUNC, BLENDEQUATION, LOGICOP,
  STENCIL, COLORMASK, DEPTH, VIEWPORT,
  SCISSOR, BLENDCOLOR, MULTISAMPLE, CLIPPLANE,
  COLORMATRIX, VERTEXPROGRAM, FRAGMENTPROGRAM, POINTSPRITE,
  PROGRAM, CLAMPCOLOR, HINT, VALIDATOR,
  VIEWMATRIXEXTRACTOR, OSGNV_PARAMETER_BLOCK, OSGNVEXT_TEXTURE_SHADER, OSGNVEXT_VERTEX_PROGRAM,
  OSGNVEXT_REGISTER_COMBINERS, OSGNVCG_PROGRAM, OSGNVSLANG_PROGRAM, OSGNVPARSE_PROGRAM_PARSER,
  UNIFORMBUFFERBINDING, TRANSFORMFEEDBACKBUFFERBINDING
}
 Type identifier to differentiate between different state types. More...
 
typedef GLenum GLMode
 GLMode is the value used in glEnable/glDisable(mode) More...
 
typedef unsigned int GLModeValue
 GLModeValue is used to specify whether a mode is enabled (ON) or disabled (OFF). More...
 
typedef unsigned int OverrideValue
 Override is used to specify the override behavior of StateAttributes from parent to children. More...
 
typedef std::pair< Type,
unsigned int > 
TypeMemberPair
 Simple pairing between an attribute type and the member within that attribute type group. More...
 
typedef std::vector< StateSet * > ParentList
 A vector of osg::StateSet pointers which is used to store the parent(s) of this StateAttribute. More...
 
typedef osg::StateAttributeCallback Callback
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 Program ()
 
 Program (const Program &rhs, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy. More...
 
 META_StateAttribute (osg, Program, PROGRAM)
 
virtual int compare (const osg::StateAttribute &sa) const
 return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs. More...
 
virtual void apply (osg::State &state) const
 If enabled, activate our program in the GL pipeline, performing any rebuild operations that might be pending. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void compileGLObjects (osg::State &state) const
 Compile program and associated shaders. More...
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *state=0) const
 release OpenGL objects in specified graphics context if State object is passed, otherwise release OpenGL objects for all graphics context if State object pointer NULL. More...
 
void dirtyProgram ()
 Mark our PCSOs as needing relink. More...
 
bool addShader (Shader *shader)
 Attach an osg::Shader to this osg::Program. More...
 
unsigned int getNumShaders () const
 
ShadergetShader (unsigned int i)
 
const ShadergetShader (unsigned int i) const
 
bool removeShader (Shader *shader)
 Remove osg::Shader from this osg::Program. More...
 
void setParameter (GLenum pname, GLint value)
 Set/get GL program parameters. More...
 
GLint getParameter (GLenum pname) const
 
void setParameterfv (GLenum pname, const GLfloat *value)
 
const GLfloat * getParameterfv (GLenum pname) const
 
void addBindAttribLocation (const std::string &name, GLuint index)
 Add an attribute location binding. More...
 
void removeBindAttribLocation (const std::string &name)
 Remove an attribute location binding. More...
 
void addBindFragDataLocation (const std::string &name, GLuint index)
 Add an frag data location binding. More...
 
void removeBindFragDataLocation (const std::string &name)
 Remove an frag data location binding. More...
 
void addBindUniformBlock (const std::string &name, GLuint index)
 Add a uniform block binding to an index target. More...
 
void removeBindUniformBlock (const std::string &name)
 Remove a uniform block binding. More...
 
void setProgramBinary (ProgramBinary *programBinary)
 Set the Program using a ProgramBinary. More...
 
ProgramBinarygetProgramBinary ()
 Get the Program's ProgramBinary, return NULL if none is assigned. More...
 
const ProgramBinarygetProgramBinary () const
 Get the const Program's ProgramBinary, return NULL if none is assigned. More...
 
const AttribBindingListgetAttribBindingList () const
 
const FragDataBindingListgetFragDataBindingList () const
 
const UniformBlockBindingListgetUniformBlockBindingList () const
 
bool isFixedFunction () const
 Return true if this Program represents "fixed-functionality" rendering. More...
 
bool getGlProgramInfoLog (unsigned int contextID, std::string &log) const
 Query InfoLog from a glProgram. More...
 
const ActiveUniformMapgetActiveUniforms (unsigned int contextID) const
 
const ActiveVarInfoMapgetActiveAttribs (unsigned int contextID) const
 
const UniformBlockMapgetUniformBlocks (unsigned contextID) const
 
PerContextProgramgetPCP (unsigned int contextID) const
 Get the PCP for a particular GL context. More...
 
- Public Member Functions inherited from osg::StateAttribute
 StateAttribute ()
 
 StateAttribute (const StateAttribute &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 Clone the type of an attribute, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an attribute, with Object* return type. More...
 
virtual bool isSameKindAs (const Object *obj) const
 Return true if this and obj are of the same kind of object. More...
 
virtual const char * libraryName () const
 Return the name of the attribute's library. More...
 
virtual const char * className () const
 Return the name of the attribute's class type. More...
 
virtual TextureasTexture ()
 Fast alternative to dynamic_cast<> for determining if state attribute is a Texture. More...
 
virtual const TextureasTexture () const
 Fast alternative to dynamic_cast<> for determining if state attribute is a Texture. More...
 
virtual Type getType () const =0
 Return the Type identifier of the attribute's class type. More...
 
virtual unsigned int getMember () const
 Return the member identifier within the attribute's class type. More...
 
TypeMemberPair getTypeMemberPair () const
 Return the TypeMemberPair that uniquely identifies this type member. More...
 
virtual bool isTextureAttribute () const
 Return true if StateAttribute is a type which controls texturing and needs to be issued w.r.t to specific texture unit. More...
 
bool operator< (const StateAttribute &rhs) const
 
bool operator== (const StateAttribute &rhs) const
 
bool operator!= (const StateAttribute &rhs) const
 
const ParentListgetParents () const
 Get the parent list of this StateAttribute. More...
 
StateSetgetParent (unsigned int i)
 
const StateSetgetParent (unsigned int i) const
 Get a single const parent of this StateAttribute. More...
 
unsigned int getNumParents () const
 Get the number of parents of this StateAttribute. More...
 
void setShaderComponent (ShaderComponent *sc)
 
ShaderComponentgetShaderComponent ()
 
const ShaderComponentgetShaderComponent () const
 
virtual bool getModeUsage (ModeUsage &) const
 Return the modes associated with this StateAttribute. More...
 
virtual bool checkValidityOfAssociatedModes (osg::State &) const
 Check the modes associated with this StateAttribute are supported by current OpenGL drivers, and if not set the associated mode in osg::State to be black listed/invalid. More...
 
void setUpdateCallback (StateAttributeCallback *uc)
 Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal. More...
 
StateAttributeCallbackgetUpdateCallback ()
 Get the non const UpdateCallback. More...
 
const StateAttributeCallbackgetUpdateCallback () const
 Get the const UpdateCallback. More...
 
void setEventCallback (StateAttributeCallback *ec)
 Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal. More...
 
StateAttributeCallbackgetEventCallback ()
 Get the non const EventCallback. More...
 
const StateAttributeCallbackgetEventCallback () const
 Get the const EventCallback. More...
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
template<typename T >
BoolValueObject
UCharValueObject
UShortValueObject
UIntValueObject
DoubleValueObject
Vec3fValueObject
Vec2dValueObject
Vec4dValueObject
PlaneValueObject
MatrixdValueObject bool 
getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
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 referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is 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...
 

Static Public Member Functions

static void deleteGlProgram (unsigned int contextID, GLuint program)
 Mark internal glProgram for deletion. More...
 
static void flushDeletedGlPrograms (unsigned int contextID, double currentTime, double &availableTime)
 flush all the cached glPrograms which need to be deleted in the OpenGL context related to contextID. More...
 
static void discardDeletedGlPrograms (unsigned int contextID)
 discard all the cached glPrograms which need to be deleted in the OpenGL context related to contextID. More...
 

Protected Types

typedef std::vector< ref_ptr
< Shader > > 
ShaderList
 

Protected Member Functions

virtual ~Program ()
 
- Protected Member Functions inherited from osg::StateAttribute
virtual ~StateAttribute ()
 
void addParent (osg::StateSet *object)
 
void removeParent (osg::StateSet *object)
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

osg::buffered_value
< osg::ref_ptr
< PerContextProgram > > 
_pcpList
 
AttribBindingList _attribBindingList
 
FragDataBindingList _fragDataBindingList
 
UniformBlockBindingList _uniformBlockBindingList
 
ShaderList _shaderList
 
osg::ref_ptr< ProgramBinary_programBinary
 
GLint _geometryVerticesOut
 Parameters maintained with glProgramParameteriEXT. More...
 
GLint _geometryInputType
 
GLint _geometryOutputType
 
GLint _patchVertices
 Parameter maintained with glPatchParameteri. More...
 
- Protected Attributes inherited from osg::StateAttribute
ParentList _parents
 
ref_ptr< ShaderComponent_shaderComponent
 
ref_ptr< StateAttributeCallback_updateCallback
 
ref_ptr< StateAttributeCallback_eventCallback
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Friends

class PerContextProgram
 

Detailed Description

osg::Program is an application-level abstraction of an OpenGL glProgram.

It is an osg::StateAttribute that, when applied, will activate a glProgram for subsequent rendering. osg::Shaders containing the actual shader source code are attached to a Program, which will then manage the compilation, linking, and activation of the GLSL program. osg::Program will automatically manage per-context instancing of the OpenGL glPrograms, if that is necessary for a particular display configuration.

Member Typedef Documentation

typedef std::map< unsigned int, ActiveVarInfo > osg::Program::ActiveUniformMap
typedef std::map< std::string, ActiveVarInfo > osg::Program::ActiveVarInfoMap
typedef std::map<std::string,GLuint> osg::Program::AttribBindingList
typedef std::map<std::string,GLuint> osg::Program::FragDataBindingList
typedef std::vector< ref_ptr<Shader> > osg::Program::ShaderList
protected
typedef std::map<std::string,GLuint> osg::Program::UniformBlockBindingList
typedef std::map<std::string, UniformBlockInfo> osg::Program::UniformBlockMap

Constructor & Destructor Documentation

osg::Program::Program ( )
osg::Program::Program ( const Program rhs,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::Program::~Program ( )
protectedvirtual

Member Function Documentation

void osg::Program::addBindAttribLocation ( const std::string &  name,
GLuint  index 
)

Add an attribute location binding.

void osg::Program::addBindFragDataLocation ( const std::string &  name,
GLuint  index 
)

Add an frag data location binding.

See EXT_gpu_shader4 for BindFragDataLocationEXT

void osg::Program::addBindUniformBlock ( const std::string &  name,
GLuint  index 
)

Add a uniform block binding to an index target.

XXX This should not be an attribute of the program. It should be a pseudo-uniform that can live in StateSet objects because it is cheap to set.

bool osg::Program::addShader ( Shader shader)

Attach an osg::Shader to this osg::Program.

Mark Program as needing relink. Return true for success

virtual void osg::Program::apply ( osg::State state) const
virtual

If enabled, activate our program in the GL pipeline, performing any rebuild operations that might be pending.

Reimplemented from osg::StateAttribute.

virtual int osg::Program::compare ( const osg::StateAttribute sa) const
virtual

return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.

Implements osg::StateAttribute.

virtual void osg::Program::compileGLObjects ( osg::State state) const
virtual

Compile program and associated shaders.

Reimplemented from osg::StateAttribute.

static void osg::Program::deleteGlProgram ( unsigned int  contextID,
GLuint  program 
)
static

Mark internal glProgram for deletion.

Deletion requests are queued until they can be executed in the proper GL context.

void osg::Program::dirtyProgram ( )

Mark our PCSOs as needing relink.

static void osg::Program::discardDeletedGlPrograms ( unsigned int  contextID)
static

discard all the cached glPrograms which need to be deleted in the OpenGL context related to contextID.

Note, unlike flush no OpenGL calls are made, instead the handles are all removed. this call is useful for when an OpenGL context has been destroyed.

static void osg::Program::flushDeletedGlPrograms ( unsigned int  contextID,
double  currentTime,
double &  availableTime 
)
static

flush all the cached glPrograms which need to be deleted in the OpenGL context related to contextID.

const ActiveVarInfoMap& osg::Program::getActiveAttribs ( unsigned int  contextID) const
const ActiveUniformMap& osg::Program::getActiveUniforms ( unsigned int  contextID) const
const AttribBindingList& osg::Program::getAttribBindingList ( ) const
inline
const FragDataBindingList& osg::Program::getFragDataBindingList ( ) const
inline
bool osg::Program::getGlProgramInfoLog ( unsigned int  contextID,
std::string &  log 
) const

Query InfoLog from a glProgram.

unsigned int osg::Program::getNumShaders ( ) const
inline
GLint osg::Program::getParameter ( GLenum  pname) const
const GLfloat* osg::Program::getParameterfv ( GLenum  pname) const
PerContextProgram* osg::Program::getPCP ( unsigned int  contextID) const

Get the PCP for a particular GL context.

ProgramBinary* osg::Program::getProgramBinary ( )
inline

Get the Program's ProgramBinary, return NULL if none is assigned.

const ProgramBinary* osg::Program::getProgramBinary ( ) const
inline

Get the const Program's ProgramBinary, return NULL if none is assigned.

Shader* osg::Program::getShader ( unsigned int  i)
inline
const Shader* osg::Program::getShader ( unsigned int  i) const
inline
const UniformBlockBindingList& osg::Program::getUniformBlockBindingList ( ) const
inline
const UniformBlockMap& osg::Program::getUniformBlocks ( unsigned  contextID) const
bool osg::Program::isFixedFunction ( ) const

Return true if this Program represents "fixed-functionality" rendering.

osg::Program::META_StateAttribute ( osg  ,
Program  ,
PROGRAM   
)
virtual void osg::Program::releaseGLObjects ( osg::State state = 0) const
virtual

release OpenGL objects in specified graphics context if State object is passed, otherwise release OpenGL objects for all graphics context if State object pointer NULL.

Reimplemented from osg::StateAttribute.

void osg::Program::removeBindAttribLocation ( const std::string &  name)

Remove an attribute location binding.

void osg::Program::removeBindFragDataLocation ( const std::string &  name)

Remove an frag data location binding.

void osg::Program::removeBindUniformBlock ( const std::string &  name)

Remove a uniform block binding.

bool osg::Program::removeShader ( Shader shader)

Remove osg::Shader from this osg::Program.

Mark Program as needing relink. Return true for success

virtual void osg::Program::resizeGLObjectBuffers ( unsigned int  maxSize)
virtual

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::StateAttribute.

void osg::Program::setParameter ( GLenum  pname,
GLint  value 
)

Set/get GL program parameters.

void osg::Program::setParameterfv ( GLenum  pname,
const GLfloat *  value 
)
void osg::Program::setProgramBinary ( ProgramBinary programBinary)
inline

Set the Program using a ProgramBinary.

If a ProgramBinary is not yet available then setting an empty one signals that compileProgramBinary will be called later.

virtual void osg::Program::setThreadSafeRefUnref ( bool  threadSafe)
virtual

Set whether to use a mutex to ensure ref() and unref() are thread safe.

Reimplemented from osg::Object.

Friends And Related Function Documentation

friend class PerContextProgram
friend

Member Data Documentation

AttribBindingList osg::Program::_attribBindingList
protected
FragDataBindingList osg::Program::_fragDataBindingList
protected
GLint osg::Program::_geometryInputType
protected
GLint osg::Program::_geometryOutputType
protected
GLint osg::Program::_geometryVerticesOut
protected

Parameters maintained with glProgramParameteriEXT.

GLint osg::Program::_patchVertices
protected

Parameter maintained with glPatchParameteri.

osg::buffered_value< osg::ref_ptr<PerContextProgram> > osg::Program::_pcpList
mutableprotected
osg::ref_ptr<ProgramBinary> osg::Program::_programBinary
protected
ShaderList osg::Program::_shaderList
protected
UniformBlockBindingList osg::Program::_uniformBlockBindingList
protected

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

osg logo
Generated at Fri Mar 1 2013 18:59:39 for the OpenSceneGraph by doxygen 1.8.3.1.