Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

osg::FragmentProgram Class Reference

Inheritance diagram for osg::FragmentProgram:

osg::StateAttribute osg::Object osg::Referenced List of all members.

Public Types

typedef std::map< GLuint,
Vec4
LocalParamList

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 (ModeUsage &usage) const
GLuint & getFragmentProgramID (unsigned int contextID) const
void setFragmentProgram (const std::string &program)
void setFragmentProgram (const char *program)
const std::string & getFragmentProgram () const
void setProgramLocalParameter (const GLuint index, const Vec4 &p)
LocalParamListgetLocalParamList ()
const LocalParamListgetLocalParamList () const
void setMatrix (const GLenum mode, const Matrix &matrix)
void dirtyFragmentProgramObject ()
virtual void apply (State &state) const
virtual void compileGLObjects (State &state) const
virtual void releaseGLObjects (State *state=0) const

Static Public Member Functions

static void deleteFragmentProgramObject (unsigned int contextID, GLuint handle)
static void flushDeletedFragmentProgramObjects (unsigned int contextID, double currentTime, double &availableTime)
static ExtensionsgetExtensions (unsigned int contextID, bool createIfNotInitalized)
static void setExtensions (unsigned int contextID, Extensions *extensions)

Protected Types

typedef buffered_value< GLuint > FragmentProgramIDList
typedef std::map< GLenum,
Matrix
MatrixList

Protected Member Functions

virtual ~FragmentProgram ()

Protected Attributes

FragmentProgramIDList _fragmentProgramIDList
std::string _fragmentProgram
LocalParamList _programLocalParameters
MatrixList _matrixList

Classes

class  Extensions

Detailed Description

FragmentProgram - encapsulates the OpenGL ARB fragment program state.


Member Typedef Documentation

typedef buffered_value<GLuint> osg::FragmentProgram::FragmentProgramIDList [protected]
 

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

typedef std::map<GLenum,Matrix> osg::FragmentProgram::MatrixList [protected]
 


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  )  [protected, virtual]
 


Member Function Documentation

virtual void osg::FragmentProgram::apply State state  )  const [virtual]
 

apply the OpenGL state attributes. The global state for the current OpenGL context is passed in to allow the StateAttribute to obtain details on the the current context and state.

Implements osg::StateAttribute.

virtual int osg::FragmentProgram::compare const osg::StateAttribute sa  )  const [inline, virtual]
 

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

virtual void osg::FragmentProgram::compileGLObjects State state  )  const [inline, virtual]
 

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::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.

const LocalParamList& osg::FragmentProgram::getLocalParamList  )  const [inline]
 

Get const list of Program Parameters

LocalParamList& osg::FragmentProgram::getLocalParamList  )  [inline]
 

Get list of Program Parameters

virtual bool osg::FragmentProgram::getModeUsage ModeUsage &  usage  )  const [inline, virtual]
 

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

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 objexts for all graphics context if State object pointer == NULL.

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::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 [mutable, protected]
 

MatrixList osg::FragmentProgram::_matrixList [protected]
 

LocalParamList osg::FragmentProgram::_programLocalParameters [protected]
 


The documentation for this class was generated from the following file:
Generated on Tue Mar 22 14:15:05 2005 for openscenegraph by  doxygen 1.4.0