OpenSceneGraph  3.2.0
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osg::VertexProgram Class Reference

VertexProgram - encapsulates the OpenGL ARB vertex program state. More...

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

Classes

class  Extensions
 Extensions class which encapsulates the querying of extensions and associated function pointers, and provide convenience wrappers to check for the extensions or use the associated functions. More...
 

Public Types

typedef std::map< GLuint, Vec4LocalParamList
 
typedef std::map< GLenum, MatrixMatrixList
 
- 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, SAMPLEMASKI,
  PRIMITIVERESTARTINDEX, VALIDATOR, VIEWMATRIXEXTRACTOR, OSGNV_PARAMETER_BLOCK,
  OSGNVEXT_TEXTURE_SHADER, OSGNVEXT_VERTEX_PROGRAM, OSGNVEXT_REGISTER_COMBINERS, OSGNVCG_PROGRAM,
  OSGNVSLANG_PROGRAM, OSGNVPARSE_PROGRAM_PARSER, UNIFORMBUFFERBINDING, TRANSFORMFEEDBACKBUFFERBINDING,
  ATOMICCOUNTERBUFFERBINDING, PATCH_PARAMETER, FRAME_BUFFER_OBJECT
}
 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

 VertexProgram ()
 
 VertexProgram (const VertexProgram &vp, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy. More...
 
 META_StateAttribute (osg, VertexProgram, VERTEXPROGRAM)
 
virtual int compare (const osg::StateAttribute &sa) const
 Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs. More...
 
virtual bool getModeUsage (StateAttribute::ModeUsage &usage) const
 Return the modes associated with this StateAttribute. More...
 
GLuint & getVertexProgramID (unsigned int contextID) const
 Get the handle to the vertex program ID for the current context. More...
 
void setVertexProgram (const char *program)
 Set the vertex program using a C style string. More...
 
void setVertexProgram (const std::string &program)
 Set the vertex program using C++ style string. More...
 
const std::string & getVertexProgram () const
 Get the vertex program. More...
 
void setProgramLocalParameter (const GLuint index, const Vec4 &p)
 Set Program Parameters. More...
 
void setLocalParameters (const LocalParamList &lpl)
 Set list of Program Parameters. More...
 
LocalParamListgetLocalParameters ()
 Get list of Program Parameters. More...
 
const LocalParamListgetLocalParameters () const
 Get const list of Program Parameters. More...
 
void setMatrix (const GLenum mode, const Matrix &matrix)
 Matrix. More...
 
void setMatrices (const MatrixList &matrices)
 Set list of Matrices. More...
 
MatrixListgetMatrices ()
 Get list of Matrices. More...
 
const MatrixListgetMatrices () const
 Get list of Matrices. More...
 
void dirtyVertexProgramObject ()
 Force a recompile on next apply() of associated OpenGL vertex program objects. More...
 
virtual void apply (State &state) const
 apply the OpenGL state attributes. More...
 
virtual void compileGLObjects (State &state) const
 Default to nothing to compile - all state is applied immediately. More...
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (State *state=0) const
 Release any OpenGL objects in specified graphics context if State object is passed, otherwise release OpenGL objects for all graphics contexts if State object pointer is NULL. 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 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 setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. 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 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...
 

Static Public Member Functions

static void deleteVertexProgramObject (unsigned int contextID, GLuint handle)
 Use deleteVertexProgramObject instead of glDeletePrograms to allow OpenGL Vertex Program objects to cached until they can be deleted by the OpenGL context in which they were created, specified by contextID. More...
 
static void flushDeletedVertexProgramObjects (unsigned int contextID, double currentTime, double &availableTime)
 Flush all the cached vertex programs which need to be deleted in the OpenGL context related to contextID. More...
 
static void discardDeletedVertexProgramObjects (unsigned int contextID)
 discard all the cached vertex programs which need to be deleted in the OpenGL context related to contextID. More...
 
static ExtensionsgetExtensions (unsigned int contextID, bool createIfNotInitalized)
 Function to call to get the extension of a specified context. More...
 
static void setExtensions (unsigned int contextID, Extensions *extensions)
 The setExtensions method allows users to override the extensions across graphics contexts. More...
 

Protected Types

typedef buffered_value< GLuint > VertexProgramIDList
 

Protected Member Functions

virtual ~VertexProgram ()
 
- 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

VertexProgramIDList _vertexProgramIDList
 
std::string _vertexProgram
 
LocalParamList _programLocalParameters
 
MatrixList _matrixList
 
- 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
 

Detailed Description

VertexProgram - encapsulates the OpenGL ARB vertex program state.

Member Typedef Documentation

typedef std::map<GLuint,Vec4> osg::VertexProgram::LocalParamList
typedef std::map<GLenum,Matrix> osg::VertexProgram::MatrixList

Constructor & Destructor Documentation

osg::VertexProgram::VertexProgram ( )
osg::VertexProgram::VertexProgram ( const VertexProgram vp,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::VertexProgram::~VertexProgram ( )
protectedvirtual

Member Function Documentation

virtual void osg::VertexProgram::apply ( State ) const
virtual

apply the OpenGL state attributes.

The render info for the current OpenGL context is passed in to allow the StateAttribute to obtain details on the the current context and state.

Reimplemented from osg::StateAttribute.

virtual int osg::VertexProgram::compare ( const osg::StateAttribute sa) const
inlinevirtual

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

Implements osg::StateAttribute.

References COMPARE_StateAttribute_Parameter, and COMPARE_StateAttribute_Types.

virtual void osg::VertexProgram::compileGLObjects ( State ) const
inlinevirtual

Default to nothing to compile - all state is applied immediately.

Reimplemented from osg::StateAttribute.

static void osg::VertexProgram::deleteVertexProgramObject ( unsigned int  contextID,
GLuint  handle 
)
static

Use deleteVertexProgramObject instead of glDeletePrograms to allow OpenGL Vertex Program objects to cached until they can be deleted by the OpenGL context in which they were created, specified by contextID.

void osg::VertexProgram::dirtyVertexProgramObject ( )

Force a recompile on next apply() of associated OpenGL vertex program objects.

static void osg::VertexProgram::discardDeletedVertexProgramObjects ( unsigned int  contextID)
static

discard all the cached vertex programs 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::VertexProgram::flushDeletedVertexProgramObjects ( unsigned int  contextID,
double  currentTime,
double &  availableTime 
)
static

Flush all the cached vertex programs which need to be deleted in the OpenGL context related to contextID.

static Extensions* osg::VertexProgram::getExtensions ( unsigned int  contextID,
bool  createIfNotInitalized 
)
static

Function to call to get the extension of a specified context.

If the Extension object for that context has not yet been created and the 'createIfNotInitalized' flag been set to false then returns NULL. If 'createIfNotInitalized' is true then the Extensions object is automatically created. However, in this case the extension object will only be created with the graphics context associated with ContextID.

LocalParamList& osg::VertexProgram::getLocalParameters ( )
inline

Get list of Program Parameters.

const LocalParamList& osg::VertexProgram::getLocalParameters ( ) const
inline

Get const list of Program Parameters.

MatrixList& osg::VertexProgram::getMatrices ( )
inline

Get list of Matrices.

const MatrixList& osg::VertexProgram::getMatrices ( ) const
inline

Get list of Matrices.

virtual bool osg::VertexProgram::getModeUsage ( StateAttribute::ModeUsage ) const
inlinevirtual

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

References GL_VERTEX_PROGRAM_ARB, and osg::StateAttribute::ModeUsage::usesMode().

const std::string& osg::VertexProgram::getVertexProgram ( ) const
inline

Get the vertex program.

GLuint& osg::VertexProgram::getVertexProgramID ( unsigned int  contextID) const
inline

Get the handle to the vertex program ID for the current context.

osg::VertexProgram::META_StateAttribute ( osg  ,
VertexProgram  ,
VERTEXPROGRAM   
)
virtual void osg::VertexProgram::releaseGLObjects ( State state = 0) const
virtual

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

Reimplemented from osg::StateAttribute.

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

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::StateAttribute.

static void osg::VertexProgram::setExtensions ( unsigned int  contextID,
Extensions extensions 
)
static

The setExtensions method allows users to override the extensions across graphics contexts.

Typically used when you have different extensions supported across graphics pipes but need to ensure that they all use the same low common denominator extensions.

void osg::VertexProgram::setLocalParameters ( const LocalParamList lpl)
inline

Set list of Program Parameters.

void osg::VertexProgram::setMatrices ( const MatrixList matrices)
inline

Set list of Matrices.

void osg::VertexProgram::setMatrix ( const GLenum  mode,
const Matrix matrix 
)
inline

Matrix.

void osg::VertexProgram::setProgramLocalParameter ( const GLuint  index,
const Vec4 p 
)
inline

Set Program Parameters.

void osg::VertexProgram::setVertexProgram ( const char *  program)
inline

Set the vertex program using a C style string.

void osg::VertexProgram::setVertexProgram ( const std::string &  program)
inline

Set the vertex program using C++ style string.

Member Data Documentation

MatrixList osg::VertexProgram::_matrixList
protected
LocalParamList osg::VertexProgram::_programLocalParameters
protected
std::string osg::VertexProgram::_vertexProgram
protected
VertexProgramIDList osg::VertexProgram::_vertexProgramIDList
mutableprotected

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

osg logo
Generated at Mon Sep 9 2013 05:53:17 for the OpenSceneGraph by doxygen 1.8.4.