OpenSceneGraph
Classes | Public Types | Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osg::State Class Reference

Encapsulates the current applied OpenGL modes, attributes and vertex arrays settings, implements lazy state updating and provides accessors for querying the current state. More...

Inheritance diagram for osg::State:
Inheritance graph
[legend]

Classes

struct  ApplyModeProxy
 Proxy helper class for applyig a model in a local scope, with the preivous value being resotred automatically on leaving the scope that proxy was created. More...
 
struct  ApplyTextureModeProxy
 
struct  AttributeStack
 
struct  DefineMap
 
struct  DefineStack
 
struct  DynamicObjectRenderingCompletedCallback
 
struct  ModeStack
 
struct  SetCurrentVertexArrayStateProxy
 Proxy helper class for applyig a VertexArrayState in a local scope, with the preivous value being resotred automatically on leaving the scope that proxy was created. More...
 
struct  UniformStack
 

Public Types

enum  CheckForGLErrors { NEVER_CHECK_GL_ERRORS, ONCE_PER_FRAME, ONCE_PER_ATTRIBUTE }
 
typedef std::map< const std::type_info *, osg::ref_ptr< osg::Referenced > > ExtensionMap
 
typedef std::vector< const StateSet * > StateSetStack
 
typedef std::vector< VertexAttribAliasVertexAttribAliasList
 
typedef std::vector< GLushort > IndicesGLushort
 
typedef std::vector< GLuint > IndicesGLuint
 
typedef std::pair< const StateAttribute *, StateAttribute::OverrideValueAttributePair
 
typedef std::vector< AttributePairAttributeVec
 
typedef std::map< std::string, GLenum > StringModeMap
 
typedef std::map< GLenum, std::string > ModeDefineMap
 
typedef std::vector< ModeDefineMapTextureModeDefineMapList
 
typedef std::map< StateAttribute::GLMode, ModeStackModeMap
 
typedef std::vector< ModeMapTextureModeMapList
 
typedef std::map< StateAttribute::TypeMemberPair, AttributeStackAttributeMap
 
typedef std::vector< AttributeMapTextureAttributeMapList
 
typedef std::map< std::string, UniformStackUniformMap
 
typedef std::vector< ref_ptr< const Matrix > > MatrixStack
 

Public Member Functions

 State ()
 
void setGraphicsContext (GraphicsContext *context)
 Set the graphics context associated with that owns this State object. More...
 
GraphicsContextgetGraphicsContext ()
 Get the graphics context associated with that owns this State object. More...
 
const GraphicsContextgetGraphicsContext () const
 Get the const graphics context associated with that owns this State object. More...
 
void setContextID (unsigned int contextID)
 Set the current OpenGL context uniqueID. More...
 
unsigned int getContextID () const
 Get the current OpenGL context unique ID. More...
 
template<typename T >
T * get ()
 Get a specific GL extensions object or GraphicsObjectManager, initialize if not already present. More...
 
template<typename T >
const T * get () const
 Get a specific GL extensions object or GraphicsObjectManager if it already exists in the extension map. More...
 
template<typename T >
void set (T *ptr)
 Set a specific GL extensions object pr GraphicsObjectManager. More...
 
void setShaderCompositionEnabled (bool flag)
 
bool getShaderCompositionEnabled () const
 
void setShaderComposer (ShaderComposer *sc)
 deprecated. More...
 
ShaderComposergetShaderComposer ()
 deprecated. More...
 
const ShaderComposergetShaderComposer () const
 deprecated. More...
 
StateSet::UniformListgetCurrentShaderCompositionUniformList ()
 Get the unform list in which to inject any uniforms that StateAttribute::apply(State&) methods provide. More...
 
void applyShaderCompositionUniform (const osg::UniformBase *uniform, StateAttribute::OverrideValue value=StateAttribute::ON)
 Convenience method for StateAttribute::apply(State&) methods to pass on their uniforms to osg::State so it can apply them at the appropriate point. More...
 
void applyShaderCompositionDefines (const StateSet::DefineList &defineList)
 Convenience method for StateAttribute::apply(State&) methods to pass on their defines to osg::State so it can apply them at the appropriate point. More...
 
void pushStateSet (const StateSet *dstate)
 Push stateset onto state stack. More...
 
void popStateSet ()
 Pop stateset off state stack. More...
 
void popAllStateSets ()
 pop all statesets off state stack, ensuring it is empty ready for the next frame. More...
 
void insertStateSet (unsigned int pos, const StateSet *dstate)
 Insert stateset onto state stack. More...
 
void removeStateSet (unsigned int pos)
 Pop stateset off state stack. More...
 
unsigned int getStateSetStackSize ()
 Get the number of StateSet's on the StateSet stack. More...
 
void popStateSetStackToSize (unsigned int size)
 Pop StateSet's for the StateSet stack till its size equals the specified size. More...
 
StateSetStackgetStateSetStack ()
 Get the StateSet stack. More...
 
void captureCurrentState (StateSet &stateset) const
 Copy the modes and attributes which capture the current state. More...
 
void releaseGLObjects ()
 Release all OpenGL objects associated cached by this osg::State object. More...
 
void reset ()
 reset the state object to an empty stack. More...
 
const ViewportgetCurrentViewport () const
 
void setUseStateAttributeShaders (bool flag)
 
bool getUseStateAttributeShaders () const
 
void setUseStateAttributeFixedFunction (bool flag)
 
bool getUseStateAttributeFixedFunction () const
 
void setUseModelViewAndProjectionUniforms (bool flag)
 
bool getUseModelViewAndProjectionUniforms () const
 
void setUseVertexAttributeAliasing (bool flag)
 
bool getUseVertexAttributeAliasing () const
 
void setInitialViewMatrix (const osg::RefMatrix *matrix)
 
const osg::MatrixgetInitialViewMatrix () const
 
const osg::MatrixgetInitialInverseViewMatrix () const
 
void applyProjectionMatrix (const osg::RefMatrix *matrix)
 
const osg::MatrixgetProjectionMatrix () const
 
void applyModelViewMatrix (const osg::RefMatrix *matrix)
 
void applyModelViewMatrix (const osg::Matrix &)
 
const osg::MatrixgetModelViewMatrix () const
 
void updateModelViewAndProjectionMatrixUniforms ()
 
void applyModelViewAndProjectionUniformsIfRequired ()
 
osg::Uniform * getModelViewMatrixUniform ()
 
osg::Uniform * getProjectionMatrixUniform ()
 
osg::Uniform * getModelViewProjectionMatrixUniform ()
 
osg::Uniform * getNormalMatrixUniform ()
 
Polytope getViewFrustum () const
 
void resetVertexAttributeAlias (bool compactAliasing=true, unsigned int numTextureUnits=8)
 Reset the vertex attribute aliasing to osg's default. More...
 
void setVertexAlias (const VertexAttribAlias &alias)
 Set the vertex attribute aliasing for "vertex". More...
 
const VertexAttribAliasgetVertexAlias ()
 
void setNormalAlias (const VertexAttribAlias &alias)
 Set the vertex attribute aliasing for "normal". More...
 
const VertexAttribAliasgetNormalAlias ()
 
void setColorAlias (const VertexAttribAlias &alias)
 Set the vertex attribute aliasing for "color". More...
 
const VertexAttribAliasgetColorAlias ()
 
void setSecondaryColorAlias (const VertexAttribAlias &alias)
 Set the vertex attribute aliasing for "secondary color". More...
 
const VertexAttribAliasgetSecondaryColorAlias ()
 
void setFogCoordAlias (const VertexAttribAlias &alias)
 Set the vertex attribute aliasing for "fog coord". More...
 
const VertexAttribAliasgetFogCoordAlias ()
 
void setTexCoordAliasList (const VertexAttribAliasList &aliasList)
 Set the vertex attribute aliasing list for texture coordinates. More...
 
const VertexAttribAliasListgetTexCoordAliasList ()
 
void setAttributeBindingList (const Program::AttribBindingList &attribBindingList)
 Set the vertex attribute binding list. More...
 
const Program::AttribBindingListgetAttributeBindingList ()
 
bool convertVertexShaderSourceToOsgBuiltIns (std::string &source) const
 
void apply (const StateSet *dstate)
 Apply stateset. More...
 
void apply ()
 Updates the OpenGL state so that it matches the StateSet at the top of the stack of StateSets maintained internally by a State. More...
 
void applyShaderComposition ()
 Apply any shader composed state. More...
 
void glDrawBuffer (GLenum buffer)
 
GLenum getDrawBuffer () const
 
void glReadBuffer (GLenum buffer)
 
GLenum getReadBuffer () const
 
void setModeValidity (StateAttribute::GLMode mode, bool valid)
 Set whether a particular OpenGL mode is valid in the current graphics context. More...
 
bool getModeValidity (StateAttribute::GLMode mode)
 Get whether a particular OpenGL mode is valid in the current graphics context. More...
 
void setGlobalDefaultModeValue (StateAttribute::GLMode mode, bool enabled)
 
bool getGlobalDefaultModeValue (StateAttribute::GLMode mode)
 
bool getLastAppliedModeValue (StateAttribute::GLMode mode)
 
bool applyMode (StateAttribute::GLMode mode, bool enabled)
 Apply an OpenGL mode if required. More...
 
void setGlobalDefaultTextureModeValue (unsigned int unit, StateAttribute::GLMode mode, bool enabled)
 
bool getGlobalDefaultTextureModeValue (unsigned int unit, StateAttribute::GLMode mode)
 
bool applyTextureMode (unsigned int unit, StateAttribute::GLMode mode, bool enabled)
 
bool getLastAppliedTextureModeValue (unsigned int unit, StateAttribute::GLMode mode)
 
void setGlobalDefaultAttribute (const StateAttribute *attribute)
 
const StateAttributegetGlobalDefaultAttribute (StateAttribute::Type type, unsigned int member=0)
 
bool applyAttribute (const StateAttribute *attribute)
 Apply an attribute if required. More...
 
void setGlobalDefaultTextureAttribute (unsigned int unit, const StateAttribute *attribute)
 
const StateAttributegetGlobalDefaultTextureAttribute (unsigned int unit, StateAttribute::Type type, unsigned int member=0)
 
bool applyTextureAttribute (unsigned int unit, const StateAttribute *attribute)
 
void haveAppliedMode (StateAttribute::GLMode mode, StateAttribute::GLModeValue value)
 Mode has been set externally, update state to reflect this setting. More...
 
void haveAppliedMode (StateAttribute::GLMode mode)
 Mode has been set externally, therefore dirty the associated mode in osg::State so it is applied on next call to osg::State::apply(..) More...
 
void haveAppliedAttribute (const StateAttribute *attribute)
 Attribute has been applied externally, update state to reflect this setting. More...
 
void haveAppliedAttribute (StateAttribute::Type type, unsigned int member=0)
 Attribute has been applied externally, and therefore this attribute type has been dirtied and will need to be re-applied on next osg::State.apply(..). More...
 
bool getLastAppliedMode (StateAttribute::GLMode mode) const
 Get whether the current specified mode is enabled (true) or disabled (false). More...
 
const StateAttributegetLastAppliedAttribute (StateAttribute::Type type, unsigned int member=0) const
 Get the current specified attribute, return NULL if one has not yet been applied. More...
 
void haveAppliedTextureMode (unsigned int unit, StateAttribute::GLMode mode, StateAttribute::GLModeValue value)
 texture Mode has been set externally, update state to reflect this setting. More...
 
void haveAppliedTextureMode (unsigned int unit, StateAttribute::GLMode mode)
 texture Mode has been set externally, therefore dirty the associated mode in osg::State so it is applied on next call to osg::State::apply(..) More...
 
void haveAppliedTextureAttribute (unsigned int unit, const StateAttribute *attribute)
 texture Attribute has been applied externally, update state to reflect this setting. More...
 
void haveAppliedTextureAttribute (unsigned int unit, StateAttribute::Type type, unsigned int member=0)
 texture Attribute has been applied externally, and therefore this attribute type has been dirtied and will need to be re-applied on next osg::State.apply(..). More...
 
