Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
SoCpuBufferUniform Class Reference

Large Data Management LDM buffer object optimized for uniform (single value) tile data. More...

#include <LDM/tiles/SoCpuBufferUniform.h>

+ Inheritance diagram for SoCpuBufferUniform:

Public Member Functions

 SoCpuBufferUniform ()
 Default constructor.
 
 SoCpuBufferUniform (const double value, SbDataType valueType)
 Constructor.
 
virtual void map (SoBufferObject *targetBufferObject, SoBufferObject::AccessMode accessMode, size_t startPosition=0, size_t mappingSize=SO_BUFFER_SIZE_ALL)
 Map the current buffer object into the specified buffer object.
 
virtual void map (SoCpuBufferObject *targetBufferObject, SoBufferObject::AccessMode accessMode, size_t startPosition=0, size_t mappingSize=SO_BUFFER_SIZE_ALL)
 Map the current buffer object into the specified CPU buffer object.
 
virtual void map (SoGLBufferObject *targetBufferObject, SoBufferObject::AccessMode accessMode, size_t startPosition=0, size_t mappingSize=SO_BUFFER_SIZE_ALL)
 Map the current buffer object into the specified GL buffer object.
 
virtual void unmap (SoCpuBufferObject *bufferObject)
 Unmap the specified CPU buffer object
It is defined just to speed up the call when the type of the object is known.
 
virtual void unmap (SoGLBufferObject *bufferObject)
 Unmap the specified GL buffer object
It is defined just to speed up the call when the type of the object is known.
 
virtual void unmap (SoBufferObject *bufferObject)
 Remove the specified bufferObject from the list of buffers which map the current buffer.
 
virtual void * map (SoBufferObject::AccessMode accessMode, size_t offset=0, size_t count=SO_BUFFER_SIZE_ALL)
 Returns a pointer to the memory array used for the storage of the buffer.
 
virtual void unmap ()
 Unmap a mapped buffer.
 
virtual void memset (void *data, size_t dataSize=1, size_t offset=0, size_t count=SO_BUFFER_SIZE_ALL)
 This function sets the contents of (or a portion of) the buffer object to the specified value.
 
virtual void memcpy (SoBufferObject *sourceBufferObject, size_t destOffset, size_t sourceOffset, size_t copySize)
 Memcpy the contents of sourceBufferObject into this buffer object.
 
virtual bool getMinMax (double &min, double &max)
 Get the min and max values in the buffer, if they are known.
 
virtual double getValue () const
 Get the value of the uniform tile.
 
virtual SbDataType getType () const
 Get the type of the value of the uniform tile.
 
void setValue (const double &value, const SbDataType &dataType)
 Set the value and data type for this uniform buffer.
 
virtual size_t getRealSize () const
 Returns the real size of the buffer in bytes.
 
virtual void setRealSize (const size_t &realSize)
 Set the real size of the buffer object in bytes.
 
- Public Member Functions inherited from SoCpuBufferObject
 SoCpuBufferObject ()
 Default constructor.
 
 SoCpuBufferObject (void *buffer, size_t size)
 Constructor that takes an existing block of CPU memory.
 
void setBuffer (void *buffer, size_t size)
 Request that the buffer object manage an existing block of memory.
 
virtual SoBufferObjectcreateInstance () const
 Create a new buffer with the same properties as the current one.
 
virtual void clearInstance ()
 This function clears the content of the buffer, it frees the memory if the mode was COPY.
 
- 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.
 
SoDeviceContextgetContext () const
 Returns the device context where this buffer is valid.
 
SoBufferObjectgetMappedBufferObject () 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.
 
- Public Member Functions inherited from SoBufferPropertiesInterface
 SoBufferPropertiesInterface ()
 Default constructor.
 
virtual ~SoBufferPropertiesInterface ()
 Destructor.
 
- Public Member Functions inherited from SoLDMBufferObjectInterface
 SoLDMBufferObjectInterface ()
 Default constructor.
 
virtual ~SoLDMBufferObjectInterface ()
 Destructor.
 
virtual void prefetch ()
 Simply expand the given buffer to OIV cache.
 

Friends

class SoCpuBufferUniformImpl
 

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.
 

Detailed Description

Large Data Management LDM buffer object optimized for uniform (single value) tile data.

This type of buffer efficiently represents a uniform tile, in other words a tile in which every value is the same. The buffer can be used like any other buffer, but uses very little memory when its contents are not actually being accessed.

SEE ALSO

SoBufferPropertiesInterface, SoCpuBufferObject

Definition at line 49 of file SoCpuBufferUniform.h.

Constructor & Destructor Documentation

◆ SoCpuBufferUniform() [1/2]

SoCpuBufferUniform::SoCpuBufferUniform ( )

Default constructor.

◆ SoCpuBufferUniform() [2/2]

SoCpuBufferUniform::SoCpuBufferUniform ( const double  value,
SbDataType  valueType 
)

Constructor.

Parameters
valueInitial value of uniform buffer.
valueTypeInitial value type of uniform buffer.

Member Function Documentation

◆ getMinMax()

virtual bool SoCpuBufferUniform::getMinMax ( double &  min,
double &  max 
)
virtual

Get the min and max values in the buffer, if they are known.


Returns false if these values have not been set or computed. Returns true if values are available.

