OpenSceneGraph  3.0.1
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.
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
 return the name of the object's library.
virtual const char * className () const
 return the name of the object's class type.
void setTarget (GLenum target)
GLenum getTarget () const
void setUsage (GLenum usage)
 Set what type of usage the buffer object will have.
GLenum getUsage () const
 Get the type of usage the buffer object has been set up for.
BufferObjectProfilegetProfile ()
const BufferObjectProfilegetProfile () const
void setCopyDataAndReleaseGLBufferObject (bool copyAndRelease)
 Set whether the BufferObject should use a GLBufferObject just for copying the BufferData and release it immmediately so that it may be reused.
bool getCopyDataAndReleaseGLBufferObject () const
 Get whether the BufferObject should use a GLBufferObject just for copying the BufferData and release it immmediately.
void dirty ()
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size.
void releaseGLObjects (State *state=0) const
 If State is non-zero, this function releases OpenGL objects for the specified graphics context.
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.
 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.
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type.
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type.
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience 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.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Static Public Member Functions

static void deleteBufferObject (unsigned int contextID, GLuint globj)
 deprecated, provided for backwards compatibility.

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

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

Constructor & Destructor Documentation

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

Copy constructor using CopyOp to manage deep vs shallow copy.

osg::BufferObject::~BufferObject ( )
protected

Member Function Documentation

unsigned int osg::BufferObject::addBufferData ( BufferData bd)
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.

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

deprecated, provided for backwards compatibility.

void osg::BufferObject::dirty ( )
BufferData* osg::BufferObject::getBufferData ( unsigned int  index)
inline
const BufferData* osg::BufferObject::getBufferData ( unsigned int  index) const
inline
bool osg::BufferObject::getCopyDataAndReleaseGLBufferObject ( ) const
inline

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

GLBufferObject* osg::BufferObject::getGLBufferObject ( unsigned int  contextID) const
inline
unsigned int osg::BufferObject::getNumBufferData ( ) const
inline
GLBufferObject* osg::BufferObject::getOrCreateGLBufferObject ( unsigned int  contextID) const
inline
BufferObjectProfile& osg::BufferObject::getProfile ( )
inline
const BufferObjectProfile& osg::BufferObject::getProfile ( ) const
inline
GLenum osg::BufferObject::getTarget ( ) const
inline
GLenum osg::BufferObject::getUsage ( ) const
inline

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

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

Reimplemented from osg::Object.

References NULL.

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.

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.

void osg::BufferObject::removeBufferData ( unsigned int  index)
void osg::BufferObject::removeBufferData ( BufferData bd)
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.

void osg::BufferObject::setBufferData ( unsigned int  index,
BufferData bd 
)
void osg::BufferObject::setCopyDataAndReleaseGLBufferObject ( bool  copyAndRelease)
inline

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

void osg::BufferObject::setGLBufferObject ( unsigned int  contextID,
GLBufferObject glbo 
)
inline
void osg::BufferObject::setTarget ( GLenum  target)
inline
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 osg::BufferObject::_bufferDataList
protected
bool osg::BufferObject::_copyDataAndReleaseGLBufferObject
protected
GLBufferObjects osg::BufferObject::_glBufferObjects
mutableprotected
BufferObjectProfile osg::BufferObject::_profile
protected

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

osg logo
Generated at Tue Sep 4 2012 06:14:31 for the OpenSceneGraph by doxygen 1.8.1.2.