openscenegraph
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osg::FragmentProgram Class Reference

#include <FragmentProgram>

Inheritance diagram for osg::FragmentProgram:
osg::StateAttribute osg::Object osg::Referenced

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 , INDIRECTDRAWBUFFERBINDING , VIEWPORTINDEXED ,
  DEPTHRANGEINDEXED , SCISSORINDEXED , BINDIMAGETEXTURE , SAMPLER ,
  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 StateSet * asStateSet ()
virtual const StateSet * asStateSet () const
virtual Uniform * asUniform ()
virtual const Uniform * asUniform () const
virtual Camera * asCamera ()
virtual const Camera * asCamera () const
virtual Drawable * asDrawable ()
virtual const Drawable * asDrawable () const
virtual Callback * asCallback ()
virtual const Callback * asCallback () const
virtual CallbackObject * asCallbackObject ()
virtual const CallbackObject * asCallbackObject () const
virtual UserDataContainer * asUserDataContainer ()
virtual const UserDataContainer * asUserDataContainer () const
virtual ValueObject * asValueObject ()
virtual const ValueObject * asValueObject () const
virtual Image * asImage ()
virtual const Image * asImage () 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)
template<class T>
void setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainer * getUserDataContainer ()
const osg::UserDataContainer * getUserDataContainer () const
osg::UserDataContainer * getOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
template<class T>
void setUserData (const ref_ptr< T > &ud)
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

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

Additional Inherited Members

Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandler * getDeleteHandler ()

Detailed Description

FragmentProgram - encapsulates the OpenGL ARB fragment program state.

Member Typedef Documentation

◆ FragmentProgramIDList

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

◆ LocalParamList

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

◆ MatrixList

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

Constructor & Destructor Documentation

◆ FragmentProgram() [1/2]

osg::FragmentProgram::FragmentProgram ( )

Referenced by compare(), FragmentProgram(), and META_StateAttribute().

◆ FragmentProgram() [2/2]

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

Copy constructor using CopyOp to manage deep vs shallow copy.

References FragmentProgram(), and osg::CopyOp::SHALLOW_COPY.

◆ ~FragmentProgram()

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

Member Function Documentation

◆ apply()

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.

Referenced by compileGLObjects().

◆ compare()

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 _fragmentProgram, COMPARE_StateAttribute_Parameter, COMPARE_StateAttribute_Types, and FragmentProgram().

◆ compileGLObjects()

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

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

Reimplemented from osg::StateAttribute.

References apply().

◆ dirtyFragmentProgramObject()

void osg::FragmentProgram::dirtyFragmentProgramObject ( )

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

Referenced by setFragmentProgram(), and setFragmentProgram().

◆ getFragmentProgram()

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

Get the fragment program.

References _fragmentProgram.

◆ getFragmentProgramID()

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

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

References _fragmentProgramIDList.

◆ getLocalParameters() [1/2]

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

Get list of Program Parameters

References _programLocalParameters.

◆ getLocalParameters() [2/2]

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

Get const list of Program Parameters

References _programLocalParameters.

◆ getMatrices() [1/2]

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

Get list of Matrices

References _matrixList.

◆ getMatrices() [2/2]

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

Get list of Matrices

References _matrixList.

◆ getModeUsage()

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().

◆ META_StateAttribute()

osg::FragmentProgram::META_StateAttribute ( osg ,
FragmentProgram ,
FRAGMENTPROGRAM  )

References osg::StateAttribute::FRAGMENTPROGRAM, and FragmentProgram().

◆ releaseGLObjects()

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.

◆ resizeGLObjectBuffers()

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

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::StateAttribute.

◆ setFragmentProgram() [1/2]

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

Set the fragment program using a C style string.

References _fragmentProgram, and dirtyFragmentProgramObject().

◆ setFragmentProgram() [2/2]

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

Set the fragment program using C++ style string.

References _fragmentProgram, and dirtyFragmentProgramObject().

◆ setLocalParameters()

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

Set list of Program Parameters

References _programLocalParameters.

◆ setMatrices()

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

Set list of Matrices

References _matrixList.

◆ setMatrix()

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

Matrix

References _matrixList.

◆ setProgramLocalParameter()

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

Set Program Parameters

References _programLocalParameters.

Member Data Documentation

◆ _fragmentProgram

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

Referenced by compare(), getFragmentProgram(), setFragmentProgram(), and setFragmentProgram().

◆ _fragmentProgramIDList

FragmentProgramIDList osg::FragmentProgram::_fragmentProgramIDList
mutableprotected

Referenced by getFragmentProgramID().

◆ _matrixList

MatrixList osg::FragmentProgram::_matrixList
protected

Referenced by getMatrices(), getMatrices(), setMatrices(), and setMatrix().

◆ _programLocalParameters

LocalParamList osg::FragmentProgram::_programLocalParameters
protected

Referenced by getLocalParameters(), getLocalParameters(), setLocalParameters(), and setProgramLocalParameter().

The documentation for this class was generated from the following file:
Generated by doxygen 1.15.0