bool getLastAppliedTextureMode (unsigned int unit, StateAttribute::GLMode mode) const
 Get whether the current specified texture mode is enabled (true) or disabled (false). More...
 
const StateAttributegetLastAppliedTextureAttribute (unsigned int unit, StateAttribute::Type type, unsigned int member=0) const
 Get the current specified texture attribute, return NULL if one has not yet been applied. More...
 
void dirtyAllModes ()
 Dirty the modes previously applied in osg::State. More...
 
void dirtyAllAttributes ()
 Dirty the modes attributes previously applied in osg::State. More...
 
void setCurrentVertexArrayState (VertexArrayState *vas)
 Set the CurrentVetexArrayState object that take which vertex arrays are bound. More...
 
VertexArrayStategetCurrentVertexArrayState () const
 Get the CurrentVetexArrayState object that take which vertex arrays are bound. More...
 
void setCurrentToGlobalVertexArrayState ()
 Set the getCurrentVertexArrayState to the GlobalVertexArrayState. More...
 
void resetCurrentVertexArrayStateOnMatch (VertexArrayState *vas)
 Reset the CurrentVertexArrayState/VertexArrayObject if it's value matches the specificied vas - use when deleting a vas. More...
 
void disableAllVertexArrays ()
 disable the vertex, normal, color, tex coords, secondary color, fog coord and index arrays. More...
 
void lazyDisablingOfVertexAttributes ()
 
void applyDisablingOfVertexAttributes ()
 
void setCurrentVertexBufferObject (osg::GLBufferObject *vbo)
 
const GLBufferObjectgetCurrentVertexBufferObject ()
 
void bindVertexBufferObject (osg::GLBufferObject *vbo)
 
void unbindVertexBufferObject ()
 
void setCurrentElementBufferObject (osg::GLBufferObject *ebo)
 
const GLBufferObjectgetCurrentElementBufferObject ()
 
void bindElementBufferObject (osg::GLBufferObject *ebo)
 
void unbindElementBufferObject ()
 
void setCurrentPixelBufferObject (osg::GLBufferObject *pbo)
 
const GLBufferObjectgetCurrentPixelBufferObject () const
 
void bindPixelBufferObject (osg::GLBufferObject *pbo)
 
void unbindPixelBufferObject ()
 
void bindDrawIndirectBufferObject (osg::GLBufferObject *ibo)
 
void unbindDrawIndirectBufferObject ()
 
void setCurrentVertexArrayObject (GLuint vao)
 
GLuint getCurrentVertexArrayObject () const
 
void bindVertexArrayObject (const VertexArrayState *vas)
 
void bindVertexArrayObject (GLuint vao)
 
void unbindVertexArrayObject ()
 
void drawQuads (GLint first, GLsizei count, GLsizei primCount=0)
 
void glDrawArraysInstanced (GLenum mode, GLint first, GLsizei count, GLsizei primcount)
 
void glDrawElementsInstanced (GLenum mode, GLsizei count, GLenum type, const GLvoid *indices, GLsizei primcount)
 
void Vertex (float x, float y, float z, float w=1.0f)
 
void Color (float r, float g, float b, float a=1.0f)
 
void Normal (float x, float y, float z)
 
void TexCoord (float x, float y=0.0f, float z=0.0f, float w=1.0f)
 
void MultiTexCoord (unsigned int unit, float x, float y=0.0f, float z=0.0f, float w=1.0f)
 
void VerteAttrib (unsigned int location, float x, float y=0.0f, float z=0.0f, float w=0.0f)
 
void setInterleavedArrays (GLenum format, GLsizei stride, const GLvoid *pointer)
 Wrapper around glInterleavedArrays(..). More...
 
void setVertexPointer (const Array *array)
 Set the vertex pointer using an osg::Array, and manage any VBO that are required. More...
 
void setVertexPointer (GLint size, GLenum type, GLsizei stride, const GLvoid *ptr, GLboolean normalized=GL_FALSE)
 
void disableVertexPointer ()
 
void setNormalPointer (const Array *array)
 
void setNormalPointer (GLenum type, GLsizei stride, const GLvoid *ptr, GLboolean normalized=GL_FALSE)
 
void disableNormalPointer ()
 
void setColorPointer (const Array *array)
 
void setColorPointer (GLint size, GLenum type, GLsizei stride, const GLvoid *ptr, GLboolean normalized=GL_TRUE)
 
void disableColorPointer ()
 
bool isSecondaryColorSupported () const
 
void setSecondaryColorPointer (const Array *array)
 
void disableSecondaryColorPointer ()
 
bool isFogCoordSupported () const
 
void setFogCoordPointer (const Array *array)
 
void disableFogCoordPointer ()
 
void setTexCoordPointer (unsigned int unit, const Array *array)
 
void setTexCoordPointer (unsigned int unit, GLint size, GLenum type, GLsizei stride, const GLvoid *ptr, GLboolean normalized=GL_FALSE)
 
void disableTexCoordPointer (unsigned int unit)
 
void disableTexCoordPointersAboveAndIncluding (unsigned int unit)
 
GLint getMaxTextureCoords () const
 For GL>=2.0 uses GL_MAX_TEXTURE_COORDS, for GL<2 uses GL_MAX_TEXTURE_UNITS. More...
 
GLint getMaxTextureUnits () const
 For GL>=2.0 uses GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS, for GL<2 uses GL_MAX_TEXTURE_UNITS. More...
 
bool setActiveTextureUnit (unsigned int unit)
 Set the current texture unit, return true if selected, false if selection failed such as when multi texturing is not supported. More...
 
unsigned int getActiveTextureUnit () const
 Get the current texture unit. More...
 
void setCurrentTextureFormat (GLenum format)
 Set the current texture format uniform. More...
 
bool setClientActiveTextureUnit (unsigned int unit)
 Set the current tex coord array texture unit, return true if selected, false if selection failed such as when multi texturing is not supported. More...
 
unsigned int getClientActiveTextureUnit () const
 Get the current tex coord array texture unit. More...
 
void setVertexAttribPointer (unsigned int unit, const Array *array)
 
void setVertexAttribLPointer (unsigned int unit, const Array *array)
 
void setVertexAttribIPointer (unsigned int unit, const Array *array)
 
void disableVertexAttribPointer (unsigned int index)
 
void disableVertexAttribPointersAboveAndIncluding (unsigned int index)
 
void dirtyAllVertexArrays ()
 dirty the vertex, normal, color, tex coords, secondary color, fog coord and index arrays. More...
 
bool isVertexBufferObjectSupported () const
 
bool useVertexBufferObject (bool useVBO) const
 
bool isVertexArrayObjectSupported () const
 
bool useVertexArrayObject (bool useVAO) const
 
void setLastAppliedProgramObject (const Program::PerContextProgram *program)
 
const Program::PerContextProgramgetLastAppliedProgramObject () const
 
GLint getUniformLocation (unsigned int uniformNameID) const
 
GLint getUniformLocation (const std::string &uniformName) const
 Alternative version of getUniformLocation( unsigned int uniformNameID ) retrofited into OSG for backward compatibility with osgCal, after uniform ids were refactored from std::strings to GLints in OSG version 2.9.10. More...
 
GLint getAttribLocation (const std::string &name) const
 
AttributeVecgetAttributeVec (const osg::StateAttribute *attribute)
 
void setFrameStamp (FrameStamp *fs)
 Set the frame stamp for the current frame. More...
 
FrameStampgetFrameStamp ()
 Get the frame stamp for the current frame. More...
 
const FrameStampgetFrameStamp () const
 Get the const frame stamp for the current frame. More...
 
void setDisplaySettings (DisplaySettings *vs)
 Set the DisplaySettings. More...
 
DisplaySettingsgetDisplaySettings ()
 Get the const DisplaySettings. More...
 
const DisplaySettingsgetDisplaySettings () const
 Get the const DisplaySettings. More...
 
DisplaySettingsgetActiveDisplaySettings ()
 Get the const DisplaySettings that is current active DisplaySettings to be used by osg::State, - if DisplaySettings is not directly assigned then fallback to DisplaySettings::instance(). More...
 
const DisplaySettingsgetActiveDisplaySettings () const
 Get the const DisplaySettings that is current active DisplaySettings to be used by osg::State, - if DisplaySettings is not directly assigned then fallback to DisplaySettings::instance(). More...
 
void setRootStateSet (osg::StateSet *stateset)
 Set the root StateSet this is applied above all StateSet that are pushed and popped during the draw traversal. More...
 
osg::StateSetgetRootStateSet ()
 Get the root StateSet. More...
 
void setAbortRenderingPtr (bool *abortPtr)
 Set flag for early termination of the draw traversal. More...
 
bool getAbortRendering () const
 Get flag for early termination of the draw traversal, if true steps should be taken to complete rendering early. More...
 
void setDynamicObjectRenderingCompletedCallback (DynamicObjectRenderingCompletedCallback *cb)
 Set the callback to be called when the dynamic object count hits 0. More...
 
DynamicObjectRenderingCompletedCallbackgetDynamicObjectRenderingCompletedCallback ()
 Get the callback to be called when the dynamic object count hits 0. More...
 
void setDynamicObjectCount (unsigned int count, bool callCallbackOnZero=false)
 Set the number of dynamic objects that will be rendered in this graphics context this frame. More...
 
unsigned int getDynamicObjectCount () const
 Get the number of dynamic objects that will be rendered in this graphics context this frame. More...
 
void decrementDynamicObjectCount ()
 Decrement the number of dynamic objects left to render this frame, and once the count goes to zero call the DynamicObjectRenderingCompletedCallback to inform of completion. More...
 
void setMaxTexturePoolSize (unsigned int size)
 
unsigned int getMaxTexturePoolSize () const
 
void setMaxBufferObjectPoolSize (unsigned int size)
 
unsigned int getMaxBufferObjectPoolSize () const
 
void setCheckForGLErrors (CheckForGLErrors check)
 Set whether and how often OpenGL errors should be checked for. More...
 
CheckForGLErrors getCheckForGLErrors () const
 Get whether and how often OpenGL errors should be checked for. More...
 
bool checkGLErrors (const char *str1=0, const char *str2=0) const
 
bool checkGLErrors (const std::string &str) const
 
bool checkGLErrors (StateAttribute::GLMode mode) const
 
bool checkGLErrors (const StateAttribute *attribute) const
 
void print (std::ostream &fout) const
 print out the internal details of osg::State - useful for debugging. More...
 
virtual void initializeExtensionProcs ()
 Initialize extension used by osg::State. More...
 
AttributeDispatchersgetAttributeDispatchers ()
 Get the helper class for dispatching osg::Arrays as OpenGL attribute data. More...
 
void setGraphicsCostEstimator (GraphicsCostEstimator *gce)
 Set the helper class that provides applications with estimate on how much different graphics operations will cost. More...
 
GraphicsCostEstimatorgetGraphicsCostEstimator ()
 Get the helper class that provides applications with estimate on how much different graphics operations will cost. More...
 
const GraphicsCostEstimatorgetGraphicsCostEstimator () const
 Get the cont helper class that provides applications with estimate on how much different graphics operations will cost. More...
 
Timer_t getStartTick () const
 Support for synchronizing the system time and the timestamp counter available with ARB_timer_query. More...
 
void setStartTick (Timer_t tick)
 
Timer_t getGpuTick () const
 
double getGpuTime () const
 
GLuint64 getGpuTimestamp () const
 
void setGpuTimestamp (Timer_t tick, GLuint64 timestamp)
 
int getTimestampBits () const
 
void setTimestampBits (int bits)
 
virtual void frameCompleted ()
 called by the GraphicsContext just before GraphicsContext::swapBuffersImplementation(). More...
 
StringModeMapgetStringModeMap ()
 
TextureModeDefineMapListgetTextureModeDefineMapList ()
 
ModeDefineMapgetTextureModeDefineMap (unsigned int i)
 
