OpenSceneGraph
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osg::BufferObject Class Reference
Inheritance diagram for osg::BufferObject:
Inheritance graph
[legend]

Public Member Functions

 BufferObject ()
 
 BufferObject (const BufferObject &bo, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy. More...
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 return the name of the object's library. More...
 
virtual const char * className () const
 return the name of the object's class type. More...
 
void setTarget (GLenum target)
 
GLenum getTarget () const
 
void setUsage (GLenum usage)
 Set what type of usage the buffer object will have. More...
 
GLenum getUsage () const
 Get the type of usage the buffer object has been set up for. More...
 
void setMappingBitfield (GLbitfield b)
 Enable GL4 buffer storage features (override usage if setted) More...
 
GLbitfield getMappingBitfield () const
 
BufferObjectProfilegetProfile ()
 
const BufferObjectProfilegetProfile () const
 
void setCopyDataAndReleaseGLBufferObject (bool copyAndRelease)
 Set whether the BufferObject should use a GLBufferObject just for copying the BufferData and release it immediately so that it may be reused. More...
 
bool getCopyDataAndReleaseGLBufferObject () const
 Get whether the BufferObject should use a GLBufferObject just for copying the BufferData and release it immediately. More...
 
void dirty ()
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size. More...
 
void releaseGLObjects (State *state=0) const
 If State is non-zero, this function releases OpenGL objects for the specified graphics context. More...
 
unsigned int addBufferData (BufferData *bd)
 
void removeBufferData (unsigned int index)
 
void removeBufferData (BufferData *bd)
 
void setBufferData (unsigned int index, BufferData *bd)
 
BufferDatagetBufferData (unsigned int index)
 
const BufferDatagetBufferData (unsigned int index) const
 
unsigned int getNumBufferData () const
 
void setGLBufferObject (unsigned int contextID, GLBufferObject *glbo)
 
GLBufferObjectgetGLBufferObject (unsigned int contextID) const
 
GLBufferObjectgetOrCreateGLBufferObject (unsigned int contextID) const
 
unsigned int computeRequiredBufferSize () const
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual Uniform * asUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformBaseasUniformBase () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual UniformBaseasUniformBase ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const Uniform * asUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- 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 &)
 
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...
 

Static Public Member Functions

static void deleteBufferObject (unsigned int contextID, GLuint globj)
 deprecated, provided for backwards compatibility. More...
 
- 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...
 

Protected Types

typedef std::vector< BufferData *> BufferDataList
 
typedef osg::buffered_object< osg::ref_ptr< GLBufferObject > > GLBufferObjects
 

Protected Member Functions

 ~BufferObject ()
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

BufferObjectProfile _profile
 
bool _copyDataAndReleaseGLBufferObject
 
BufferDataList _bufferDataList
 
GLBufferObjects _glBufferObjects
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Member Typedef Documentation

◆ BufferDataList

typedef std::vector< BufferData* > osg::BufferObject::BufferDataList
protected

◆ GLBufferObjects

Constructor & Destructor Documentation

◆ BufferObject() [1/2]

osg::BufferObject::BufferObject ( )

◆ BufferObject() [2/2]

