OSG  3.4.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osg::FragmentProgram Class Reference

#include <FragmentProgram.h>

Inheritance diagram for osg::FragmentProgram:
Inheritance graph
[legend]
Collaboration diagram for osg::FragmentProgram:
Collaboration graph
[legend]

Public Types

typedef std::map< GLuint, Vec4 > LocalParamList
 
typedef std::map< GLenum, Matrix > MatrixList
 
- 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, SAMPLEMASKI,
  PRIMITIVERESTARTINDEX, CLIPCONTROL, 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,
  VERTEX_ATTRIB_DIVISOR, SHADERSTORAGEBUFFERBINDING, CAPABILITY = 100
}
 
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)
 
LocalParamList & getLocalParameters ()
 
const LocalParamList & getLocalParameters () const
 
void setMatrix (const GLenum mode, const Matrix &matrix)
 
void setMatrices (const MatrixList &matrices)
 
MatrixList & getMatrices ()
 
const MatrixList & getMatrices () 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 Object * cloneType () const =0
 
virtual Object * clone (const CopyOp &) const =0
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual StateAttribute * asStateAttribute ()
 
virtual const StateAttribute * asStateAttribute () const
 
virtual Texture * asTexture ()
 
virtual const Texture * asTexture () 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 ParentList & getParents () const
 
StateSet * getParent (unsigned int i)
 
const StateSet * getParent (unsigned int i) const
 
unsigned int getNumParents () const
 
void setShaderComponent (ShaderComponent *sc)
 
ShaderComponent * getShaderComponent ()
 
const ShaderComponent * getShaderComponent () const
 
virtual bool checkValidityOfAssociatedModes (osg::State &) const
 
void setUpdateCallback (StateAttributeCallback *uc)
 
StateAttributeCallback * getUpdateCallback ()
 
const StateAttributeCallback * getUpdateCallback () const
 
void setEventCallback (StateAttributeCallback *ec)
 
StateAttributeCallback * getEventCallback ()
 
const StateAttributeCallback * getEventCallback () const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
std::string getCompoundClassName () const
 
virtual Node * asNode ()
 
virtual const Node * asNode () const
 
virtual NodeVisitor * asNodeVisitor ()
 
virtual const NodeVisitor * asNodeVisitor () const
 
virtual Uniform * asUniform ()
 
virtual const Uniform * asUniform () const
 
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::UserDataContainer * getUserDataContainer ()
 
const osg::UserDataContainer * getUserDataContainer () const
 
osg::UserDataContainer * getOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
virtual Referenced * getUserData ()
 
virtual const Referenced * getUserData () 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)
 
template<typename T >
BoolValueObject
UCharValueObject
UShortValueObject
UIntValueObject
DoubleValueObject
Vec3fValueObject
Vec2dValueObject
Vec4dValueObject
PlaneValueObject
MatrixdValueObject
BoundingBoxdValueObject
BoundingSpheredValueObject
bool 		getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referenced & operator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::Mutex * getRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSet * getObserverSet () const
 
ObserverSet * getOrCreateObserverSet () 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 Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandler * getDeleteHandler ()
 

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.

Definition at line 115 of file FragmentProgram.h.

Member Typedef Documentation

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

Definition at line 242 of file FragmentProgram.h.

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

Definition at line 177 of file FragmentProgram.h.

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

Definition at line 194 of file FragmentProgram.h.

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.

Definition at line 127 of file FragmentProgram.h.

virtual void osg::FragmentProgram::compileGLObjects ( State &  ) const
inlinevirtual

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

Reimplemented from osg::StateAttribute.

Definition at line 227 of file FragmentProgram.h.

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.

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

Get the fragment program.

Definition at line 169 of file FragmentProgram.h.

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

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

Definition at line 148 of file FragmentProgram.h.

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

Get list of Program Parameters

Definition at line 183 of file FragmentProgram.h.

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

Get const list of Program Parameters

Definition at line 186 of file FragmentProgram.h.

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

Get list of Matrices

Definition at line 200 of file FragmentProgram.h.

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

Get list of Matrices

Definition at line 203 of file FragmentProgram.h.

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

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

Definition at line 139 of file FragmentProgram.h.

Here is the call graph for this function:

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.

void osg::FragmentProgram::setFragmentProgram ( const char *  program)
inline

Set the fragment program using a C style string.

Definition at line 155 of file FragmentProgram.h.

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

Set the fragment program using C++ style string.

Definition at line 162 of file FragmentProgram.h.

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

Set list of Program Parameters

Definition at line 180 of file FragmentProgram.h.

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

Set list of Matrices

Definition at line 197 of file FragmentProgram.h.

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

Matrix

Definition at line 189 of file FragmentProgram.h.

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

Set Program Parameters

Definition at line 172 of file FragmentProgram.h.

Member Data Documentation

std::string osg::FragmentProgram::_fragmentProgram
protected

Definition at line 245 of file FragmentProgram.h.

FragmentProgramIDList osg::FragmentProgram::_fragmentProgramIDList
mutableprotected

Definition at line 243 of file FragmentProgram.h.

MatrixList osg::FragmentProgram::_matrixList
protected

Definition at line 248 of file FragmentProgram.h.

LocalParamList osg::FragmentProgram::_programLocalParameters
protected

Definition at line 247 of file FragmentProgram.h.

The documentation for this class was generated from the following file:
Generated on Tue Oct 4 2016 19:20:50 for OSG by   doxygen 1.8.8