const ModeMapgetModeMap () const
 
const AttributeMapgetAttributeMap () const
 
const UniformMapgetUniformMap () const
 
DefineMapgetDefineMap ()
 
const DefineMapgetDefineMap () const
 
const TextureModeMapListgetTextureModeMapList () const
 
const TextureAttributeMapListgetTextureAttributeMapList () const
 
StateSet::DefineListgetCurrentShaderCompositionDefines ()
 
const StateSet::DefineListgetCurrentShaderCompositionDefines () const
 
void getDefineString (std::string &shaderDefineStr, const StateSet::DefineList &currentDefines, const osg::ShaderDefines &shaderDefines)
 
void getDefineString (std::string &shaderDefineStr, const osg::ShaderPragmas &shaderPragmas)
 
bool supportsShaderRequirements (const osg::ShaderPragmas &shaderPragmas)
 
bool supportsShaderRequirement (const std::string &shaderRequirement)
 
template<>
GLExtensionsget ()
 
template<>
const GLExtensionsget () const
 
template<>
void set (GLExtensions *ptr)
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
virtual void setThreadSafeRefUnref (bool)
 Deprecated, Referenced is always theadsafe so there method now has no effect and does not need to be called. More...
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Public Attributes

ExtensionMap _extensionMap
 
IndicesGLushort _quadIndicesGLushort [4]
 
IndicesGLuint _quadIndicesGLuint [4]
 

Protected Types

typedef void(GL_APIENTRY * ActiveTextureProc) (GLenum texture)
 
typedef void(GL_APIENTRY * FogCoordPointerProc) (GLenum type, GLsizei stride, const GLvoid *pointer)
 
typedef void(GL_APIENTRY * SecondaryColorPointerProc) (GLint size, GLenum type, GLsizei stride, const GLvoid *pointer)
 
typedef void(GL_APIENTRY * MultiTexCoord4fProc) (GLenum target, GLfloat x, GLfloat y, GLfloat z, GLfloat w)
 
typedef void(GL_APIENTRY * VertexAttrib4fProc) (GLuint index, GLfloat x, GLfloat y, GLfloat z, GLfloat w)
 
typedef void(GL_APIENTRY * VertexAttrib4fvProc) (GLuint index, const GLfloat *v)
 
typedef void(GL_APIENTRY * VertexAttribPointerProc) (unsigned int, GLint, GLenum, GLboolean normalized, GLsizei stride, const GLvoid *pointer)
 
typedef void(GL_APIENTRY * VertexAttribIPointerProc) (unsigned int, GLint, GLenum, GLsizei stride, const GLvoid *pointer)
 
typedef void(GL_APIENTRY * VertexAttribLPointerProc) (unsigned int, GLint, GLenum, GLsizei stride, const GLvoid *pointer)
 
typedef void(GL_APIENTRY * EnableVertexAttribProc) (unsigned int)
 
typedef void(GL_APIENTRY * DisableVertexAttribProc) (unsigned int)
 
typedef void(GL_APIENTRY * BindBufferProc) (GLenum target, GLuint buffer)
 
typedef void(GL_APIENTRY * DrawArraysInstancedProc) (GLenum mode, GLint first, GLsizei count, GLsizei primcount)
 
typedef void(GL_APIENTRY * DrawElementsInstancedProc) (GLenum mode, GLsizei count, GLenum type, const GLvoid *indices, GLsizei primcount)
 

Protected Member Functions

virtual ~State ()
 
void setUpVertexAttribAlias (VertexAttribAlias &alias, GLuint location, const std::string glName, const std::string osgName, const std::string &declaration)
 
bool applyMode (StateAttribute::GLMode mode, bool enabled, ModeStack &ms)
 Apply an OpenGL mode if required, passing in mode, enable flag and appropriate mode stack. More...
 
bool applyModeOnTexUnit (unsigned int unit, StateAttribute::GLMode mode, bool enabled, ModeStack &ms)
 
bool applyAttribute (const StateAttribute *attribute, AttributeStack &as)
 apply an attribute if required, passing in attribute and appropriate attribute stack More...
 
bool applyAttributeOnTexUnit (unsigned int unit, const StateAttribute *attribute, AttributeStack &as)
 
bool applyGlobalDefaultAttribute (AttributeStack &as)
 
bool applyGlobalDefaultAttributeOnTexUnit (unsigned int unit, AttributeStack &as)
 
virtual void initUpModeDefineMaps ()
 Initialize ModeDefineMaps used in fixed function modes to shader defines. More...
 
ModeMapgetOrCreateTextureModeMap (unsigned int unit)
 
AttributeMapgetOrCreateTextureAttributeMap (unsigned int unit)
 
void pushModeList (ModeMap &modeMap, const StateSet::ModeList &modeList)
 
void pushAttributeList (AttributeMap &attributeMap, const StateSet::AttributeList &attributeList)
 
void pushUniformList (UniformMap &uniformMap, const StateSet::UniformList &uniformList)
 
void pushDefineList (DefineMap &defineMap, const StateSet::DefineList &defineList)
 
void popModeList (ModeMap &modeMap, const StateSet::ModeList &modeList)
 
void popAttributeList (AttributeMap &attributeMap, const StateSet::AttributeList &attributeList)
 
void popUniformList (UniformMap &uniformMap, const StateSet::UniformList &uniformList)
 
void popDefineList (DefineMap &defineMap, const StateSet::DefineList &defineList)
 
void applyModeList (ModeMap &modeMap, const StateSet::ModeList &modeList)
 
void applyAttributeList (AttributeMap &attributeMap, const StateSet::AttributeList &attributeList)
 
void applyUniformList (UniformMap &uniformMap, const StateSet::UniformList &uniformList)
 
void applyDefineList (DefineMap &defineMap, const StateSet::DefineList &defineList)
 
void applyModeMap (ModeMap &modeMap)
 
void applyAttributeMap (AttributeMap &attributeMap)
 
void applyUniformMap (UniformMap &uniformMap)
 
void applyModeListOnTexUnit (unsigned int unit, ModeMap &modeMap, const StateSet::ModeList &modeList)
 
void applyAttributeListOnTexUnit (unsigned int unit, AttributeMap &attributeMap, const StateSet::AttributeList &attributeList)
 
void applyModeMapOnTexUnit (unsigned int unit, ModeMap &modeMap)
 
void applyAttributeMapOnTexUnit (unsigned int unit, AttributeMap &attributeMap)
 
void haveAppliedMode (ModeMap &modeMap, StateAttribute::GLMode mode, StateAttribute::GLModeValue value)
 
void haveAppliedMode (ModeMap &modeMap, StateAttribute::GLMode mode)
 
void haveAppliedAttribute (AttributeMap &attributeMap, const StateAttribute *attribute)
 
void haveAppliedAttribute (AttributeMap &attributeMap, StateAttribute::Type type, unsigned int member)
 
bool getLastAppliedMode (const ModeMap &modeMap, StateAttribute::GLMode mode) const
 
const StateAttributegetLastAppliedAttribute (const AttributeMap &attributeMap, StateAttribute::Type type, unsigned int member) const
 
void loadModelViewMatrix ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

GraphicsContext_graphicsContext
 
unsigned int _contextID
 
bool _useStateAttributeShaders
 
bool _useStateAttributeFixedFunction
 
bool _useModelViewAndProjectionUniforms
 
bool _useVertexAttributeAliasing
 
osg::ref_ptr< osg::StateSet_rootStateSet
 
osg::ref_ptr< VertexArrayState_globalVertexArrayState
 
VertexArrayState_vas
 
bool _shaderCompositionEnabled
 
bool _shaderCompositionDirty
 
osg::ref_ptr< ShaderComposer_shaderComposer
 
osg::Program_currentShaderCompositionProgram
 
StateSet::UniformList _currentShaderCompositionUniformList
 
StateSet::DefineList _currentShaderCompositionDefines
 
ref_ptr< FrameStamp_frameStamp
 
GLenum _drawBuffer
 
GLenum _readBuffer
 
ref_ptr< const RefMatrix_identity
 
ref_ptr< const RefMatrix_initialViewMatrix
 
ref_ptr< const RefMatrix_projection
 
ref_ptr< const RefMatrix_modelView
 
ref_ptr< RefMatrix_modelViewCache
 
ref_ptr< Uniform > _modelViewMatrixUniform
 
ref_ptr< Uniform > _projectionMatrixUniform
 
ref_ptr< Uniform > _modelViewProjectionMatrixUniform
 
ref_ptr< Uniform > _normalMatrixUniform
 
Matrix _initialInverseViewMatrix
 
ref_ptr< DisplaySettings_displaySettings
 
bool * _abortRenderingPtr
 
CheckForGLErrors _checkGLErrors
 
VertexAttribAlias _vertexAlias
 
VertexAttribAlias _normalAlias
 
VertexAttribAlias _colorAlias
 
VertexAttribAlias _secondaryColorAlias
 
VertexAttribAlias _fogCoordAlias
 
VertexAttribAliasList _texCoordAliasList
 
Program::AttribBindingList _attributeBindingList
 
StringModeMap _stringModeMap
 
TextureModeDefineMapList _textureModeDefineMapList
 
ModeMap _modeMap
 
AttributeMap _attributeMap
 
UniformMap _uniformMap
 
DefineMap _defineMap
 
TextureModeMapList _textureModeMapList
 
TextureAttributeMapList _textureAttributeMapList
 
const Program::PerContextProgram_lastAppliedProgramObject
 
StateSetStack _stateStateStack
 
unsigned int _maxTexturePoolSize
 
unsigned int _maxBufferObjectPoolSize
 
unsigned int _currentActiveTextureUnit
 
unsigned int _currentClientActiveTextureUnit
 
GLBufferObject_currentPBO
 
GLBufferObject_currentDIBO
 
GLuint _currentVAO
 
osg::ref_ptr< osg::IntArrayUniform > _textureFormat
 
bool _isSecondaryColorSupported
 
bool _isFogCoordSupported
 
bool _isVertexBufferObjectSupported
 
bool _isVertexArrayObjectSupported
 
bool _forceVertexBufferObject
 
bool _forceVertexArrayObject
 
bool _extensionProcsInitialized
 
GLint _glMaxTextureCoords
 
GLint _glMaxTextureUnits
 
ActiveTextureProc _glClientActiveTexture
 
ActiveTextureProc _glActiveTexture
 
MultiTexCoord4fProc _glMultiTexCoord4f
 
VertexAttrib4fProc _glVertexAttrib4f
 
VertexAttrib4fvProc _glVertexAttrib4fv
 
FogCoordPointerProc _glFogCoordPointer
 
SecondaryColorPointerProc _glSecondaryColorPointer
 
VertexAttribPointerProc _glVertexAttribPointer
 
VertexAttribIPointerProc _glVertexAttribIPointer
 
VertexAttribLPointerProc _glVertexAttribLPointer
 
EnableVertexAttribProc _glEnableVertexAttribArray
 
DisableVertexAttribProc _glDisableVertexAttribArray
 
BindBufferProc _glBindBuffer
 
DrawArraysInstancedProc _glDrawArraysInstanced
 
DrawElementsInstancedProc _glDrawElementsInstanced
 
osg::ref_ptr< GLExtensions_glExtensions
 
unsigned int _dynamicObjectCount
 
osg::ref_ptr< DynamicObjectRenderingCompletedCallback_completeDynamicObjectRenderingCallback
 
AttributeDispatchers _arrayDispatchers
 
osg::ref_ptr< GraphicsCostEstimator_graphicsCostEstimator
 
Timer_t _startTick
 
Timer_t _gpuTick
 
GLuint64 _gpuTimestamp
 
int _timestampBits
 
- 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::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Detailed Description

Encapsulates the current applied OpenGL modes, attributes and vertex arrays settings, implements lazy state updating and provides accessors for querying the current state.

The venerable Red Book says that "OpenGL is a state machine", and this class represents the OpenGL state in OSG. Furthermore, State also has other important features:

Member Typedef Documentation

◆ ActiveTextureProc

typedef void(GL_APIENTRY * osg::State::ActiveTextureProc) (GLenum texture)
protected

◆ AttributeMap

◆ AttributePair

◆ AttributeVec

◆ BindBufferProc

typedef void(GL_APIENTRY * osg::State::BindBufferProc) (GLenum target, GLuint buffer)
protected

◆ DisableVertexAttribProc

typedef void(GL_APIENTRY * osg::State::DisableVertexAttribProc) (unsigned int)
protected

◆ DrawArraysInstancedProc

typedef void(GL_APIENTRY * osg::State::DrawArraysInstancedProc) (GLenum mode, GLint first, GLsizei count, GLsizei primcount)
protected

◆ DrawElementsInstancedProc

typedef void(GL_APIENTRY * osg::State::DrawElementsInstancedProc) (GLenum mode, GLsizei count, GLenum type, const GLvoid *indices, GLsizei primcount)
protected

◆ EnableVertexAttribProc

typedef void(GL_APIENTRY * osg::State::EnableVertexAttribProc) (unsigned int)
protected

◆ ExtensionMap

typedef std::map<const std::type_info*, osg::ref_ptr<osg::Referenced> > osg::State::ExtensionMap

◆ FogCoordPointerProc

typedef void(GL_APIENTRY * osg::State::FogCoordPointerProc) (GLenum type, GLsizei stride, const GLvoid *pointer)
protected

◆ IndicesGLuint

typedef std::vector<GLuint> osg::State::IndicesGLuint

◆ IndicesGLushort

typedef std::vector<GLushort> osg::State::IndicesGLushort

◆ MatrixStack

typedef std::vector< ref_ptr<const Matrix> > osg::State::MatrixStack

◆ ModeDefineMap

typedef std::map<GLenum, std::string> osg::State::ModeDefineMap

◆ ModeMap

◆ MultiTexCoord4fProc

typedef void(GL_APIENTRY * osg::State::MultiTexCoord4fProc) (GLenum target, GLfloat x, GLfloat y, GLfloat z, GLfloat w)
protected

◆ SecondaryColorPointerProc

typedef void(GL_APIENTRY * osg::State::SecondaryColorPointerProc) (GLint size, GLenum type, GLsizei stride, const GLvoid *pointer)
protected

◆ StateSetStack

typedef std::vector<const StateSet*> osg::State::StateSetStack

◆ StringModeMap

typedef std::map<std::string, GLenum> osg::State::StringModeMap

◆ TextureAttributeMapList

◆ TextureModeDefineMapList

◆ TextureModeMapList

◆ UniformMap

typedef std::map<std::string, UniformStack> osg::State::UniformMap

◆ VertexAttrib4fProc

typedef void(GL_APIENTRY * osg::State::VertexAttrib4fProc) (GLuint index, GLfloat x, GLfloat y, GLfloat z, GLfloat w)
protected

◆ VertexAttrib4fvProc

typedef void(GL_APIENTRY * osg::State::VertexAttrib4fvProc) (GLuint index, const GLfloat *v)
protected

◆ VertexAttribAliasList

◆ VertexAttribIPointerProc

typedef void(GL_APIENTRY * osg::State::VertexAttribIPointerProc) (unsigned int, GLint, GLenum, GLsizei stride, const GLvoid *pointer)
protected

◆ VertexAttribLPointerProc

typedef void(GL_APIENTRY * osg::State::VertexAttribLPointerProc) (unsigned int, GLint, GLenum, GLsizei stride, const GLvoid *pointer)
protected

◆ VertexAttribPointerProc

typedef void(GL_APIENTRY * osg::State::VertexAttribPointerProc) (unsigned int, GLint, GLenum, GLboolean normalized, GLsizei stride, const GLvoid *pointer)
protected

Member Enumeration Documentation

◆ CheckForGLErrors

Enumerator
NEVER_CHECK_GL_ERRORS 

NEVER_CHECK_GL_ERRORS hints that OpenGL need not be checked for, this is the fastest option since checking for errors does incur a small overhead.

ONCE_PER_FRAME 

ONCE_PER_FRAME means that OpenGL errors will be checked for once per frame, the overhead is still small, but at least OpenGL errors that are occurring will be caught, the reporting isn't fine grained enough for debugging purposes.

ONCE_PER_ATTRIBUTE 

ONCE_PER_ATTRIBUTE means that OpenGL errors will be checked for after every attribute is applied, allow errors to be directly associated with particular operations which makes debugging much easier.

Constructor & Destructor Documentation

◆ State()

osg::State::State ( )

◆ ~State()

virtual osg::State::~State ( )
protectedvirtual

Member Function Documentation

◆ apply() [1/2]

void osg::State::apply ( const StateSet dstate)

Apply stateset.

◆ apply() [2/2]

void osg::State::apply ( )

Updates the OpenGL state so that it matches the StateSet at the top of the stack of StateSets maintained internally by a State.

◆ applyAttribute() [1/2]

bool osg::State::applyAttribute ( const StateAttribute attribute)
inline

Apply an attribute if required.

References osg::State::AttributeStack::changed, and osg::StateAttribute::getTypeMemberPair().

◆ applyAttribute() [2/2]

bool osg::State::applyAttribute ( const StateAttribute attribute,
AttributeStack as 
)
inlineprotected

◆ applyAttributeList()

void osg::State::applyAttributeList ( AttributeMap attributeMap,
const StateSet::AttributeList attributeList 
)
inlineprotected

◆ applyAttributeListOnTexUnit()

void osg::State::applyAttributeListOnTexUnit ( unsigned int  unit,
AttributeMap attributeMap,
const StateSet::AttributeList attributeList 
)
inlineprotected

◆ applyAttributeMap()

void osg::State::applyAttributeMap ( AttributeMap attributeMap)
inlineprotected

◆ applyAttributeMapOnTexUnit()

void osg::State::applyAttributeMapOnTexUnit ( unsigned int  unit,
AttributeMap attributeMap 
)
inlineprotected

◆ applyAttributeOnTexUnit()

bool osg::State::applyAttributeOnTexUnit ( unsigned int  unit,
const StateAttribute attribute,
AttributeStack as 
)
inlineprotected

◆ applyDefineList()

void osg::State::applyDefineList ( DefineMap defineMap,
const StateSet::DefineList defineList 
)
inlineprotected

◆ applyDisablingOfVertexAttributes()

void osg::State::applyDisablingOfVertexAttributes ( )
inline

◆ applyGlobalDefaultAttribute()

bool osg::State::applyGlobalDefaultAttribute ( AttributeStack as)
inlineprotected

◆ applyGlobalDefaultAttributeOnTexUnit()

bool osg::State::applyGlobalDefaultAttributeOnTexUnit ( unsigned int  unit,
AttributeStack as 
)
inlineprotected

◆ applyMode() [1/2]

bool osg::State::applyMode ( StateAttribute::GLMode  mode,
bool  enabled 
)
inline

Apply an OpenGL mode if required.

This is a wrapper around glEnable() and glDisable(), that just actually calls these functions if the enabled flag is different than the current state.

Returns
true if the state was actually changed. false otherwise. Notice that a false return does not indicate an error, it just means that the mode was already set to the same value as the enabled parameter.

References osg::State::ModeStack::changed.

◆ applyMode() [2/2]

bool osg::State::applyMode ( StateAttribute::GLMode  mode,
bool  enabled,
ModeStack ms 
)
inlineprotected

Apply an OpenGL mode if required, passing in mode, enable flag and appropriate mode stack.

This is a wrapper around glEnable() and glDisable(), that just actually calls these functions if the enabled flag is different than the current state.

Returns
true if the state was actually changed. false otherwise. Notice that a false return does not indicate an error, it just means that the mode was already set to the same value as the enabled parameter.

References osg::State::ModeStack::last_applied_value, and osg::State::ModeStack::valid.

◆ applyModeList()

void osg::State::applyModeList ( ModeMap modeMap,
const StateSet::ModeList modeList 
)
inlineprotected

◆ applyModeListOnTexUnit()

void osg::State::applyModeListOnTexUnit ( unsigned int  unit,
ModeMap modeMap,
const StateSet::ModeList modeList 
)
inlineprotected

◆ applyModelViewAndProjectionUniformsIfRequired()

void osg::State::applyModelViewAndProjectionUniformsIfRequired ( )

◆ applyModelViewMatrix() [1/2]

void osg::State::applyModelViewMatrix ( const osg::RefMatrix matrix)

◆ applyModelViewMatrix() [2/2]

void osg::State::applyModelViewMatrix ( const osg::Matrix )

◆ applyModeMap()

void osg::State::applyModeMap ( ModeMap modeMap)
inlineprotected

◆ applyModeMapOnTexUnit()

void osg::State::applyModeMapOnTexUnit ( unsigned int  unit,
ModeMap modeMap 
)
inlineprotected

◆ applyModeOnTexUnit()

bool osg::State::applyModeOnTexUnit ( unsigned int  unit,
StateAttribute::GLMode  mode,
bool  enabled,
ModeStack ms 
)
inlineprotected

◆ applyProjectionMatrix()

void osg::State::applyProjectionMatrix ( const osg::RefMatrix matrix)

◆ applyShaderComposition()

void osg::State::applyShaderComposition ( )

Apply any shader composed state.

◆ applyShaderCompositionDefines()

void osg::State::applyShaderCompositionDefines ( const StateSet::DefineList defineList)
inline

Convenience method for StateAttribute::apply(State&) methods to pass on their defines to osg::State so it can apply them at the appropriate point.

◆ applyShaderCompositionUniform()

void osg::State::applyShaderCompositionUniform ( const osg::UniformBase uniform,
StateAttribute::OverrideValue  value = StateAttribute::ON 
)
inline

Convenience method for StateAttribute::apply(State&) methods to pass on their uniforms to osg::State so it can apply them at the appropriate point.

References osg::Object::getName().

◆ applyTextureAttribute()

bool osg::State::applyTextureAttribute ( unsigned int  unit,
const StateAttribute attribute 
)
inline

◆ applyTextureMode()

bool osg::State::applyTextureMode ( unsigned int  unit,
StateAttribute::GLMode  mode,
bool  enabled 
)
inline

◆ applyUniformList()

void osg::State::applyUniformList ( UniformMap uniformMap,
const StateSet::UniformList uniformList 
)
inlineprotected

◆ applyUniformMap()

void osg::State::applyUniformMap ( UniformMap uniformMap)
inlineprotected

◆ bindDrawIndirectBufferObject()

void osg::State::bindDrawIndirectBufferObject ( osg::GLBufferObject ibo)
inline

◆ bindElementBufferObject()

void osg::State::bindElementBufferObject ( osg::GLBufferObject ebo)
inline

◆ bindPixelBufferObject()

void osg::State::bindPixelBufferObject ( osg::GLBufferObject pbo)
inline

◆ bindVertexArrayObject() [1/2]

void osg::State::bindVertexArrayObject ( const VertexArrayState vas)
inline

◆ bindVertexArrayObject() [2/2]

void osg::State::bindVertexArrayObject ( GLuint  vao)
inline

◆ bindVertexBufferObject()

void osg::State::bindVertexBufferObject ( osg::GLBufferObject vbo)
inline

◆ captureCurrentState()

void osg::State::captureCurrentState ( StateSet stateset) const

Copy the modes and attributes which capture the current state.

◆ checkGLErrors() [1/4]

bool osg::State::checkGLErrors ( const char *  str1 = 0,
const char *  str2 = 0 
) const

◆ checkGLErrors() [2/4]

bool osg::State::checkGLErrors ( const std::string &  str) const

◆ checkGLErrors() [3/4]

bool osg::State::checkGLErrors ( StateAttribute::GLMode  mode) const

◆ checkGLErrors() [4/4]

bool osg::State::checkGLErrors ( const StateAttribute attribute) const

◆ Color()

void osg::State::Color ( float  r,
float  g,
float  b,
float  a = 1.0f 
)
inline