Parameters
minuser variable to store min value
maxuser variable to store max value

Implements SoBufferPropertiesInterface.

◆ getRealSize()

virtual size_t SoCpuBufferUniform::getRealSize ( ) const
virtual

Returns the real size of the buffer in bytes.

Implements SoBufferPropertiesInterface.

◆ getType()

virtual SbDataType SoCpuBufferUniform::getType ( ) const
virtual

Get the type of the value of the uniform tile.

◆ getValue()

virtual double SoCpuBufferUniform::getValue ( ) const
virtual

Get the value of the uniform tile.

◆ map() [1/4]

virtual void SoCpuBufferUniform::map ( SoBufferObject targetBufferObject,
SoBufferObject::AccessMode  accessMode,
size_t  startPosition = 0,
size_t  mappingSize = SO_BUFFER_SIZE_ALL 
)
virtual

Map the current buffer object into the specified buffer object.


It is useful in order to use a buffer in multiple contexts.

Parameters
targetBufferObjectThe buffer object which will be the mapped version of this buffer.
accessModeThe access mode used for the mapping. Support only READ_ONLY mode
startPositionoffset in source buffer to map from (default is start of buffer).
mappingSizesize from the startPosition, if SO_BUFFER_SIZE_ALL then the whole buffer is mapped.

Reimplemented from SoBufferObject.

◆ map() [2/4]

virtual void * SoCpuBufferUniform::map ( SoBufferObject::AccessMode  accessMode,
size_t  offset = 0,
size_t  count = SO_BUFFER_SIZE_ALL 
)
virtual

Returns a pointer to the memory array used for the storage of the buffer.

Returns
Pointer to the memory array used for the storage.

Reimplemented from SoBufferObject.

◆ map() [3/4]

virtual void SoCpuBufferUniform::map ( SoCpuBufferObject targetBufferObject,
SoBufferObject::AccessMode  accessMode,
size_t  startPosition = 0,
size_t  mappingSize = SO_BUFFER_SIZE_ALL 
)
virtual

Map the current buffer object into the specified CPU buffer object.


See the general map method for more information.

◆ map() [4/4]

virtual void SoCpuBufferUniform::map ( SoGLBufferObject targetBufferObject,
SoBufferObject::AccessMode  accessMode,
size_t  startPosition = 0,
size_t  mappingSize = SO_BUFFER_SIZE_ALL 
)
virtual

Map the current buffer object into the specified GL buffer object.


See the general map method for more information.

◆ memcpy()

virtual void SoCpuBufferUniform::memcpy ( SoBufferObject sourceBufferObject,
size_t  destOffset,
size_t  sourceOffset,
size_t  copySize 
)
virtual

Memcpy the contents of sourceBufferObject into this buffer object.

Warning
Only copying the whole content of a UniformBufferObject to another UniformBufferObject is supported.

Reimplemented from SoBufferObject.

◆ memset()

virtual void SoCpuBufferUniform::memset ( void *  data,
size_t  dataSize = 1,
size_t  offset = 0,
size_t  count = SO_BUFFER_SIZE_ALL 
)
virtual

This function sets the contents of (or a portion of) the buffer object to the specified value.

The dataSize parameter provides a way to do a memset with float, short, byte, etc values.

Parameters
dataA pointer to the value to set in the buffer.
dataSizeThe size in bytes of the data value. Default is 1 byte.
offsetThe offset in bytes (where to start setting values). Default is 0.
countThe number of values to set. Default is number of bytes in buffer.

Reimplemented from SoBufferObject.

◆ setRealSize()

virtual void SoCpuBufferUniform::setRealSize ( const size_t &  realSize)
virtual

Set the real size of the buffer object in bytes.

◆ setValue()

void SoCpuBufferUniform::setValue ( const double &  value,
const SbDataType dataType 
)

Set the value and data type for this uniform buffer.

◆ unmap() [1/4]

virtual void SoCpuBufferUniform::unmap ( )
virtual

Unmap a mapped buffer.

No error is reported if the buffer was not mapped.

Reimplemented from SoBufferObject.

◆ unmap() [2/4]

virtual void SoCpuBufferUniform::unmap ( SoBufferObject bufferObject)
virtual

Remove the specified bufferObject from the list of buffers which map the current buffer.

If the access mode supports writing the specified buffer is sync'd with the buffer.

Parameters
bufferObjectBuffer to be unmapped.

Reimplemented from SoBufferObject.

◆ unmap() [3/4]

virtual void SoCpuBufferUniform::unmap ( SoCpuBufferObject bufferObject)
virtual

Unmap the specified CPU buffer object
It is defined just to speed up the call when the type of the object is known.


Remove the specified bufferObject from the list of buffers which map the current buffer.

See the general unmap function for more information.

◆ unmap() [4/4]

virtual void SoCpuBufferUniform::unmap ( SoGLBufferObject bufferObject)
virtual

Unmap the specified GL buffer object
It is defined just to speed up the call when the type of the object is known.


If the access mode supports writing the specified buffer is sync'd with the buffer.

See the general unmap function for more information.

Parameters
bufferObjectBuffer to be unmapped.

Friends And Related Symbol Documentation

◆ SoCpuBufferUniformImpl

friend class SoCpuBufferUniformImpl
friend

Definition at line 209 of file SoCpuBufferUniform.h.


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