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

Classes

class  PerContextShader
 
struct  ShaderObjects
 

Public Types

enum  Type {
  VERTEX = GL_VERTEX_SHADER, TESSCONTROL = GL_TESS_CONTROL_SHADER, TESSEVALUATION = GL_TESS_EVALUATION_SHADER, GEOMETRY = GL_GEOMETRY_SHADER,
  FRAGMENT = GL_FRAGMENT_SHADER, COMPUTE = GL_COMPUTE_SHADER, UNDEFINED = -1
}
 
enum  ShaderDefinesMode { USE_SHADER_PRAGMA, USE_MANUAL_SETTINGS }
 
typedef std::multimap< float, std::string > CodeInjectionMap
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 Shader (Type type=UNDEFINED)
 
 Shader (Type type, const std::string &source)
 
 Shader (Type type, ShaderBinary *shaderBinary)
 
 Shader (const Shader &rhs, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
 META_Object (osg, Shader)
 
int compare (const Shader &rhs) const
 
bool setType (Type t)
 
Type getType () const
 
const char * getTypename () const
 
void setFileName (const std::string &fileName)
 
const std::string & getFileName () const
 
void setShaderSource (const std::string &sourceText)
 
const std::string & getShaderSource () const
 
void setShaderDefinesMode (ShaderDefinesMode sdm)
 
ShaderDefinesMode getShaderDefinesMode () const
 
void setShaderDefines (const ShaderDefines &shaderDefs)
 
ShaderDefinesgetShaderDefines ()
 
const ShaderDefinesgetShaderDefines () const
 
void setShaderRequirements (const ShaderDefines &shaderDefs)
 
ShaderDefinesgetShaderRequirements ()
 
const ShaderDefinesgetShaderRequirements () const
 
void setShaderBinary (ShaderBinary *shaderBinary)
 
ShaderBinarygetShaderBinary ()
 
const ShaderBinarygetShaderBinary () const
 
bool loadShaderSourceFromFile (const std::string &fileName)
 
void addCodeInjection (float position, const std::string &code)
 
CodeInjectionMapgetCodeInjectionMap ()
 
const CodeInjectionMapgetCodeInjectionMap () const
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 
void releaseGLObjects (osg::State *state=0) const
 
void dirtyShader ()
 
void compileShader (osg::State &state) const
 
PerContextShadergetPCS (osg::State &state) const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 
virtual Objectclone (const CopyOp &) const =0
 
virtual bool isSameKindAs (const Object *) const
 
virtual const char * libraryName () const =0
 
virtual const char * className () const =0
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () 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::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)
 
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 &)
 
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 ShaderreadShaderFile (Type type, const std::string &fileName)
 
static void deleteGlShader (unsigned int contextID, GLuint shader)
 
static void flushDeletedGlShaders (unsigned int contextID, double currentTime, double &availableTime)
 
static void discardDeletedGlShaders (unsigned int contextID)
 
static Shader::Type getTypeId (const std::string &tname)
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Protected Types

typedef std::set< osg::Program * > ProgramSet
 

Protected Member Functions

virtual ~Shader ()
 
bool addProgramRef (osg::Program *program)
 
bool removeProgramRef (osg::Program *program)
 
void _computeShaderDefines ()
 
void _parseShaderDefines (const std::string &str, ShaderDefines &defines)
 
- 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

Type _type
 
std::string _shaderFileName
 
std::string _shaderSource
 
osg::ref_ptr< ShaderBinary_shaderBinary
 
CodeInjectionMap _codeInjectionMap
 
ShaderDefinesMode _shaderDefinesMode
 
ShaderDefines _shaderDefines
 
ShaderDefines _shaderRequirements
 
ProgramSet _programSet
 
osg::buffered_value< osg::ref_ptr< ShaderObjects > > _pcsList
 
- 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
 

Friends

class osg::Program
 

Detailed Description

osg::Shader is an application-level abstraction of an OpenGL glShader. It is a container to load the shader source code text and manage its compilation. An osg::Shader may be attached to more than one osg::Program. Shader will automatically manage per-context instancing of the internal objects, if that is necessary for a particular display configuration.

Member Typedef Documentation

typedef std::multimap<float, std::string> osg::Shader::CodeInjectionMap

The code injection map used when generating the main shader during main shader composition.

typedef std::set< osg::Program* > osg::Shader::ProgramSet
protected

osg::Programs that this osg::Shader is attached to

Member Enumeration Documentation

Enumerator
USE_SHADER_PRAGMA 
USE_MANUAL_SETTINGS 
Enumerator
VERTEX 
TESSCONTROL 
TESSEVALUATION 
GEOMETRY 
FRAGMENT 
COMPUTE 
UNDEFINED 

Constructor & Destructor Documentation