◆ convertVertexShaderSourceToOsgBuiltIns()

bool osg::State::convertVertexShaderSourceToOsgBuiltIns ( std::string &  source) const

◆ decrementDynamicObjectCount()

void osg::State::decrementDynamicObjectCount ( )
inline

Decrement the number of dynamic objects left to render this frame, and once the count goes to zero call the DynamicObjectRenderingCompletedCallback to inform of completion.

◆ dirtyAllAttributes()

void osg::State::dirtyAllAttributes ( )

Dirty the modes attributes previously applied in osg::State.

◆ dirtyAllModes()

void osg::State::dirtyAllModes ( )

Dirty the modes previously applied in osg::State.

◆ dirtyAllVertexArrays()

void osg::State::dirtyAllVertexArrays ( )

dirty the vertex, normal, color, tex coords, secondary color, fog coord and index arrays.

◆ disableAllVertexArrays()

void osg::State::disableAllVertexArrays ( )

disable the vertex, normal, color, tex coords, secondary color, fog coord and index arrays.

◆ disableColorPointer()

void osg::State::disableColorPointer ( )
inline

◆ disableFogCoordPointer()

void osg::State::disableFogCoordPointer ( )
inline

◆ disableNormalPointer()

void osg::State::disableNormalPointer ( )
inline

◆ disableSecondaryColorPointer()

void osg::State::disableSecondaryColorPointer ( )
inline

◆ disableTexCoordPointer()

void osg::State::disableTexCoordPointer ( unsigned int  unit)
inline

◆ disableTexCoordPointersAboveAndIncluding()

void osg::State::disableTexCoordPointersAboveAndIncluding ( unsigned int  unit)
inline

◆ disableVertexAttribPointer()

void osg::State::disableVertexAttribPointer ( unsigned int  index)
inline

◆ disableVertexAttribPointersAboveAndIncluding()

void osg::State::disableVertexAttribPointersAboveAndIncluding ( unsigned int  index)
inline

◆ disableVertexPointer()

void osg::State::disableVertexPointer ( )
inline

◆ drawQuads()

void osg::State::drawQuads ( GLint  first,
GLsizei  count,
GLsizei  primCount = 0 
)

◆ frameCompleted()

virtual void osg::State::frameCompleted ( )
virtual

◆ get() [1/4]

template<typename T >
T* osg::State::get ( )
inline

Get a specific GL extensions object or GraphicsObjectManager, initialize if not already present.

Note, must only be called from a the graphics context thread associated with this osg::State.

References osg::ref_ptr< T >::get().

Referenced by osg::RenderInfo::getState(), and osg::GraphicsContext::getState().

◆ get() [2/4]

template<typename T >
const T* osg::State::get ( ) const
inline

Get a specific GL extensions object or GraphicsObjectManager if it already exists in the extension map.

Note, safe to call outwith a the graphics context thread associated with this osg::State. Returns NULL if the desired extension object has not been created yet.

◆ get() [3/4]

template<>
GLExtensions* osg::State::get ( )
inline

◆ get() [4/4]

template<>
const GLExtensions* osg::State::get ( ) const
inline

◆ getAbortRendering()

bool osg::State::getAbortRendering ( ) const
inline

Get flag for early termination of the draw traversal, if true steps should be taken to complete rendering early.

◆ getActiveDisplaySettings() [1/2]

DisplaySettings* osg::State::getActiveDisplaySettings ( )
inline

Get the const DisplaySettings that is current active DisplaySettings to be used by osg::State, - if DisplaySettings is not directly assigned then fallback to DisplaySettings::instance().

References osg::DisplaySettings::instance().

◆ getActiveDisplaySettings() [2/2]

const DisplaySettings* osg::State::getActiveDisplaySettings ( ) const
inline

Get the const DisplaySettings that is current active DisplaySettings to be used by osg::State, - if DisplaySettings is not directly assigned then fallback to DisplaySettings::instance().

References osg::DisplaySettings::instance().

◆ getActiveTextureUnit()

unsigned int osg::State::getActiveTextureUnit ( ) const
inline

Get the current texture unit.

◆ getAttribLocation()

GLint osg::State::getAttribLocation ( const std::string &  name) const
inline

◆ getAttributeBindingList()

const Program::AttribBindingList& osg::State::getAttributeBindingList ( )
inline

◆ getAttributeDispatchers()

AttributeDispatchers& osg::State::getAttributeDispatchers ( )
inline

Get the helper class for dispatching osg::Arrays as OpenGL attribute data.

◆ getAttributeMap()

const AttributeMap& osg::State::getAttributeMap ( ) const
inline

◆ getAttributeVec()

AttributeVec& osg::State::getAttributeVec ( const osg::StateAttribute attribute)
inline

◆ getCheckForGLErrors()

CheckForGLErrors osg::State::getCheckForGLErrors ( ) const
inline

Get whether and how often OpenGL errors should be checked for.

◆ getClientActiveTextureUnit()

unsigned int osg::State::getClientActiveTextureUnit ( ) const

Get the current tex coord array texture unit.

◆ getColorAlias()

const VertexAttribAlias& osg::State::getColorAlias ( )
inline

◆ getContextID()

unsigned int osg::State::getContextID ( ) const
inline

Get the current OpenGL context unique ID.

Referenced by osg::Texture2D::SubloadCallback::generateTextureObject().

◆ getCurrentElementBufferObject()

const GLBufferObject* osg::State::getCurrentElementBufferObject ( )
inline

◆ getCurrentPixelBufferObject()

const GLBufferObject* osg::State::getCurrentPixelBufferObject ( ) const
inline

◆ getCurrentShaderCompositionDefines() [1/2]

StateSet::DefineList& osg::State::getCurrentShaderCompositionDefines ( )
inline

◆ getCurrentShaderCompositionDefines() [2/2]

const StateSet::DefineList& osg::State::getCurrentShaderCompositionDefines ( ) const
inline

◆ getCurrentShaderCompositionUniformList()

StateSet::UniformList& osg::State::getCurrentShaderCompositionUniformList ( )
inline

Get the unform list in which to inject any uniforms that StateAttribute::apply(State&) methods provide.

◆ getCurrentVertexArrayObject()

GLuint osg::State::getCurrentVertexArrayObject ( ) const
inline

◆ getCurrentVertexArrayState()

VertexArrayState* osg::State::getCurrentVertexArrayState ( ) const
inline

Get the CurrentVetexArrayState object that take which vertex arrays are bound.

Referenced by osg::Drawable::draw().

◆ getCurrentVertexBufferObject()

const GLBufferObject* osg::State::getCurrentVertexBufferObject ( )
inline

◆ getCurrentViewport()

const Viewport* osg::State::getCurrentViewport ( ) const
inline

◆ getDefineMap() [1/2]

DefineMap& osg::State::getDefineMap ( )
inline

◆ getDefineMap() [2/2]

const DefineMap& osg::State::getDefineMap ( ) const
inline

◆ getDefineString() [1/2]

void osg::State::getDefineString ( std::string &  shaderDefineStr,
const StateSet::DefineList currentDefines,
const osg::ShaderDefines shaderDefines 
)

◆ getDefineString() [2/2]

void osg::State::getDefineString ( std::string &  shaderDefineStr,
const osg::ShaderPragmas shaderPragmas 
)

◆ getDisplaySettings() [1/2]

DisplaySettings* osg::State::getDisplaySettings ( )
inline

Get the const DisplaySettings.

◆ getDisplaySettings() [2/2]

const DisplaySettings* osg::State::getDisplaySettings ( ) const
inline

Get the const DisplaySettings.

◆ getDrawBuffer()

GLenum osg::State::getDrawBuffer ( ) const
inline

◆ getDynamicObjectCount()

unsigned int osg::State::getDynamicObjectCount ( ) const
inline

Get the number of dynamic objects that will be rendered in this graphics context this frame.

◆ getDynamicObjectRenderingCompletedCallback()

DynamicObjectRenderingCompletedCallback* osg::State::getDynamicObjectRenderingCompletedCallback ( )
inline

Get the callback to be called when the dynamic object count hits 0.

◆ getFogCoordAlias()

const VertexAttribAlias& osg::State::getFogCoordAlias ( )
inline

◆ getFrameStamp() [1/2]

FrameStamp* osg::State::getFrameStamp ( )
inline

Get the frame stamp for the current frame.

◆ getFrameStamp() [2/2]

const FrameStamp* osg::State::getFrameStamp ( ) const
inline

Get the const frame stamp for the current frame.

◆ getGlobalDefaultAttribute()

const StateAttribute* osg::State::getGlobalDefaultAttribute ( StateAttribute::Type  type,
unsigned int  member = 0 
)
inline

◆ getGlobalDefaultModeValue()

bool osg::State::getGlobalDefaultModeValue ( StateAttribute::GLMode  mode)
inline

◆ getGlobalDefaultTextureAttribute()

const StateAttribute* osg::State::getGlobalDefaultTextureAttribute ( unsigned int  unit,
StateAttribute::Type  type,
unsigned int  member = 0 
)
inline

◆ getGlobalDefaultTextureModeValue()

bool osg::State::getGlobalDefaultTextureModeValue ( unsigned int  unit,
StateAttribute::GLMode  mode 
)
inline

◆ getGpuTick()

Timer_t osg::State::getGpuTick ( ) const
inline

◆ getGpuTime()

double osg::State::getGpuTime ( ) const
inline

◆ getGpuTimestamp()

GLuint64 osg::State::getGpuTimestamp ( ) const
inline

◆ getGraphicsContext() [1/2]

GraphicsContext* osg::State::getGraphicsContext ( )
inline

Get the graphics context associated with that owns this State object.

◆ getGraphicsContext() [2/2]

const GraphicsContext* osg::State::getGraphicsContext ( ) const
inline

Get the const graphics context associated with that owns this State object.

◆ getGraphicsCostEstimator() [1/2]

GraphicsCostEstimator* osg::State::getGraphicsCostEstimator ( )
inline

Get the helper class that provides applications with estimate on how much different graphics operations will cost.

◆ getGraphicsCostEstimator() [2/2]

const GraphicsCostEstimator* osg::State::getGraphicsCostEstimator ( ) const
inline

Get the cont helper class that provides applications with estimate on how much different graphics operations will cost.

◆ getInitialInverseViewMatrix()

const osg::Matrix& osg::State::getInitialInverseViewMatrix ( ) const
inline

◆ getInitialViewMatrix()

const osg::Matrix& osg::State::getInitialViewMatrix ( ) const
inline

◆ getLastAppliedAttribute() [1/2]

const StateAttribute* osg::State::getLastAppliedAttribute ( StateAttribute::Type  type,
unsigned int  member = 0 
) const

Get the current specified attribute, return NULL if one has not yet been applied.

◆ getLastAppliedAttribute() [2/2]

const StateAttribute* osg::State::getLastAppliedAttribute ( const AttributeMap attributeMap,
StateAttribute::Type  type,
unsigned int  member 
) const
protected

◆ getLastAppliedMode() [1/2]

bool osg::State::getLastAppliedMode ( StateAttribute::GLMode  mode) const

Get whether the current specified mode is enabled (true) or disabled (false).

◆ getLastAppliedMode() [2/2]

bool osg::State::getLastAppliedMode ( const ModeMap modeMap,
StateAttribute::GLMode  mode 
) const
protected

◆ getLastAppliedModeValue()

bool osg::State::getLastAppliedModeValue ( StateAttribute::GLMode  mode)
inline

◆ getLastAppliedProgramObject()

const Program::PerContextProgram* osg::State::getLastAppliedProgramObject ( ) const
inline

◆ getLastAppliedTextureAttribute()

const StateAttribute* osg::State::getLastAppliedTextureAttribute ( unsigned int  unit,
StateAttribute::Type  type,
unsigned int  member = 0 
) const

Get the current specified texture attribute, return NULL if one has not yet been applied.

◆ getLastAppliedTextureMode()

