openscenegraph
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osg::PixelDataBufferObject Class Reference
Inheritance diagram for osg::PixelDataBufferObject:
osg::BufferObject osg::Object osg::Referenced

Public Types

enum  Mode { NONE = 0, READ = 1, WRITE = 2 }

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)
Mode getMode (unsigned int contextID) const
- Public Member Functions inherited from osg::BufferObject
 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 ()
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
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)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
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)
- 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

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

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

Member Enumeration Documentation

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

osg::PixelDataBufferObject::PixelDataBufferObject ( )
osg::PixelDataBufferObject::PixelDataBufferObject ( const PixelDataBufferObject pbo,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)
virtual osg::PixelDataBufferObject::~PixelDataBufferObject ( )
protectedvirtual

Member Function Documentation

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)

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)

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

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

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

Get data size of the used buffer.

Mode osg::PixelDataBufferObject::getMode ( unsigned int  contextID) const
inline
osg::PixelDataBufferObject::META_Object ( osg  ,
PixelDataBufferObject   
)
virtual void osg::PixelDataBufferObject::resizeGLObjectBuffers ( unsigned int  maxSize)
virtual

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::BufferObject.

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

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

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

Unbind the buffer.

Member Data Documentation

ModeList osg::PixelDataBufferObject::_mode
mutableprotected

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