osg::BufferObject::BufferObject ( const BufferObject bo,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

◆ ~BufferObject()

osg::BufferObject::~BufferObject ( )
protected

Member Function Documentation

◆ addBufferData()

unsigned int osg::BufferObject::addBufferData ( BufferData bd)

◆ className()

virtual const char* osg::BufferObject::className ( ) const
inlinevirtual

return the name of the object's class type.

Must be defined by derived classes.

Implements osg::Object.

◆ computeRequiredBufferSize()

unsigned int osg::BufferObject::computeRequiredBufferSize ( ) const

◆ deleteBufferObject()

static void osg::BufferObject::deleteBufferObject ( unsigned int  contextID,
GLuint  globj 
)
static

deprecated, provided for backwards compatibility.

◆ dirty()

void osg::BufferObject::dirty ( )

◆ getBufferData() [1/2]

BufferData* osg::BufferObject::getBufferData ( unsigned int  index)
inline

◆ getBufferData() [2/2]

const BufferData* osg::BufferObject::getBufferData ( unsigned int  index) const
inline

◆ getCopyDataAndReleaseGLBufferObject()

bool osg::BufferObject::getCopyDataAndReleaseGLBufferObject ( ) const
inline

Get whether the BufferObject should use a GLBufferObject just for copying the BufferData and release it immediately.

References osg::releaseGLObjects(), and osg::resizeGLObjectBuffers().

◆ getGLBufferObject()

GLBufferObject* osg::BufferObject::getGLBufferObject ( unsigned int  contextID) const
inline

◆ getMappingBitfield()

GLbitfield osg::BufferObject::getMappingBitfield ( ) const
inline

◆ getNumBufferData()

unsigned int osg::BufferObject::getNumBufferData ( ) const
inline

◆ getOrCreateGLBufferObject()

GLBufferObject* osg::BufferObject::getOrCreateGLBufferObject ( unsigned int  contextID) const

◆ getProfile() [1/2]

BufferObjectProfile& osg::BufferObject::getProfile ( )
inline

◆ getProfile() [2/2]

const BufferObjectProfile& osg::BufferObject::getProfile ( ) const
inline

◆ getTarget()

GLenum osg::BufferObject::getTarget ( ) const
inline

◆ getUsage()

GLenum osg::BufferObject::getUsage ( ) const
inline

Get the type of usage the buffer object has been set up for.

◆ isSameKindAs()

virtual bool osg::BufferObject::isSameKindAs ( const Object obj) const
inlinevirtual

Reimplemented from osg::Object.

References NULL.

◆ libraryName()

virtual const char* osg::BufferObject::libraryName ( ) const
inlinevirtual

return the name of the object's library.

Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Implements osg::Object.

◆ releaseGLObjects()

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

If State is non-zero, this function releases OpenGL objects for the specified graphics context.

Otherwise, releases OpenGL objects for all graphics contexts.

Reimplemented from osg::Object.

◆ removeBufferData() [1/2]

void osg::BufferObject::removeBufferData ( unsigned int  index)

◆ removeBufferData() [2/2]

void osg::BufferObject::removeBufferData ( BufferData bd)

◆ resizeGLObjectBuffers()

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

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Object.

Reimplemented in osg::PixelDataBufferObject.

◆ setBufferData()

void osg::BufferObject::setBufferData ( unsigned int  index,
BufferData bd 
)

◆ setCopyDataAndReleaseGLBufferObject()

void osg::BufferObject::setCopyDataAndReleaseGLBufferObject ( bool  copyAndRelease)
inline

Set whether the BufferObject should use a GLBufferObject just for copying the BufferData and release it immediately so that it may be reused.

◆ setGLBufferObject()

void osg::BufferObject::setGLBufferObject ( unsigned int  contextID,
GLBufferObject glbo 
)
inline

◆ setMappingBitfield()

void osg::BufferObject::setMappingBitfield ( GLbitfield  b)
inline

Enable GL4 buffer storage features (override usage if setted)

◆ setTarget()

void osg::BufferObject::setTarget ( GLenum  target)
inline

◆ setUsage()

void osg::BufferObject::setUsage ( GLenum  usage)
inline

Set what type of usage the buffer object will have.

Options are: GL_STREAM_DRAW, GL_STREAM_READ, GL_STREAM_COPY, GL_STATIC_DRAW, GL_STATIC_READ, GL_STATIC_COPY, GL_DYNAMIC_DRAW, GL_DYNAMIC_READ, or GL_DYNAMIC_COPY.

Member Data Documentation

◆ _bufferDataList

BufferDataList osg::BufferObject::_bufferDataList
protected

◆ _copyDataAndReleaseGLBufferObject

bool osg::BufferObject::_copyDataAndReleaseGLBufferObject
protected

◆ _glBufferObjects

GLBufferObjects osg::BufferObject::_glBufferObjects
mutableprotected

◆ _profile

BufferObjectProfile osg::BufferObject::_profile
protected

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