osg::Shader::Shader ( Type  type = UNDEFINED)
osg::Shader::Shader ( Type  type,
const std::string &  source 
)
osg::Shader::Shader ( Type  type,
ShaderBinary shaderBinary 
)
osg::Shader::Shader ( const Shader rhs,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::Shader::~Shader ( )
protectedvirtual

Member Function Documentation

void osg::Shader::_computeShaderDefines ( )
protected
void osg::Shader::_parseShaderDefines ( const std::string &  str,
ShaderDefines defines 
)
protected
void osg::Shader::addCodeInjection ( float  position,
const std::string &  code 
)
inline

Add code injection that will be placed in the main shader to enable support for this shader. The position is set up so that code to be inserted before the main() will have a negative value, a position between 0 and 1.0 will be inserted in main() and a position greater than 1.0 will be placed after the main(). During shader composition all the code injections are sorted in ascending order and then placed in the appropriate section of the main shader.

bool osg::Shader::addProgramRef ( osg::Program program)
protected
int osg::Shader::compare ( const Shader rhs) const
void osg::Shader::compileShader ( osg::State state) const

If needed, compile the PCS's glShader

static void osg::Shader::deleteGlShader ( unsigned int  contextID,
GLuint  shader 
)
static

Mark internal glShader for deletion. Deletion requests are queued until they can be executed in the proper GL context.

void osg::Shader::dirtyShader ( )

Mark our PCSs as needing recompilation. Also mark Programs that depend on us as needing relink

static void osg::Shader::discardDeletedGlShaders ( unsigned int  contextID)
static

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

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

CodeInjectionMap& osg::Shader::getCodeInjectionMap ( )
inline

Get the code injection map.

const CodeInjectionMap& osg::Shader::getCodeInjectionMap ( ) const
inline

Get the const code injection map.

const std::string& osg::Shader::getFileName ( ) const
inline

Get filename to which the shader source code belongs.

PerContextShader* osg::Shader::getPCS ( osg::State state) const
ShaderBinary* osg::Shader::getShaderBinary ( )
inline

Get the Shader's ShaderBinary, return NULL if none is assigned.

const ShaderBinary* osg::Shader::getShaderBinary ( ) const
inline

Get the const Shader's ShaderBinary, return NULL if none is assigned.

ShaderDefines& osg::Shader::getShaderDefines ( )
inline
const ShaderDefines& osg::Shader::getShaderDefines ( ) const
inline
ShaderDefinesMode osg::Shader::getShaderDefinesMode ( ) const
inline
ShaderDefines& osg::Shader::getShaderRequirements ( )
inline
const ShaderDefines& osg::Shader::getShaderRequirements ( ) const
inline
const std::string& osg::Shader::getShaderSource ( ) const
inline

Query the shader's source code text

Type osg::Shader::getType ( ) const
inline

Get the Shader type as an enum.

static Shader::Type osg::Shader::getTypeId ( const std::string &  tname)
static
const char* osg::Shader::getTypename ( ) const

Get the Shader type as a descriptive string.

bool osg::Shader::loadShaderSourceFromFile ( const std::string &  fileName)

Load the Shader's source code text from a file.

osg::Shader::META_Object ( osg  ,
Shader   
)
static Shader* osg::Shader::readShaderFile ( Type  type,
const std::string &  fileName 
)
static

Read shader source from file and then constructor shader of specified type. Return the resulting Shader or 0 if no valid shader source could be read.

void osg::Shader::releaseGLObjects ( osg::State state = 0) const
virtual

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

bool osg::Shader::removeProgramRef ( osg::Program program)
protected
virtual void osg::Shader::resizeGLObjectBuffers ( unsigned int  maxSize)
virtual

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Object.

void osg::Shader::setFileName ( const std::string &  fileName)
inline

Set file name for the shader source code.

void osg::Shader::setShaderBinary ( ShaderBinary shaderBinary)
inline

Set the Shader using a ShaderBinary.

void osg::Shader::setShaderDefines ( const ShaderDefines shaderDefs)
inline
void osg::Shader::setShaderDefinesMode ( ShaderDefinesMode  sdm)
inline
void osg::Shader::setShaderRequirements ( const ShaderDefines shaderDefs)
inline
void osg::Shader::setShaderSource ( const std::string &  sourceText)

Set the Shader's source code text from a string.

bool osg::Shader::setType ( Type  t)

Set the Shader type as an enum.

Friends And Related Function Documentation

friend class osg::Program
friend

Member Data Documentation

CodeInjectionMap osg::Shader::_codeInjectionMap
protected
osg::buffered_value< osg::ref_ptr<ShaderObjects> > osg::Shader::_pcsList
mutableprotected
ProgramSet osg::Shader::_programSet
protected
osg::ref_ptr<ShaderBinary> osg::Shader::_shaderBinary
protected
ShaderDefines osg::Shader::_shaderDefines
protected
ShaderDefinesMode osg::Shader::_shaderDefinesMode
protected
std::string osg::Shader::_shaderFileName
protected
ShaderDefines osg::Shader::_shaderRequirements
protected
std::string osg::Shader::_shaderSource
protected
Type osg::Shader::_type
protected

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