openscenegraph
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osg::FragmentProgram Class Reference
Inheritance diagram for osg::FragmentProgram:
osg::StateAttribute osg::Object osg::Referenced

Classes

class  Extensions

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
}
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

 FragmentProgram ()
 FragmentProgram (const FragmentProgram &vp, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_StateAttribute (osg, FragmentProgram, FRAGMENTPROGRAM)
virtual int compare (const osg::StateAttribute &sa) const
virtual bool getModeUsage (StateAttribute::ModeUsage &usage) const
GLuint & getFragmentProgramID (unsigned int contextID) const
void setFragmentProgram (const char *program)
void setFragmentProgram (const std::string &program)
const std::string & getFragmentProgram () const
void setProgramLocalParameter (const GLuint index, const Vec4 &p)
void setLocalParameters (const LocalParamList &lpl)
LocalParamListgetLocalParameters ()
const LocalParamListgetLocalParameters () const
void setMatrix (const GLenum mode, const Matrix &matrix)
void setMatrices (const MatrixList &matrices)
MatrixListgetMatrices ()
const MatrixListgetMatrices () const
void dirtyFragmentProgramObject ()
virtual void apply (State &state) const
virtual void compileGLObjects (State &state) const
virtual void resizeGLObjectBuffers (unsigned int maxSize)
virtual void releaseGLObjects (State *state=0) 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 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 setThreadSafeRefUnref (bool threadSafe)
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 deleteFragmentProgramObject (unsigned int contextID, GLuint handle)
static void flushDeletedFragmentProgramObjects (unsigned int contextID, double currentTime, double &availableTime)
static void discardDeletedFragmentProgramObjects (unsigned int contextID)
static ExtensionsgetExtensions (unsigned int contextID, bool createIfNotInitalized)
static void setExtensions (unsigned int contextID, Extensions *extensions)

Protected Types

typedef buffered_value< GLuint > FragmentProgramIDList

Protected Member Functions

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

FragmentProgramIDList _fragmentProgramIDList
std::string _fragmentProgram
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

FragmentProgram - encapsulates the OpenGL ARB fragment program state.

Member Typedef Documentation

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

Constructor & Destructor Documentation

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

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::FragmentProgram::~FragmentProgram ( )
protectedvirtual

Member Function Documentation

virtual void osg::FragmentProgram::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::FragmentProgram::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::FragmentProgram::compileGLObjects ( State ) const
inlinevirtual

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

Reimplemented from osg::StateAttribute.

static void osg::FragmentProgram::deleteFragmentProgramObject ( unsigned int  contextID,
GLuint  handle 
)
static

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

void osg::FragmentProgram::dirtyFragmentProgramObject ( )

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

static void osg::FragmentProgram::discardDeletedFragmentProgramObjects ( unsigned int  contextID)
static

discard all the cached fragment 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::FragmentProgram::flushDeletedFragmentProgramObjects ( unsigned int  contextID,
double  currentTime,
double &  availableTime 
)
static

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

static Extensions* osg::FragmentProgram::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 has 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..

const std::string& osg::FragmentProgram::getFragmentProgram ( ) const
inline

Get the fragment program.

GLuint& osg::FragmentProgram::getFragmentProgramID ( unsigned int  contextID) const
inline

Get the handle to the fragment program id for the current context.

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

Get list of Program Parameters

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

Get const list of Program Parameters

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

Get list of Matrices

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

Get list of Matrices

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

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

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

osg::FragmentProgram::META_StateAttribute ( osg  ,
FragmentProgram  ,
FRAGMENTPROGRAM   
)
virtual void osg::FragmentProgram::releaseGLObjects ( State state = 0) const
virtual

release an 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.

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

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::StateAttribute.

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

setExtensions 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::FragmentProgram::setFragmentProgram ( const char *  program)
inline

Set the fragment program using a C style string.

void osg::FragmentProgram::setFragmentProgram ( const std::string &  program)
inline

Set the fragment program using C++ style string.

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

Set list of Program Parameters

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

Set list of Matrices

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

Matrix

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

Set Program Parameters

Member Data Documentation

std::string osg::FragmentProgram::_fragmentProgram
protected
FragmentProgramIDList osg::FragmentProgram::_fragmentProgramIDList
mutableprotected
MatrixList osg::FragmentProgram::_matrixList
protected
LocalParamList osg::FragmentProgram::_programLocalParameters
protected

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