Abstract base class for buffer object management More...
#include <Inventor/devices/SoBufferObject.h>
Public Types | |
enum | AccessMode { READ_ONLY , SET , READ_WRITE } |
This enum provides the possible access modes for a mapped buffer object. More... | |
Public Member Functions | |
void | lockBuffer () |
Locks the buffer against concurrent calls from different threads. | |
void | unlockBuffer () |
Unlocks the buffer object. | |
virtual bool | setSize (size_t size) |
Sets the size in bytes of the buffer object. | |
virtual size_t | getSize () const |
Returns the size, in bytes, of the buffer object. | |
virtual void * | map (AccessMode accessMode, size_t offset=0, size_t count=SO_BUFFER_SIZE_ALL) |
Map the buffer to a system memory address and allows the mapping of a sub part of the buffer object into CPU memory. | |
virtual void | unmap () |
Unmaps the buffer from CPU address space. | |
virtual void | map (SoBufferObject *targetBufferObject, AccessMode accessMode, size_t startPosition=0, size_t mappingSize=SO_BUFFER_SIZE_ALL) |
Maps the current buffer object into the specified buffer object. | |
virtual void | unmap (SoBufferObject *bufferObject) |
Unmap this buffer from the specified buffer object. | |
virtual void | memcpy (SoBufferObject *sourceBufferObject, size_t destOffset=0, size_t sourceOffset=0, size_t copySize=SO_BUFFER_SIZE_ALL) |
Copies data from the specified buffer object into this buffer object. | |
virtual void | memset (void *value, size_t valueSize=1, size_t offset=0, size_t count=SO_BUFFER_SIZE_ALL) |
This function sets the contents of (or a portion of) this buffer object to the specified value. | |
virtual SoBufferObject * | createInstance () const =0 |
Create a new buffer with the same properties as the current one. | |
virtual void | clearInstance ()=0 |
Free the memory allocated by the buffer object. | |
SoDeviceContext * | getContext () const |
Returns the device context where this buffer is valid. | |
SoBufferObject * | getMappedBufferObject () const |
Returns a pointer to the buffer object which is mapped by the actual object. | |
AccessMode | getMappedBufferObjectAccessMode () |
Returns the access mode used for the buffer mapping. | |
size_t | getMappedBufferObjectPosition () const |
Returns the position in the source buffer mapped in this buffer. | |
size_t | getMappedBufferObjectSize () const |
Returns the size of the mapped area in bytes. | |
Public Member Functions inherited from SoRefCounter | |
void | ref () const |
Adds a reference to an instance. | |
void | unref () const |
Removes a reference from an instance. | |
void | unrefNoDelete () const |
unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero. | |
int | getRefCount () const |
Returns current reference count. | |
void | lock () const |
lock this instance. | |
void | unlock () const |
unlock this instance. | |
Public Member Functions inherited from SoTypedObject | |
virtual SoType | getTypeId () const =0 |
Returns the type identifier for a specific instance. | |
SbBool | isOfType (const SoType &type) const |
Returns TRUE if this object is of the type specified in type or is derived from that type. | |
template<typename TypedObjectClass > | |
SbBool | isOfType () const |
Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class. | |
Static Public Member Functions | |
static SoCpuBufferObjectCache * | getBufferObjectCache () |
Returns the cache manager object. | |
Static Public Member Functions inherited from SoTypedObject | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Friends | |
class | SoCpuBufferObject |
Abstract base class for buffer object management
This class provides generic functions to manage buffer objects.
There are specific implementations of this class for buffer objects on each type of device:
In many cases the abstract SoBufferObject methods allow the application to handle buffer objects without knowing the specific type of the buffer. This is very convenient when computation is implemented on multiple devices.
Since version 8.0, some Open Inventor classes take or return data using an SoBufferObject (or derived class). For example texture images (see SoSFImage), geometry data (see SoBufferedShape) and tiles of volume data (see SoLDMDataAccess).
Creating a buffer object
Allocating memory in a buffer object:
Loading data and retrieving data:
SoCpuBufferObject, SoGpuBufferObject, SoGLBufferObject, SoCpuDevice, SoGLDevice, SoBufferedShape
Definition at line 193 of file SoBufferObject.h.
This enum provides the possible access modes for a mapped buffer object.
Definition at line 202 of file SoBufferObject.h.
|
pure virtual |
Free the memory allocated by the buffer object.
Implemented in SoCpuBufferObject, SoGLBufferObject, SoGpuBufferObject, and SoInteropBufferObject.
|
pure virtual |
Create a new buffer with the same properties as the current one.
The new instance will have the same context or device properties, but no memory is allocated.
Implemented in SoCpuBufferObject, SoGLBufferObject, SoGpuBufferObject, SoCpuBufferBitSet, and SoInteropBufferObject.
|
static |
Returns the cache manager object.
This object manages a cache of SoCpuBufferObject objects. SoBufferObject creates an instance of this class that is primarily used for the LDM tile cache (see SoLDMGlobalResourceParameters for more information). The buffer object cache can be accessed using the SoBufferObject static method getBufferObjectCache. Default size is 50 or the value of OIV_BUFFER_OBJECT_CACHE_SIZE.
SoDeviceContext * SoBufferObject::getContext | ( | ) | const |
Returns the device context where this buffer is valid.
SoBufferObject * SoBufferObject::getMappedBufferObject | ( | ) | const |
Returns a pointer to the buffer object which is mapped by the actual object.
AccessMode SoBufferObject::getMappedBufferObjectAccessMode | ( | ) |
Returns the access mode used for the buffer mapping.
size_t SoBufferObject::getMappedBufferObjectPosition | ( | ) | const |
Returns the position in the source buffer mapped in this buffer.
size_t SoBufferObject::getMappedBufferObjectSize | ( | ) | const |
Returns the size of the mapped area in bytes.
|
virtual |
Returns the size, in bytes, of the buffer object.
void SoBufferObject::lockBuffer | ( | ) |
Locks the buffer against concurrent calls from different threads.
This is a blocking call. In other words it will not return immediately if another thread currently has the buffer locked.
|
virtual |
Map the buffer to a system memory address and allows the mapping of a sub part of the buffer object into CPU memory.
Notes:
Reimplemented in SoGLBufferObject, SoCpuBufferBitSet, SoCpuBufferCompressed, SoCpuBufferFromVolumeReader, and SoCpuBufferUniform.
|
virtual |
Maps the current buffer object into the specified buffer object.
This is useful in order to use a buffer in multiple contexts. The default is to map the entire contents of this buffer, but it is also possible to map a subset of this buffer's memory using the startPosition and mappingSize parameters.
A source buffer may be mapped into multiple target buffers. However a target buffer can only be mapped from one source buffer at a time. If a different source buffer is currently mapped into the target buffer, it is automatically unmapped and may be left in an undefined state.
Note: If the current buffer is empty or startPosition is beyond the end of the managed memory, the buffer is not mapped (and an error message is issued in debug builds).
targetBufferObject | The buffer object which will be the mapped version of this buffer. |
accessMode | The access mode used for the mapping. |
startPosition | Offset (in bytes) in source buffer to map from (default is start of buffer). |
mappingSize | Size (in bytes) from the startPosition, if SO_BUFFER_SIZE_ALL then the whole buffer is mapped. |
Reimplemented in SoGLBufferObject, SoCpuBufferFromVolumeReader, SoCpuBufferBitSet, SoCpuBufferCompressed, and SoCpuBufferUniform.
|
virtual |
Copies data from the specified buffer object into this buffer object.
If the size or the offset are not valid an error is reported (SoDebugError). This buffer is not resized, if it is too small an error is reported.
sourceBufferObject | The buffer object to be copied. |
destOffset | The starting offset in the destination buffer object, useful for data subsets. |
sourceOffset | The starting offset in the source buffer object, useful for data subsets. |
copySize | The number of bytes to copy from the source buffer object (SO_BUFFER_SIZE_ALL means all). |
Reimplemented in SoGLBufferObject, SoCpuBufferUniform, and SoCpuBufferBitSet.
|
virtual |
This function sets the contents of (or a portion of) this buffer object to the specified value.
The valueSize parameter provides a way to do a memset with float, short, byte, etc values. The number of bytes set in this buffer object is exactly valueSize*count. The first byte changed in this buffer is given by the offset argument.
value | is a pointer to the value to set in the buffer. |
valueSize | The size in bytes of the value. Default is 1 byte. |
offset | The offset in bytes (where to start setting values). Default is 0. |
count | The number of values to set. Default is number of bytes in buffer. |
EXAMPLE
Reimplemented in SoCpuBufferUniform, and SoCpuBufferBitSet.
|
virtual |
Sets the size in bytes of the buffer object.
If the requested size is the same as the current size, this method does nothing and returns true. If there is existing memory that is owned by the buffer object, that memory is released. If the requested size is zero, the buffer object is now empty.
size | The requested size in bytes. |
Reimplemented in SoGLBufferObject, and SoGpuBufferObject.
void SoBufferObject::unlockBuffer | ( | ) |
Unlocks the buffer object.
If a thread calls lockBuffer() then it must call unlockBuffer() to allow other threads to lock the buffer.
|
virtual |
Unmaps the buffer from CPU address space.
Reimplemented in SoGLBufferObject, SoCpuBufferBitSet, SoCpuBufferCompressed, SoCpuBufferFromVolumeReader, and SoCpuBufferUniform.
|
virtual |
Unmap this buffer from the specified buffer object.
In other words, remove the specified target buffer from the list of buffers which this buffer is mapped to. If the access mode supports writing, the specified buffer is sync'd with the current buffer. An error is reported (in debug builds) if the buffer is not mapped to the specified buffer
bufferObject | Buffer to be unmapped. |
Reimplemented in SoGLBufferObject, SoCpuBufferBitSet, SoCpuBufferCompressed, SoCpuBufferFromVolumeReader, and SoCpuBufferUniform.
|
friend |
Definition at line 482 of file SoBufferObject.h.