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

#include <BufferObject>

Inheritance diagram for osg::BufferObject:
osg::Object osg::Referenced osg::AtomicCounterBufferObject osg::DrawIndirectBufferObject osg::ElementBufferObject osg::PixelBufferObject osg::PixelDataBufferObject osg::ShaderStorageBufferObject osg::UniformBufferObject osg::VertexBufferObject

Public Member Functions

 BufferObject ()
 
 BufferObject (const BufferObject &bo, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
void setTarget (GLenum target)
 
GLenum getTarget () const
 
void setUsage (GLenum usage)
 
GLenum getUsage () const
 
BufferObjectProfilegetProfile ()
 
const BufferObjectProfilegetProfile () const
 
void setCopyDataAndReleaseGLBufferObject (bool copyAndRelease)
 
bool getCopyDataAndReleaseGLBufferObject () const
 
void dirty ()
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 
void releaseGLObjects (State *state=0) const
 
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 ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 
virtual Objectclone (const CopyOp &) const =0
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Static Public Member Functions

static void deleteBufferObject (unsigned int contextID, GLuint globj)
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

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

◆ getGLBufferObject()

GLBufferObject * osg::BufferObject::getGLBufferObject ( unsigned int  contextID) 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.

◆ 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 ( BufferData bd)

◆ removeBufferData() [2/2]

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

◆ 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

◆ 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: