LDM buffer object handling basic LDM tile information and implementing asynchronous buffer interface. More...

#include <LDM/tiles/SoCpuBufferAsyncBasicProperty.h>

Inheritance diagram for SoCpuBufferAsyncBasicProperty:

Public Member Functions
	SoCpuBufferAsyncBasicProperty ()
	Default constructor.

virtual bool	isInMemory ()
	Return TRUE if the data attached to this buffer are not currently available.

virtual void	requestRefetch (SoBufferAsyncNotifierInterface *asyncNotifier, const double weight)
	Ask to initiate an ansynchronous load of the data if not already in memory.

Public Member Functions inherited from SoCpuBufferBasicProperty
	SoCpuBufferBasicProperty ()
	Default constructor.

virtual bool	getMinMax (double &min, double &max)
	Get the min and max values in the buffer, if they are known.

virtual void	setMinMax (const double &min, const double &max)
	Set the min and max values for this buffer.

virtual size_t	getRealSize () const
	Returns the size of the buffer 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 SoBufferObject *	createInstance () 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.

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.

Public Member Functions inherited from SoBufferPropertiesInterface
	SoBufferPropertiesInterface ()
	Default constructor.

virtual	~SoBufferPropertiesInterface ()
	Destructor.

Public Member Functions inherited from SoBufferAsyncInterface
virtual	~SoBufferAsyncInterface ()
	Destructor.

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.

Detailed Description

LDM buffer object handling basic LDM tile information and implementing asynchronous buffer interface.

This type of buffer represents a standard LDM tile.

Constructor & Destructor Documentation

◆ SoCpuBufferAsyncBasicProperty()

SoCpuBufferAsyncBasicProperty::SoCpuBufferAsyncBasicProperty ( )

Default constructor.

Member Function Documentation

◆ isInMemory()

virtual bool SoCpuBufferAsyncBasicProperty::isInMemory ( )

inlinevirtual

Return TRUE if the data attached to this buffer are not currently available.

Implements SoBufferAsyncInterface.

Definition at line 54 of file SoCpuBufferAsyncBasicProperty.h.

◆ requestRefetch()

virtual void SoCpuBufferAsyncBasicProperty::requestRefetch	(	SoBufferAsyncNotifierInterface *	asyncNotifier,
		const double	weight
	)

virtual

Ask to initiate an ansynchronous load of the data if not already in memory.

Application must call asyncNotifier->resourceChangeNotify() In order to let LDM for example know that some new data are available.

Implements SoBufferAsyncInterface.

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

LDM/tiles/SoCpuBufferAsyncBasicProperty.h

Open Inventor Release 2024.1.1

Public Member Functions

Additional Inherited Members