This object represent a general class of pixel buffer objects, which are capable of allocating buffer object (memory) on the GPU. More...
Inheritance diagram for osg::PixelDataBufferObject:
Collaboration 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 (const PixelDataBufferObject &pbo, const CopyOp ©op=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. More... | |
| Mode | getMode (unsigned int contextID) const |
| Public Member Functions inherited from osg::BufferObject | |
| BufferObject (const BufferObject &bo, const CopyOp ©op=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... | |
| BufferObjectProfile & | getProfile () |
| const BufferObjectProfile & | getProfile () 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. More... | |
| bool | getCopyDataAndReleaseGLBufferObject () const |
| Get whether the BufferObject should use a GLBufferObject just for copying the BufferData and release it immmediately. More... | |
| void | dirty () |
| 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) |
| BufferData * | getBufferData (unsigned int index) |
| const BufferData * | getBufferData (unsigned int index) const |
| unsigned int | getNumBufferData () const |
| void | setGLBufferObject (unsigned int contextID, GLBufferObject *glbo) |
| GLBufferObject * | getGLBufferObject (unsigned int contextID) const |
| GLBufferObject * | getOrCreateGLBufferObject (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 ©op=CopyOp::SHALLOW_COPY) | |
| Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More... | |
| virtual Object * | cloneType () const =0 |
| Clone the type of an object, with Object* return type. More... | |
| virtual Object * | clone (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 Node * | asNode () |
| Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More... | |
| virtual const Node * | asNode () const |
| convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More... | |
| virtual NodeVisitor * | asNodeVisitor () |
| Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More... | |
| virtual const NodeVisitor * | asNodeVisitor () const |
| convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More... | |
| virtual StateAttribute * | asStateAttribute () |
| Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More... | |
| virtual const StateAttribute * | asStateAttribute () 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 Uniform * | asUniform () const |
| convert 'const this' into a const Uniform pointer if Object is a Uniform, 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::UserDataContainer * | getUserDataContainer () |
| get the UserDataContainer attached to this object. More... | |
| const osg::UserDataContainer * | getUserDataContainer () const |
| get the const UserDataContainer attached to this object. More... | |
| osg::UserDataContainer * | getOrCreateUserDataContainer () |
| 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 Referenced * | getUserData () |
| Get user data. More... | |
| virtual const Referenced * | getUserData () 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 | |
| Public Member Functions inherited from osg::Referenced | |
| Referenced (bool threadSafeRefUnref) | |
| Referenced (const Referenced &) | |
| Referenced & | operator= (const Referenced &) |
| bool | getThreadSafeRefUnref () const |
| Get whether a mutex is used to ensure ref() and unref() are thread safe. More... | |
| bool | getThreadSafeRefUnref () const |
| OpenThreads::Mutex * | getRefMutex () const |
| Get the mutex used to ensure thread safety of ref()/unref(). More... | |
| OpenThreads::Mutex * | getRefMutex () const |
| 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... | |
| ObserverSet * | getObserverSet () const |
| Get the ObserverSet if one is attached, otherwise return NULL. More... | |
| ObserverSet * | getOrCreateObserverSet () 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... | |
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 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 |
| OpenThreads::Mutex * | _refMutex |
| int | _refCount |
| void * | _observerSet |
Additional Inherited Members | |
| Static Public Member Functions inherited from osg::BufferObject | |
| static void | deleteBufferObject (unsigned int contextID, GLuint globj) |
| deprecated, provided for backwards compatibility. More... | |
| 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. More... | |
| static void | setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting) |
| Set whether reference counting should use a mutex for thread safe reference counting. More... | |
| static bool | getThreadSafeReferenceCounting () |
| Get whether reference counting is active. More... | |
| static void | setDeleteHandler (DeleteHandler *handler) |
| Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More... | |
| static DeleteHandler * | getDeleteHandler () |
| Get a DeleteHandler. More... | |
| Protected Member Functions inherited from osg::Object | |
| virtual | ~Object () |
| Object destructor. More... | |
| Protected Member Functions inherited from osg::Referenced | |
| void | signalObserversAndDelete (bool signalDelete, bool doDelete) const |
| void | deleteUsingDeleteHandler () const |
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 Enumeration Documentation
◆ Mode
| Enumerator | |
|---|---|
| NONE | A normal mode of this data buffer. |
| READ | Buffer is in read mode (.
|
| WRITE | Buffer is in write mode (.
|
Member Function Documentation
◆ resizeGLObjectBuffers()
|
virtual |
Resize any per context GLObject buffers to specified size.
Reimplemented from osg::BufferObject.
The documentation for this class was generated from the following file:
- /home/karlu20/private/installs/OpenSceneGraph/include/osg/BufferObject