bool osg::State::getLastAppliedTextureMode ( unsigned int  unit,
StateAttribute::GLMode  mode 
) const

Get whether the current specified texture mode is enabled (true) or disabled (false).

◆ getLastAppliedTextureModeValue()

bool osg::State::getLastAppliedTextureModeValue ( unsigned int  unit,
StateAttribute::GLMode  mode 
)
inline

◆ getMaxBufferObjectPoolSize()

unsigned int osg::State::getMaxBufferObjectPoolSize ( ) const
inline

◆ getMaxTextureCoords()

GLint osg::State::getMaxTextureCoords ( ) const
inline

For GL>=2.0 uses GL_MAX_TEXTURE_COORDS, for GL<2 uses GL_MAX_TEXTURE_UNITS.

◆ getMaxTexturePoolSize()

unsigned int osg::State::getMaxTexturePoolSize ( ) const
inline

◆ getMaxTextureUnits()

GLint osg::State::getMaxTextureUnits ( ) const
inline

For GL>=2.0 uses GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS, for GL<2 uses GL_MAX_TEXTURE_UNITS.

◆ getModelViewMatrix()

const osg::Matrix& osg::State::getModelViewMatrix ( ) const
inline

◆ getModelViewMatrixUniform()

osg::Uniform* osg::State::getModelViewMatrixUniform ( )
inline

◆ getModelViewProjectionMatrixUniform()

osg::Uniform* osg::State::getModelViewProjectionMatrixUniform ( )
inline

◆ getModeMap()

const ModeMap& osg::State::getModeMap ( ) const
inline

◆ getModeValidity()

bool osg::State::getModeValidity ( StateAttribute::GLMode  mode)
inline

Get whether a particular OpenGL mode is valid in the current graphics context.

Use to disable OpenGL modes that are not supported by current graphics drivers/context.

References osg::State::ModeStack::valid.

◆ getNormalAlias()

const VertexAttribAlias& osg::State::getNormalAlias ( )
inline

◆ getNormalMatrixUniform()

osg::Uniform* osg::State::getNormalMatrixUniform ( )
inline

◆ getOrCreateTextureAttributeMap()

AttributeMap& osg::State::getOrCreateTextureAttributeMap ( unsigned int  unit)
inlineprotected

◆ getOrCreateTextureModeMap()

ModeMap& osg::State::getOrCreateTextureModeMap ( unsigned int  unit)
inlineprotected

◆ getProjectionMatrix()

const osg::Matrix& osg::State::getProjectionMatrix ( ) const
inline

◆ getProjectionMatrixUniform()

osg::Uniform* osg::State::getProjectionMatrixUniform ( )
inline

◆ getReadBuffer()

GLenum osg::State::getReadBuffer ( ) const
inline

◆ getRootStateSet()

osg::StateSet* osg::State::getRootStateSet ( )
inline

Get the root StateSet.

◆ getSecondaryColorAlias()

const VertexAttribAlias& osg::State::getSecondaryColorAlias ( )
inline

◆ getShaderComposer() [1/2]

ShaderComposer* osg::State::getShaderComposer ( )
inline

deprecated.

◆ getShaderComposer() [2/2]

const ShaderComposer* osg::State::getShaderComposer ( ) const
inline

deprecated.

◆ getShaderCompositionEnabled()

bool osg::State::getShaderCompositionEnabled ( ) const
inline

◆ getStartTick()

Timer_t osg::State::getStartTick ( ) const
inline

Support for synchronizing the system time and the timestamp counter available with ARB_timer_query.

Note that State doesn't update these values itself.

◆ getStateSetStack()

StateSetStack& osg::State::getStateSetStack ( )
inline

Get the StateSet stack.

References osg::releaseGLObjects().

◆ getStateSetStackSize()

unsigned int osg::State::getStateSetStackSize ( )
inline

Get the number of StateSet's on the StateSet stack.

◆ getStringModeMap()

StringModeMap& osg::State::getStringModeMap ( )
inline

◆ getTexCoordAliasList()

const VertexAttribAliasList& osg::State::getTexCoordAliasList ( )
inline

◆ getTextureAttributeMapList()

const TextureAttributeMapList& osg::State::getTextureAttributeMapList ( ) const
inline

◆ getTextureModeDefineMap()

ModeDefineMap& osg::State::getTextureModeDefineMap ( unsigned int  i)
inline

◆ getTextureModeDefineMapList()

TextureModeDefineMapList& osg::State::getTextureModeDefineMapList ( )
inline

◆ getTextureModeMapList()

const TextureModeMapList& osg::State::getTextureModeMapList ( ) const
inline

◆ getTimestampBits()

int osg::State::getTimestampBits ( ) const
inline

◆ getUniformLocation() [1/2]

GLint osg::State::getUniformLocation ( unsigned int  uniformNameID) const
inline

◆ getUniformLocation() [2/2]

GLint osg::State::getUniformLocation ( const std::string &  uniformName) const
inline

Alternative version of getUniformLocation( unsigned int uniformNameID ) retrofited into OSG for backward compatibility with osgCal, after uniform ids were refactored from std::strings to GLints in OSG version 2.9.10.

Drawbacks: This method is not particularly fast. It has to access mutexed static map of uniform ids. So don't overuse it or your app performance will suffer.

◆ getUniformMap()

const UniformMap& osg::State::getUniformMap ( ) const
inline

◆ getUseModelViewAndProjectionUniforms()

bool osg::State::getUseModelViewAndProjectionUniforms ( ) const
inline

◆ getUseStateAttributeFixedFunction()

bool osg::State::getUseStateAttributeFixedFunction ( ) const
inline

◆ getUseStateAttributeShaders()

bool osg::State::getUseStateAttributeShaders ( ) const
inline

◆ getUseVertexAttributeAliasing()

bool osg::State::getUseVertexAttributeAliasing ( ) const
inline

◆ getVertexAlias()

const VertexAttribAlias& osg::State::getVertexAlias ( )
inline

◆ getViewFrustum()

Polytope osg::State::getViewFrustum ( ) const

◆ glDrawArraysInstanced()

void osg::State::glDrawArraysInstanced ( GLenum  mode,
GLint  first,
GLsizei  count,
GLsizei  primcount 
)
inline

◆ glDrawBuffer()

void osg::State::glDrawBuffer ( GLenum  buffer)

◆ glDrawElementsInstanced()

void osg::State::glDrawElementsInstanced ( GLenum  mode,
GLsizei  count,
GLenum  type,
const GLvoid *  indices,
GLsizei  primcount 
)
inline

◆ glReadBuffer()

void osg::State::glReadBuffer ( GLenum  buffer)

◆ haveAppliedAttribute() [1/4]

void osg::State::haveAppliedAttribute ( const StateAttribute attribute)

Attribute has been applied externally, update state to reflect this setting.

◆ haveAppliedAttribute() [2/4]

void osg::State::haveAppliedAttribute ( StateAttribute::Type  type,
unsigned int  member = 0 
)

Attribute has been applied externally, and therefore this attribute type has been dirtied and will need to be re-applied on next osg::State.apply(..).

note, if you have an osg::StateAttribute which you have applied externally then use the have_applied(attribute) method as this will cause the osg::State to track the current state more accurately and enable lazy state updating such that only changed state will be applied.

◆ haveAppliedAttribute() [3/4]

void osg::State::haveAppliedAttribute ( AttributeMap attributeMap,
const StateAttribute attribute 
)
protected

◆ haveAppliedAttribute() [4/4]

void osg::State::haveAppliedAttribute ( AttributeMap attributeMap,
StateAttribute::Type  type,
unsigned int  member 
)
protected

◆ haveAppliedMode() [1/4]

void osg::State::haveAppliedMode ( StateAttribute::GLMode  mode,
StateAttribute::GLModeValue  value 
)

Mode has been set externally, update state to reflect this setting.

◆ haveAppliedMode() [2/4]

void osg::State::haveAppliedMode ( StateAttribute::GLMode  mode)

Mode has been set externally, therefore dirty the associated mode in osg::State so it is applied on next call to osg::State::apply(..)

◆ haveAppliedMode() [3/4]

void osg::State::haveAppliedMode ( ModeMap modeMap,
StateAttribute::GLMode  mode,
StateAttribute::GLModeValue  value 
)
protected

◆ haveAppliedMode() [4/4]

void osg::State::haveAppliedMode ( ModeMap modeMap,
StateAttribute::GLMode  mode 
)
protected

◆ haveAppliedTextureAttribute() [1/2]

void osg::State::haveAppliedTextureAttribute ( unsigned int  unit,
const StateAttribute attribute 
)

texture Attribute has been applied externally, update state to reflect this setting.

◆ haveAppliedTextureAttribute() [2/2]

void osg::State::haveAppliedTextureAttribute ( unsigned int  unit,
StateAttribute::Type  type,
unsigned int  member = 0 
)

texture Attribute has been applied externally, and therefore this attribute type has been dirtied and will need to be re-applied on next osg::State.apply(..).

note, if you have an osg::StateAttribute which you have applied externally then use the have_applied(attribute) method as this will the osg::State to track the current state more accurately and enable lazy state updating such that only changed state will be applied.

◆ haveAppliedTextureMode() [1/2]

void osg::State::haveAppliedTextureMode ( unsigned int  unit,
StateAttribute::GLMode  mode,
StateAttribute::GLModeValue  value 
)

texture Mode has been set externally, update state to reflect this setting.

◆ haveAppliedTextureMode() [2/2]

void osg::State::haveAppliedTextureMode ( unsigned int  unit,
StateAttribute::GLMode  mode 
)

texture Mode has been set externally, therefore dirty the associated mode in osg::State so it is applied on next call to osg::State::apply(..)

◆ initializeExtensionProcs()

virtual void osg::State::initializeExtensionProcs ( )
virtual

Initialize extension used by osg::State.

◆ initUpModeDefineMaps()

virtual void osg::State::initUpModeDefineMaps ( )
protectedvirtual

Initialize ModeDefineMaps used in fixed function modes to shader defines.

Called by initializeExtensionProcs().

◆ insertStateSet()

void osg::State::insertStateSet ( unsigned int  pos,
const StateSet dstate 
)

Insert stateset onto state stack.

◆ isFogCoordSupported()

bool osg::State::isFogCoordSupported ( ) const
inline

◆ isSecondaryColorSupported()

bool osg::State::isSecondaryColorSupported ( ) const
inline

◆ isVertexArrayObjectSupported()

bool osg::State::isVertexArrayObjectSupported ( ) const
inline

◆ isVertexBufferObjectSupported()

bool osg::State::isVertexBufferObjectSupported ( ) const
inline

◆ lazyDisablingOfVertexAttributes()

void osg::State::lazyDisablingOfVertexAttributes ( )
inline

◆ loadModelViewMatrix()

void osg::State::loadModelViewMatrix ( )
protected

◆ MultiTexCoord()

void osg::State::MultiTexCoord ( unsigned int  unit,
float  x,
float  y = 0.0f,
float  z = 0.0f,
float  w = 1.0f 
)
inline

References GL_TEXTURE0.

◆ Normal()

void osg::State::Normal ( float  x,
float  y,
float  z 
)
inline

◆ popAllStateSets()

void osg::State::popAllStateSets ( )

pop all statesets off state stack, ensuring it is empty ready for the next frame.

Note, to return OpenGL to default state, one should do any state.popAllStatSets(); state.apply().

◆ popAttributeList()

void osg::State::popAttributeList ( AttributeMap attributeMap,
const StateSet::AttributeList attributeList 
)
inlineprotected

◆ popDefineList()

void osg::State::popDefineList ( DefineMap defineMap,
const StateSet::DefineList defineList 
)
inlineprotected

◆ popModeList()

void osg::State::popModeList ( ModeMap modeMap,
const StateSet::ModeList modeList 
)
inlineprotected

◆ popStateSet()

void osg::State::popStateSet ( )

◆ popStateSetStackToSize()

void osg::State::popStateSetStackToSize ( unsigned int  size)
inline

Pop StateSet's for the StateSet stack till its size equals the specified size.

◆ popUniformList()

void osg::State::popUniformList ( UniformMap uniformMap,
const StateSet::UniformList uniformList 
)
inlineprotected

◆ print()

void osg::State::print ( std::ostream &  fout) const

print out the internal details of osg::State - useful for debugging.

◆ pushAttributeList()

void osg::State::pushAttributeList ( AttributeMap attributeMap,
const StateSet::AttributeList attributeList 
)
inlineprotected

◆ pushDefineList()

void osg::State::pushDefineList ( DefineMap defineMap,
const StateSet::DefineList defineList 
)
inlineprotected

◆ pushModeList()

void osg::State::pushModeList ( ModeMap modeMap,
const StateSet::ModeList modeList 
)
inlineprotected

◆ pushStateSet()

void osg::State::pushStateSet ( const StateSet dstate)

Push stateset onto state stack.

Referenced by osgUtil::StateGraph::moveStateGraph().

◆ pushUniformList()

void osg::State::pushUniformList ( UniformMap uniformMap,
const StateSet::UniformList uniformList 
)
inlineprotected

◆ releaseGLObjects()

void osg::State::releaseGLObjects ( )

Release all OpenGL objects associated cached by this osg::State object.

◆ removeStateSet()

void osg::State::removeStateSet ( unsigned int  pos)

Pop stateset off state stack.

◆ reset()

void osg::State::reset ( )

reset the state object to an empty stack.

◆ resetCurrentVertexArrayStateOnMatch()

void osg::State::resetCurrentVertexArrayStateOnMatch ( VertexArrayState vas)
inline

Reset the CurrentVertexArrayState/VertexArrayObject if it's value matches the specificied vas - use when deleting a vas.

References osg::VertexArrayState::getVertexArrayObject().

◆ resetVertexAttributeAlias()

void osg::State::resetVertexAttributeAlias ( bool  compactAliasing = true,
unsigned int  numTextureUnits = 8 
)

Reset the vertex attribute aliasing to osg's default.

This method needs to be called before render anything unless you really know what you're doing !

◆ set() [1/2]

template<typename T >
void osg::State::set ( T *  ptr)
inline

Set a specific GL extensions object pr GraphicsObjectManager.

◆ set() [2/2]

template<>
void osg::State::set ( GLExtensions ptr)
inline

◆ setAbortRenderingPtr()

void osg::State::setAbortRenderingPtr ( bool *  abortPtr)
inline

Set flag for early termination of the draw traversal.

◆ setActiveTextureUnit()

bool osg::State::setActiveTextureUnit ( unsigned int  unit)
inline

Set the current texture unit, return true if selected, false if selection failed such as when multi texturing is not supported.

note, only updates values that change.

References GL_TEXTURE0, and osg::maximum().

◆ setAttributeBindingList()

void osg::State::setAttributeBindingList ( const Program::AttribBindingList attribBindingList)
inline

Set the vertex attribute binding list.

This method needs to be called before render anything unless you really know what you're doing !

◆ setCheckForGLErrors()

void osg::State::setCheckForGLErrors ( CheckForGLErrors  check)
inline

Set whether and how often OpenGL errors should be checked for.

◆ setClientActiveTextureUnit()

bool osg::State::setClientActiveTextureUnit ( unsigned int  unit)

Set the current tex coord array texture unit, return true if selected, false if selection failed such as when multi texturing is not supported.

note, only updates values that change.

◆ setColorAlias()

void osg::State::setColorAlias ( const VertexAttribAlias alias)
inline

Set the vertex attribute aliasing for "color".

This method needs to be called before render anything unless you really know what you're doing !

◆ setColorPointer() [1/2]

void osg::State::setColorPointer ( const Array array)
inline

◆ setColorPointer() [2/2]

void osg::State::setColorPointer ( GLint  size,
GLenum  type,
GLsizei  stride,
const GLvoid *  ptr,
GLboolean  normalized = GL_TRUE 
)
inline

◆ setContextID()

void osg::State::setContextID ( unsigned int  contextID)
inline

Set the current OpenGL context uniqueID.

The ContextID is used by classes like osg::StateAttribute's and osg::Drawable's to help manage separate OpenGL objects, such as display lists, vertex buffer objects and texture object for each graphics context. The ContextID simply acts as an index into arrays that these classes maintain for the purpose of storing GL object handles.

Note, osgViewer::GraphicsWindow will automatically set up the ContextID for you, so you will rearely need to set this yourself.

The exception is when creating your own graphics context, where you should set the ContextID uniquely for each graphics context.

Typical settings for ContextID are 0,1,2,3... up to the maximum number of graphics contexts you have set up. By default contextID is 0.

◆ setCurrentElementBufferObject()

void osg::State::setCurrentElementBufferObject ( osg::GLBufferObject ebo)
inline

◆ setCurrentPixelBufferObject()

void osg::State::setCurrentPixelBufferObject ( osg::GLBufferObject pbo)
inline

◆ setCurrentTextureFormat()

void osg::State::setCurrentTextureFormat ( GLenum  format)
inline

Set the current texture format uniform.

◆ setCurrentToGlobalVertexArrayState()

void osg::State::setCurrentToGlobalVertexArrayState ( )
inline

Set the getCurrentVertexArrayState to the GlobalVertexArrayState.

◆ setCurrentVertexArrayObject()

void osg::State::setCurrentVertexArrayObject ( GLuint  vao)
inline

◆ setCurrentVertexArrayState()

void osg::State::setCurrentVertexArrayState ( VertexArrayState vas)
inline

Set the CurrentVetexArrayState object that take which vertex arrays are bound.

◆ setCurrentVertexBufferObject()

void osg::State::setCurrentVertexBufferObject ( osg::GLBufferObject vbo)
inline

◆ setDisplaySettings()

void osg::State::setDisplaySettings ( DisplaySettings vs)
inline

Set the DisplaySettings.

Note, nothing is applied, the visual settings are just used in the State object to pass the current visual settings to Drawables during rendering.

◆ setDynamicObjectCount()

void osg::State::setDynamicObjectCount ( unsigned int  count,
bool  callCallbackOnZero = false 
)
inline

Set the number of dynamic objects that will be rendered in this graphics context this frame.

◆ setDynamicObjectRenderingCompletedCallback()

void osg::State::setDynamicObjectRenderingCompletedCallback ( DynamicObjectRenderingCompletedCallback cb)
inline

Set the callback to be called when the dynamic object count hits 0.

◆ setFogCoordAlias()

void osg::State::setFogCoordAlias ( const VertexAttribAlias alias)
inline

Set the vertex attribute aliasing for "fog coord".

This method needs to be called before render anything unless you really know what you're doing !

◆ setFogCoordPointer()

void osg::State::setFogCoordPointer ( const Array array)
inline

◆ setFrameStamp()

void osg::State::setFrameStamp ( FrameStamp fs)
inline

Set the frame stamp for the current frame.

◆ setGlobalDefaultAttribute()

void osg::State::setGlobalDefaultAttribute ( const StateAttribute attribute)
inline

◆ setGlobalDefaultModeValue()

void osg::State::setGlobalDefaultModeValue ( StateAttribute::GLMode  mode,
bool  enabled 
)
inline

◆ setGlobalDefaultTextureAttribute()

void osg::State::setGlobalDefaultTextureAttribute ( unsigned int  unit,
const StateAttribute attribute 
)
inline

◆ setGlobalDefaultTextureModeValue()

void osg::State::setGlobalDefaultTextureModeValue ( unsigned int  unit,
StateAttribute::GLMode  mode,
bool  enabled 
)
inline

◆ setGpuTimestamp()

void osg::State::setGpuTimestamp ( Timer_t  tick,
GLuint64  timestamp 
)
inline

◆ setGraphicsContext()

void osg::State::setGraphicsContext ( GraphicsContext context)
inline

Set the graphics context associated with that owns this State object.

◆ setGraphicsCostEstimator()

void osg::State::setGraphicsCostEstimator ( GraphicsCostEstimator gce)
inline

Set the helper class that provides applications with estimate on how much different graphics operations will cost.

◆ setInitialViewMatrix()

void osg::State::setInitialViewMatrix ( const osg::RefMatrix matrix)

◆ setInterleavedArrays()

void osg::State::setInterleavedArrays ( GLenum  format,
GLsizei  stride,
const GLvoid *  pointer 
)
inline

Wrapper around glInterleavedArrays(..).

also resets the internal array points and modes within osg::State to keep the other vertex array operations consistent.

◆ setLastAppliedProgramObject()

void osg::State::setLastAppliedProgramObject ( const Program::PerContextProgram program)
inline

◆ setMaxBufferObjectPoolSize()

void osg::State::setMaxBufferObjectPoolSize ( unsigned int  size)

◆ setMaxTexturePoolSize()

void osg::State::setMaxTexturePoolSize ( unsigned int  size)

◆ setModeValidity()

void osg::State::setModeValidity ( StateAttribute::GLMode  mode,
bool  valid 
)
inline

Set whether a particular OpenGL mode is valid in the current graphics context.

Use to disable OpenGL modes that are not supported by current graphics drivers/context.

References osg::State::ModeStack::valid.

◆ setNormalAlias()

void osg::State::setNormalAlias ( const VertexAttribAlias alias)
inline

Set the vertex attribute aliasing for "normal".

This method needs to be called before render anything unless you really know what you're doing !

◆ setNormalPointer() [1/2]

void osg::State::setNormalPointer ( const Array array)
inline

◆ setNormalPointer() [2/2]

void osg::State::setNormalPointer ( GLenum  type,
GLsizei  stride,
const GLvoid *  ptr,
GLboolean  normalized = GL_FALSE 
)
inline

◆ setRootStateSet()

void osg::State::setRootStateSet ( osg::StateSet stateset)

Set the root StateSet this is applied above all StateSet that are pushed and popped during the draw traversal.

◆ setSecondaryColorAlias()

void osg::State::setSecondaryColorAlias ( const VertexAttribAlias alias)
inline

Set the vertex attribute aliasing for "secondary color".

This method needs to be called before render anything unless you really know what you're doing !

◆ setSecondaryColorPointer()

void osg::State::setSecondaryColorPointer ( const Array array)
inline

◆ setShaderComposer()

void osg::State::setShaderComposer ( ShaderComposer sc)
inline

deprecated.

◆ setShaderCompositionEnabled()

void osg::State::setShaderCompositionEnabled ( bool  flag)
inline

◆ setStartTick()

void osg::State::setStartTick ( Timer_t  tick)
inline

◆ setTexCoordAliasList()

void osg::State::setTexCoordAliasList ( const VertexAttribAliasList aliasList)
inline

Set the vertex attribute aliasing list for texture coordinates.

This method needs to be called before render anything unless you really know what you're doing !

◆ setTexCoordPointer() [1/2]

void osg::State::setTexCoordPointer ( unsigned int  unit,
const Array array 
)
inline

◆ setTexCoordPointer() [2/2]

void osg::State::setTexCoordPointer ( unsigned int  unit,
GLint  size,
GLenum  type,
GLsizei  stride,
const GLvoid *  ptr,
GLboolean  normalized = GL_FALSE 
)
inline

◆ setTimestampBits()

void osg::State::setTimestampBits ( int  bits)
inline

◆ setUpVertexAttribAlias()

void osg::State::setUpVertexAttribAlias ( VertexAttribAlias alias,
GLuint  location,
const std::string  glName,
const std::string  osgName,
const std::string &  declaration 
)
protected

◆ setUseModelViewAndProjectionUniforms()

void osg::State::setUseModelViewAndProjectionUniforms ( bool  flag)

◆ setUseStateAttributeFixedFunction()

void osg::State::setUseStateAttributeFixedFunction ( bool  flag)

◆ setUseStateAttributeShaders()

void osg::State::setUseStateAttributeShaders ( bool  flag)

◆ setUseVertexAttributeAliasing()

void osg::State::setUseVertexAttributeAliasing ( bool  flag)

