OpenSceneGraph 3.6.5
osg::PixelDataBufferObject Class Reference

This object represent a general class of pixel buffer objects, which are capable of allocating buffer object (memory) on the GPU. More...

#include <BufferObject>

Inheritance diagram for osg::PixelDataBufferObject:

Public Types

enum  Mode { NONE = 0 , READ = 1 , WRITE = 2 }
Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }

Public Member Functions

 PixelDataBufferObject ()
 PixelDataBufferObject (const PixelDataBufferObject &pbo, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Object (osg, PixelDataBufferObject)
void setDataSize (unsigned int size)
 Set new size of the buffer object. This will reallocate the memory on the next compile.
unsigned int getDataSize () const
 Get data size of the used buffer.
virtual void compileBuffer (State &state) const
 Compile the buffer (reallocate the memory if buffer is dirty)
virtual void bindBufferInReadMode (State &state)
 Bind the buffer in read mode, which means that data can be downloaded from the buffer (note: GL_PIXEL_UNPACK_BUFFER_ARB)
virtual void bindBufferInWriteMode (State &state)
 Bind the buffer in write mode, which means following OpenGL instructions will write data into the buffer (note: GL_PIXEL_PACK_BUFFER_ARB)
virtual void unbindBuffer (unsigned int contextID) const
 Unbind the buffer.
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size.
Mode getMode (unsigned int contextID) const
Public Member Functions inherited from osg::BufferObject
 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 immediately 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 immediately.
void dirty ()
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.
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name.
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0.
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0.
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0.
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0.
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0.
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0.
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0.
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0.
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0.
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0.
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0.
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0.
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
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.
template<class T>
void setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
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.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
template<class T>
void setUserData (const ref_ptr< T > &ud)
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
 Convenience 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)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
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
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.
 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 no longer referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer 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.

Protected Types

typedef osg::buffered_value< unsigned int > ModeList
Protected Types inherited from osg::BufferObject
typedef std::vector< BufferData * > BufferDataList
typedef osg::buffered_object< osg::ref_ptr< GLBufferObject > > GLBufferObjects

Protected Member Functions

virtual ~PixelDataBufferObject ()
Protected Member Functions inherited from osg::BufferObject
 ~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

ModeList _mode
Protected Attributes inherited from osg::BufferObject
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

Static Public Member Functions inherited from osg::BufferObject
static void deleteBufferObject (unsigned int contextID, GLuint globj)
 deprecated, provided for backwards compatibility.
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced.
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler.

Detailed Description

This object represent a general class of pixel buffer objects, which are capable of allocating buffer object (memory) on the GPU.

The memory can then be used either for CPU-GPU pixel transfer or directly for GPU-GPU transfer, without CPU intervention.

Member Typedef Documentation

◆ ModeList

Member Enumeration Documentation

◆ Mode

Enumerator
NONE 

A normal mode of this data buffer.

READ 

Buffer is in read mode (.

See also
bindBufferInReadMode)
WRITE 

Buffer is in write mode (.

See also
bindBufferInWriteMode)

Constructor & Destructor Documentation

◆ PixelDataBufferObject() [1/2]

osg::PixelDataBufferObject::PixelDataBufferObject ( )

◆ PixelDataBufferObject() [2/2]

osg::PixelDataBufferObject::PixelDataBufferObject ( const PixelDataBufferObject & pbo,
const CopyOp & copyop = CopyOp::SHALLOW_COPY )

◆ ~PixelDataBufferObject()

virtual osg::PixelDataBufferObject::~PixelDataBufferObject ( )
protectedvirtual

Member Function Documentation

◆ bindBufferInReadMode()

virtual void osg::PixelDataBufferObject::bindBufferInReadMode ( State & state)
virtual

Bind the buffer in read mode, which means that data can be downloaded from the buffer (note: GL_PIXEL_UNPACK_BUFFER_ARB)

◆ bindBufferInWriteMode()

virtual void osg::PixelDataBufferObject::bindBufferInWriteMode ( State & state)
virtual

Bind the buffer in write mode, which means following OpenGL instructions will write data into the buffer (note: GL_PIXEL_PACK_BUFFER_ARB)

◆ compileBuffer()

virtual void osg::PixelDataBufferObject::compileBuffer ( State & state) const
virtual

Compile the buffer (reallocate the memory if buffer is dirty)

◆ getDataSize()

unsigned int osg::PixelDataBufferObject::getDataSize ( ) const
inline

Get data size of the used buffer.

References osg::BufferObject::_profile.

◆ getMode()

Mode osg::PixelDataBufferObject::getMode ( unsigned int contextID) const
inline

References _mode.

◆ META_Object()

osg::PixelDataBufferObject::META_Object ( osg ,
PixelDataBufferObject  )

◆ resizeGLObjectBuffers()

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

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::BufferObject.

◆ setDataSize()

void osg::PixelDataBufferObject::setDataSize ( unsigned int size)
inline

Set new size of the buffer object. This will reallocate the memory on the next compile.

References osg::BufferObject::_profile, and osg::BufferObject::dirty().

◆ unbindBuffer()

virtual void osg::PixelDataBufferObject::unbindBuffer ( unsigned int contextID) const
virtual

Unbind the buffer.

Member Data Documentation

◆ _mode

ModeList osg::PixelDataBufferObject::_mode
mutableprotected

Referenced by getMode().


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

osg logo
Generated at Sun Jul 20 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.