openscenegraph
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
Inheritance diagram for osg::Program:
osg::StateAttribute osg::Object osg::Referenced

Classes

struct  ActiveVarInfo
class  PerContextProgram
class  ProgramBinary
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
}
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
}
typedef GLenum GLMode
typedef unsigned int GLModeValue
typedef unsigned int OverrideValue
typedef std::pair< Type,
unsigned int > 
TypeMemberPair
typedef std::vector< StateSet * > ParentList
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)
 META_StateAttribute (osg, Program, PROGRAM)
virtual int compare (const osg::StateAttribute &sa) const
virtual void apply (osg::State &state) const
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void compileGLObjects (osg::State &state) const
virtual void resizeGLObjectBuffers (unsigned int maxSize)
virtual void releaseGLObjects (osg::State *state=0) const
void dirtyProgram ()
bool addShader (Shader *shader)
unsigned int getNumShaders () const
ShadergetShader (unsigned int i)
const ShadergetShader (unsigned int i) const
bool removeShader (Shader *shader)
void setParameter (GLenum pname, GLint value)
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)
void removeBindAttribLocation (const std::string &name)
void addBindFragDataLocation (const std::string &name, GLuint index)
void removeBindFragDataLocation (const std::string &name)
void addBindUniformBlock (const std::string &name, GLuint index)
void removeBindUniformBlock (const std::string &name)
void setProgramBinary (ProgramBinary *programBinary)
ProgramBinarygetProgramBinary ()
const ProgramBinarygetProgramBinary () const
const AttribBindingListgetAttribBindingList () const
const FragDataBindingListgetFragDataBindingList () const
const UniformBlockBindingListgetUniformBlockBindingList () const
bool isFixedFunction () const
bool getGlProgramInfoLog (unsigned int contextID, std::string &log) const
const ActiveUniformMapgetActiveUniforms (unsigned int contextID) const
const ActiveVarInfoMapgetActiveAttribs (unsigned int contextID) const
const UniformBlockMapgetUniformBlocks (unsigned contextID) const
PerContextProgramgetPCP (unsigned int contextID) const
- Public Member Functions inherited from osg::StateAttribute
 StateAttribute ()
 StateAttribute (const StateAttribute &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const =0
virtual Objectclone (const CopyOp &) const =0
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual TextureasTexture ()
virtual const TextureasTexture () const
virtual Type getType () const =0
virtual unsigned int getMember () const
TypeMemberPair getTypeMemberPair () const
virtual bool isTextureAttribute () const
bool operator< (const StateAttribute &rhs) const
bool operator== (const StateAttribute &rhs) const
bool operator!= (const StateAttribute &rhs) const
const ParentListgetParents () const
StateSetgetParent (unsigned int i)
const StateSetgetParent (unsigned int i) const
unsigned int getNumParents () const
void setShaderComponent (ShaderComponent *sc)
ShaderComponentgetShaderComponent ()
const ShaderComponentgetShaderComponent () const
virtual bool getModeUsage (ModeUsage &) const
virtual bool checkValidityOfAssociatedModes (osg::State &) const
void setUpdateCallback (StateAttributeCallback *uc)
StateAttributeCallbackgetUpdateCallback ()
const StateAttributeCallbackgetUpdateCallback () const
void setEventCallback (StateAttributeCallback *ec)
StateAttributeCallbackgetEventCallback ()
const StateAttributeCallbackgetEventCallback () const
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual void setName (const std::string &name)
void setName (const char *name)
const std::string & getName () const
void setDataVariance (DataVariance dv)
DataVariance getDataVariance () const
virtual void computeDataVariance ()
void setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () const
template<typename T >
bool getUserValue (const std::string &name, T &value) const
template<typename T >
void setUserValue (const std::string &name, const T &value)
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const

Static Public Member Functions

static void deleteGlProgram (unsigned int contextID, GLuint program)
static void flushDeletedGlPrograms (unsigned int contextID, double currentTime, double &availableTime)
static void discardDeletedGlPrograms (unsigned int contextID)

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 ()
- 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
GLint _geometryInputType
GLint _geometryOutputType
GLint _patchVertices
- 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: