|
Open Inventor Release 2024.1.1
|
|
| |
|
Open Inventor Release 2024.1.1
|
|
|
| |
Abstract base class for interoperability buffer object management
More...
#include <Inventor/devices/SoInteropBufferObject.h>
Inheritance diagram for SoInteropBufferObject:Public Member Functions | |
| SoInteropBufferObject () | |
| Default constructor. | |
| 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. | |
| Public Member Functions inherited from SoBufferObject | |
| 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. | |
| 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. | |
Additional Inherited Members | |
| Public Types inherited from SoBufferObject | |
| enum | AccessMode { READ_ONLY , SET , READ_WRITE } |
| This enum provides the possible access modes for a mapped buffer object. More... | |
| Static Public Member Functions inherited from SoTypedObject | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| Related Symbols inherited from SoBufferObject | |
| #define | SO_BUFFER_SIZE_ALL ((std::numeric_limits<size_t>::max)()) |
| Used to indicate that we want to use the whole buffer. | |
Abstract base class for interoperability buffer object management
This class provides generic functions to manage buffer objects for interoperability.
Definition at line 38 of file SoInteropBufferObject.h.
| SoInteropBufferObject::SoInteropBufferObject | ( | ) |
Default constructor.
|
pure virtual |
Free the memory allocated by the buffer object.
Implements SoBufferObject.
Implemented in SoGLBufferObject.
|
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.
Implements SoBufferObject.
Implemented in SoGLBufferObject.
1.9.8 