LDM buffer object optimized for compressed tile data. More...

#include <LDM/tiles/SoCpuBufferCompressed.h>

Inheritance diagram for SoCpuBufferCompressed:

Public Member Functions
	SoCpuBufferCompressed ()
	Default constructor.

	SoCpuBufferCompressed (SoDataCompressor *compressor)
	Constructor with compressor given as parameter.

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 *	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 (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	unmap ()
	Unmap a mapped buffer.

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.

size_t	getRealSize () const
	Returns the size of the uncompressed data in bytes.

virtual void	setCompressor (SoDataCompressor *compressor)
	Set the compressor used to decompress buffer.

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	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 SoLDMBufferObjectInterface
	SoLDMBufferObjectInterface ()
	Default constructor.

virtual	~SoLDMBufferObjectInterface ()
	Destructor.

virtual void	prefetch ()
	Simply expand the given buffer to OIV cache.

Friends
class	SoCpuBufferCompressedImpl

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 optimized for compressed tile data.

This type of buffer efficiently represents a tile containing compressed data (usually read from a compressed LDM file). The buffer can be used like any other buffer, but uses much less memory when its contents are not actually being accessed.

Constructor & Destructor Documentation

◆ SoCpuBufferCompressed() [1/2]

SoCpuBufferCompressed::SoCpuBufferCompressed ( )

Default constructor.

◆ SoCpuBufferCompressed() [2/2]

SoCpuBufferCompressed::SoCpuBufferCompressed ( SoDataCompressor * compressor )

Constructor with compressor given as parameter.

Member Function Documentation

◆ getMinMax()

virtual bool SoCpuBufferCompressed::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

min	user variable to store min value
max	user variable to store max value

Implements SoBufferPropertiesInterface.

◆ getRealSize()

size_t SoCpuBufferCompressed::getRealSize ( ) const

virtual

Returns the size of the uncompressed data in bytes.

Implements SoBufferPropertiesInterface.

◆ map() [1/4]

virtual void SoCpuBufferCompressed::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

targetBufferObject	The buffer object which will be the mapped version of this buffer.
accessMode	The access mode used for the mapping.
startPosition	offset in source buffer to map from (default is start of buffer).
mappingSize	size from the startPosition, if SO_BUFFER_SIZE_ALL then the whole buffer is mapped.

Reimplemented from SoBufferObject.

◆ map() [2/4]

virtual void * SoCpuBufferCompressed::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 SoCpuBufferCompressed::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 SoCpuBufferCompressed::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.

◆ setCompressor()

virtual void SoCpuBufferCompressed::setCompressor ( SoDataCompressor * compressor )

virtual

Set the compressor used to decompress buffer.

Parameters

compressor Pointer to the compressor to use

◆ setMinMax()

virtual void SoCpuBufferCompressed::setMinMax	(	const double &	min,
		const double &	max
	)

virtual

Set the min and max values for this buffer.

Parameters

min	user variable containing min value
max	user variable containing max value

◆ unmap() [1/4]

virtual void SoCpuBufferCompressed::unmap ( )

virtual

Unmap a mapped buffer.

No error is reported if the buffer was not mapped.

Reimplemented from SoBufferObject.

◆ unmap() [2/4]

virtual void SoCpuBufferCompressed::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

bufferObject Buffer to be unmapped.

Reimplemented from SoBufferObject.

◆ unmap() [3/4]

virtual void SoCpuBufferCompressed::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 SoCpuBufferCompressed::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

bufferObject Buffer to be unmapped.

Friends And Related Symbol Documentation

◆ SoCpuBufferCompressedImpl

friend class SoCpuBufferCompressedImpl

friend

Definition at line 182 of file SoCpuBufferCompressed.h.

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

LDM/tiles/SoCpuBufferCompressed.h

Open Inventor Release 2024.2.0

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

SEE ALSO

Constructor & Destructor Documentation

◆ SoCpuBufferCompressed() [1/2]

◆ SoCpuBufferCompressed() [2/2]

Member Function Documentation

◆ getMinMax()

◆ getRealSize()

◆ map() [1/4]

◆ map() [2/4]

◆ map() [3/4]

◆ map() [4/4]

◆ setCompressor()

◆ setMinMax()

◆ unmap() [1/4]

◆ unmap() [2/4]

◆ unmap() [3/4]

◆ unmap() [4/4]

Friends And Related Symbol Documentation

◆ SoCpuBufferCompressedImpl