◆ setVertexAlias()

void osg::State::setVertexAlias ( const VertexAttribAlias alias)
inline

Set the vertex attribute aliasing for "vertex".

This method needs to be called before render anything unless you really know what you're doing !

◆ setVertexAttribIPointer()

void osg::State::setVertexAttribIPointer ( unsigned int  unit,
const Array array 
)
inline

◆ setVertexAttribLPointer()

void osg::State::setVertexAttribLPointer ( unsigned int  unit,
const Array array 
)
inline

◆ setVertexAttribPointer()

void osg::State::setVertexAttribPointer ( unsigned int  unit,
const Array array 
)
inline

◆ setVertexPointer() [1/2]

void osg::State::setVertexPointer ( const Array array)
inline

Set the vertex pointer using an osg::Array, and manage any VBO that are required.

◆ setVertexPointer() [2/2]

void osg::State::setVertexPointer ( GLint  size,
GLenum  type,
GLsizei  stride,
const GLvoid *  ptr,
GLboolean  normalized = GL_FALSE 
)
inline

◆ supportsShaderRequirement()

bool osg::State::supportsShaderRequirement ( const std::string &  shaderRequirement)

◆ supportsShaderRequirements()

bool osg::State::supportsShaderRequirements ( const osg::ShaderPragmas shaderPragmas)

◆ TexCoord()

void osg::State::TexCoord ( float  x,
float  y = 0.0f,
float  z = 0.0f,
float  w = 1.0f 
)
inline

◆ unbindDrawIndirectBufferObject()

void osg::State::unbindDrawIndirectBufferObject ( )
inline

◆ unbindElementBufferObject()

void osg::State::unbindElementBufferObject ( )
inline

◆ unbindPixelBufferObject()

void osg::State::unbindPixelBufferObject ( )
inline

◆ unbindVertexArrayObject()

void osg::State::unbindVertexArrayObject ( )
inline

◆ unbindVertexBufferObject()

void osg::State::unbindVertexBufferObject ( )
inline

◆ updateModelViewAndProjectionMatrixUniforms()

void osg::State::updateModelViewAndProjectionMatrixUniforms ( )

◆ useVertexArrayObject()

bool osg::State::useVertexArrayObject ( bool  useVAO) const
inline

Referenced by osg::Drawable::draw().

◆ useVertexBufferObject()

bool osg::State::useVertexBufferObject ( bool  useVBO) const
inline

Referenced by osg::Drawable::draw().

◆ VerteAttrib()

void osg::State::VerteAttrib ( unsigned int  location,
float  x,
float  y = 0.0f,
float  z = 0.0f,
float  w = 0.0f 
)
inline

◆ Vertex()

void osg::State::Vertex ( float  x,
float  y,
float  z,
float  w = 1.0f 
)
inline

Member Data Documentation

◆ _abortRenderingPtr

bool* osg::State::_abortRenderingPtr
protected

◆ _arrayDispatchers

AttributeDispatchers osg::State::_arrayDispatchers
protected

◆ _attributeBindingList

Program::AttribBindingList osg::State::_attributeBindingList
protected

◆ _attributeMap

AttributeMap osg::State::_attributeMap
protected

◆ _checkGLErrors

CheckForGLErrors osg::State::_checkGLErrors
protected

◆ _colorAlias

VertexAttribAlias osg::State::_colorAlias
protected

◆ _completeDynamicObjectRenderingCallback

osg::ref_ptr<DynamicObjectRenderingCompletedCallback> osg::State::_completeDynamicObjectRenderingCallback
protected

◆ _contextID

unsigned int osg::State::_contextID
protected

◆ _currentActiveTextureUnit

unsigned int osg::State::_currentActiveTextureUnit
protected

◆ _currentClientActiveTextureUnit

unsigned int osg::State::_currentClientActiveTextureUnit
protected

◆ _currentDIBO

GLBufferObject* osg::State::_currentDIBO
protected

◆ _currentPBO

GLBufferObject* osg::State::_currentPBO
protected

◆ _currentShaderCompositionDefines

StateSet::DefineList osg::State::_currentShaderCompositionDefines
protected

◆ _currentShaderCompositionProgram

osg::Program* osg::State::_currentShaderCompositionProgram
protected

◆ _currentShaderCompositionUniformList

StateSet::UniformList osg::State::_currentShaderCompositionUniformList
protected

◆ _currentVAO

GLuint osg::State::_currentVAO
protected

◆ _defineMap

DefineMap osg::State::_defineMap
protected

◆ _displaySettings

ref_ptr<DisplaySettings> osg::State::_displaySettings
protected

◆ _drawBuffer

GLenum osg::State::_drawBuffer
protected

◆ _dynamicObjectCount

unsigned int osg::State::_dynamicObjectCount
protected

◆ _extensionMap

ExtensionMap osg::State::_extensionMap

◆ _extensionProcsInitialized

bool osg::State::_extensionProcsInitialized
protected

◆ _fogCoordAlias

VertexAttribAlias osg::State::_fogCoordAlias
protected

◆ _forceVertexArrayObject

bool osg::State::_forceVertexArrayObject
protected

◆ _forceVertexBufferObject

bool osg::State::_forceVertexBufferObject
protected

◆ _frameStamp

ref_ptr<FrameStamp> osg::State::_frameStamp
protected

◆ _glActiveTexture

ActiveTextureProc osg::State::_glActiveTexture
protected

◆ _glBindBuffer

BindBufferProc osg::State::_glBindBuffer
protected

◆ _glClientActiveTexture

ActiveTextureProc osg::State::_glClientActiveTexture
protected

◆ _glDisableVertexAttribArray

DisableVertexAttribProc osg::State::_glDisableVertexAttribArray
protected

◆ _glDrawArraysInstanced

DrawArraysInstancedProc osg::State::_glDrawArraysInstanced
protected

◆ _glDrawElementsInstanced

DrawElementsInstancedProc osg::State::_glDrawElementsInstanced
protected

◆ _glEnableVertexAttribArray

EnableVertexAttribProc osg::State::_glEnableVertexAttribArray
protected

◆ _glExtensions

osg::ref_ptr<GLExtensions> osg::State::_glExtensions
protected

◆ _glFogCoordPointer

FogCoordPointerProc osg::State::_glFogCoordPointer
protected

◆ _glMaxTextureCoords

GLint osg::State::_glMaxTextureCoords
protected

◆ _glMaxTextureUnits

GLint osg::State::_glMaxTextureUnits
protected

◆ _glMultiTexCoord4f

MultiTexCoord4fProc osg::State::_glMultiTexCoord4f
protected

◆ _globalVertexArrayState

osg::ref_ptr<VertexArrayState> osg::State::_globalVertexArrayState
protected

◆ _glSecondaryColorPointer

SecondaryColorPointerProc osg::State::_glSecondaryColorPointer
protected

◆ _glVertexAttrib4f

VertexAttrib4fProc osg::State::_glVertexAttrib4f
protected

◆ _glVertexAttrib4fv

VertexAttrib4fvProc osg::State::_glVertexAttrib4fv
protected

◆ _glVertexAttribIPointer

VertexAttribIPointerProc osg::State::_glVertexAttribIPointer
protected

◆ _glVertexAttribLPointer

VertexAttribLPointerProc osg::State::_glVertexAttribLPointer
protected

◆ _glVertexAttribPointer

VertexAttribPointerProc osg::State::_glVertexAttribPointer
protected

◆ _gpuTick

Timer_t osg::State::_gpuTick
protected

◆ _gpuTimestamp

GLuint64 osg::State::_gpuTimestamp
protected

◆ _graphicsContext

GraphicsContext* osg::State::_graphicsContext
protected

◆ _graphicsCostEstimator

osg::ref_ptr<GraphicsCostEstimator> osg::State::_graphicsCostEstimator
protected

◆ _identity

ref_ptr<const RefMatrix> osg::State::_identity
protected

◆ _initialInverseViewMatrix

Matrix osg::State::_initialInverseViewMatrix
protected

◆ _initialViewMatrix

ref_ptr<const RefMatrix> osg::State::_initialViewMatrix
protected

◆ _isFogCoordSupported

bool osg::State::_isFogCoordSupported
protected

◆ _isSecondaryColorSupported

bool osg::State::_isSecondaryColorSupported
protected

◆ _isVertexArrayObjectSupported

bool osg::State::_isVertexArrayObjectSupported
protected

◆ _isVertexBufferObjectSupported

bool osg::State::_isVertexBufferObjectSupported
protected

◆ _lastAppliedProgramObject

const Program::PerContextProgram* osg::State::_lastAppliedProgramObject
protected

◆ _maxBufferObjectPoolSize

unsigned int osg::State::_maxBufferObjectPoolSize
protected

◆ _maxTexturePoolSize

unsigned int osg::State::_maxTexturePoolSize
protected

◆ _modelView

ref_ptr<const RefMatrix> osg::State::_modelView
protected

◆ _modelViewCache

ref_ptr<RefMatrix> osg::State::_modelViewCache
protected

◆ _modelViewMatrixUniform

ref_ptr<Uniform> osg::State::_modelViewMatrixUniform
protected

◆ _modelViewProjectionMatrixUniform

ref_ptr<Uniform> osg::State::_modelViewProjectionMatrixUniform
protected

◆ _modeMap

ModeMap osg::State::_modeMap
protected

◆ _normalAlias

VertexAttribAlias osg::State::_normalAlias
protected

◆ _normalMatrixUniform

ref_ptr<Uniform> osg::State::_normalMatrixUniform
protected

◆ _projection

ref_ptr<const RefMatrix> osg::State::_projection
protected

◆ _projectionMatrixUniform

ref_ptr<Uniform> osg::State::_projectionMatrixUniform
protected

◆ _quadIndicesGLuint

IndicesGLuint osg::State::_quadIndicesGLuint[4]

◆ _quadIndicesGLushort

IndicesGLushort osg::State::_quadIndicesGLushort[4]

◆ _readBuffer

GLenum osg::State::_readBuffer
protected

◆ _rootStateSet

osg::ref_ptr<osg::StateSet> osg::State::_rootStateSet
protected

◆ _secondaryColorAlias

VertexAttribAlias osg::State::_secondaryColorAlias
protected

◆ _shaderComposer

osg::ref_ptr<ShaderComposer> osg::State::_shaderComposer
protected

◆ _shaderCompositionDirty

bool osg::State::_shaderCompositionDirty
protected

◆ _shaderCompositionEnabled

bool osg::State::_shaderCompositionEnabled
protected

◆ _startTick

Timer_t osg::State::_startTick
protected

◆ _stateStateStack

StateSetStack osg::State::_stateStateStack
protected

◆ _stringModeMap

StringModeMap osg::State::_stringModeMap
protected

◆ _texCoordAliasList

VertexAttribAliasList osg::State::_texCoordAliasList
protected

◆ _textureAttributeMapList

TextureAttributeMapList osg::State::_textureAttributeMapList
protected

◆ _textureFormat

osg::ref_ptr<osg::IntArrayUniform> osg::State::_textureFormat
protected

◆ _textureModeDefineMapList

TextureModeDefineMapList osg::State::_textureModeDefineMapList
protected

◆ _textureModeMapList

TextureModeMapList osg::State::_textureModeMapList
protected

◆ _timestampBits

int osg::State::_timestampBits
protected

◆ _uniformMap

UniformMap osg::State::_uniformMap
protected

◆ _useModelViewAndProjectionUniforms

bool osg::State::_useModelViewAndProjectionUniforms
protected

◆ _useStateAttributeFixedFunction

bool osg::State::_useStateAttributeFixedFunction
protected

◆ _useStateAttributeShaders

bool osg::State::_useStateAttributeShaders
protected

◆ _useVertexAttributeAliasing

bool osg::State::_useVertexAttributeAliasing
protected

◆ _vas

VertexArrayState* osg::State::_vas
protected

◆ _vertexAlias

VertexAttribAlias osg::State::_vertexAlias
protected

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