SoGpuBufferObject Class Reference
[CPU device]

GPU buffer object class More...

#include <Inventor/devices/SoGpuBufferObject.h>

Inheritance diagram for SoGpuBufferObject:

Public Member Functions
	SoGpuBufferObject ()
virtual bool	setSize (size_t size)
virtual void *	map (AccessMode accessMode)
virtual void	unmap ()
virtual void	map (SoBufferObject *targetBufferObject, AccessMode accessMode, size_t startPosition=0, size_t mappingSize=SO_BUFFER_SIZE_ALL)
virtual void	unmap (SoBufferObject *bufferObject)
virtual void	memcpy (SoBufferObject *sourceBufferObject, size_t destOffset=0, size_t sourceOffset=0, size_t copySize=SO_BUFFER_SIZE_ALL)
virtual void	memset (void *value, size_t valueSize=1, size_t offset=0, size_t count=SO_BUFFER_SIZE_ALL)
virtual SoBufferObject *	createInstance () const
virtual void	clearInstance ()
virtual void	map (SoCpuBufferObject *targetBufferObject, AccessMode accessMode, size_t startPosition=0, size_t mappingSize=SO_BUFFER_SIZE_ALL)
virtual void	unmap (SoCpuBufferObject *bufferObject)
void	memcpy (SoCpuBufferObject *sourceBufferObject, size_t destOffset=0, size_t sourceOffset=0, size_t copySize=SO_BUFFER_SIZE_ALL)

Detailed Description

GPU buffer object class

This class provides management functions for GPU memory buffers.

See SoBufferObject for general information about buffer objects.

Limitations:

Since Open Inventor 10.0, SoGPUBufferObject does not actually create or access GPU memory. This limitatation will be removed as soon as possible.

Notes:

SoBufferObject classes are reference counted objects (just like nodes, paths, etc).
Therefore you cannot create an SoBufferObject on the stack. And to delete an SoBufferObject you must ref and unref the object. The SoRef smart pointer is a safe and convenient way to create buffer objects. See examples in SoBufferObject.

Constructor & Destructor Documentation

SoGpuBufferObject::SoGpuBufferObject ( )

Default constructor.

The contents of the buffer are initially empty.

Member Function Documentation

virtual void SoGpuBufferObject::clearInstance ( ) [virtual]

This function clears the content of the buffer, it frees the memory if the mode was COPY.

Implements SoBufferObject.

virtual SoBufferObject* SoGpuBufferObject::createInstance ( ) const [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.

virtual void SoGpuBufferObject::map	(	SoCpuBufferObject *	targetBufferObject,
		AccessMode	accessMode,
		size_t	startPosition = `0`,
		size_t	mappingSize = `SO_BUFFER_SIZE_ALL`
	)			`[virtual]`

Maintained for compatibility reasons.

virtual void SoGpuBufferObject::map	(	SoBufferObject *	targetBufferObject,
		AccessMode	accessMode,
		size_t	startPosition = `0`,
		size_t	mappingSize = `SO_BUFFER_SIZE_ALL`
	)			`[virtual]`

Map the current "source" buffer object into the specified "target" 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).

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 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.

virtual void* SoGpuBufferObject::map ( AccessMode accessMode ) [virtual]

Map the buffer to a system memory address.

Returns:: Pointer to the memory managed by the buffer. NULL if empty.

void SoGpuBufferObject::memcpy	(	SoCpuBufferObject *	sourceBufferObject,
		size_t	destOffset = `0`,
		size_t	sourceOffset = `0`,
		size_t	copySize = `SO_BUFFER_SIZE_ALL`
	)

virtual void SoGpuBufferObject::memcpy	(	SoBufferObject *	sourceBufferObject,
		size_t	destOffset = `0`,
		size_t	sourceOffset = `0`,
		size_t	copySize = `SO_BUFFER_SIZE_ALL`
	)			`[virtual]`

Copy 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.

Parameters:

	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).

virtual void SoGpuBufferObject::memset	(	void *	value,
		size_t	valueSize = `1`,
		size_t	offset = `0`,
		size_t	count = `SO_BUFFER_SIZE_ALL`
	)			`[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.

Parameters:

	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

   unsigned char memset_value = 0;
   buffer->memset( &memset_value );

Reimplemented from SoBufferObject.

virtual bool SoGpuBufferObject::setSize ( size_t size ) [virtual]

Sets the size in bytes of the buffer object.

In other words, a request to allocate size bytes of GPU memory. Returns true if the allocation succeeded. The memory is owned by the buffer object and will be freed when the buffer object is destroyed.

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.

Parameters:

size

The size in bytes of the memory to allocate.

Returns:: true if allocation succeeded.

Reimplemented from SoBufferObject.

virtual void SoGpuBufferObject::unmap ( SoCpuBufferObject * bufferObject ) [virtual]

virtual void SoGpuBufferObject::unmap ( SoBufferObject * bufferObject ) [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.

Parameters:

bufferObject

Buffer to be unmapped.

virtual void SoGpuBufferObject::unmap ( ) [virtual]

Unmap a buffer mapped to a system memory address.

No error is reported if the buffer was not mapped.

Reimplemented from SoBufferObject.

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

Inventor/devices/SoGpuBufferObject.h

SoGpuBufferObject Class Reference [CPU device]

Public Member Functions

Detailed Description

SEE ALSO

Constructor & Destructor Documentation

Member Function Documentation

SoGpuBufferObject Class Reference
[CPU device]