SoOpenCLBufferObject Class Reference
[OpenCL device]

OpenCL buffer object managment class More...

#include <Inventor/devices/SoOpenCLBufferObject.h>

Inheritance diagram for SoOpenCLBufferObject:

List of all members.

Public Member Functions
	SoOpenCLBufferObject ()
virtual bool	setSize (size_t size)
virtual void	memcpy (SoBufferObject *sourceBufferObject, size_t destOffset=0, size_t sourceOffset=0, size_t copySize=SO_BUFFER_SIZE_ALL)
virtual void	memcpy (SoCpuBufferObject *sourceBufferObject, size_t destOffset=0, size_t sourceOffset=0, size_t copySize=SO_BUFFER_SIZE_ALL)
virtual void	memcpy (SoOpenCLBufferObject *sourceBufferObject, size_t destOffset=0, size_t sourceOffset=0, size_t copySize=SO_BUFFER_SIZE_ALL)
virtual void	memcpy (SoGLBufferObject *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 void	map (SoBufferObject *targetBufferObject, AccessMode accessMode, size_t startPosition=0, size_t mappingSize=SO_BUFFER_SIZE_ALL)
virtual void	map (SoOpenCLBufferObject *targetBufferObject, AccessMode accessMode, size_t startPosition=0, size_t mappingSize=SO_BUFFER_SIZE_ALL)
virtual void	map (SoCpuBufferObject *targetBufferObject, AccessMode accessMode, size_t startPosition=0, size_t mappingSize=SO_BUFFER_SIZE_ALL)
virtual void	map (SoGLBufferObject *targetBufferObject, AccessMode accessMode, size_t startPosition=0, size_t mappingSize=SO_BUFFER_SIZE_ALL)
virtual void	unmap (SoBufferObject *bufferObject)
virtual void	unmap (SoOpenCLBufferObject *bufferObject)
virtual void	unmap (SoCpuBufferObject *bufferObject)
virtual void	unmap (SoGLBufferObject *bufferObject)
virtual cl_mem	getLocation ()
virtual SoBufferObject *	createInstance () const
virtual void	clearInstance ()

---

Detailed Description

OpenCL buffer object managment class

This class provides management functions for OpenCL memory buffers.

NOTES

• The SoOpenCLContext used for this buffer is the one active when the constructor is called.
• Most of the functions don't actually care about the context.

---

Constructor & Destructor Documentation

SoOpenCLBufferObject::SoOpenCLBufferObject

(

)

Default constructor.


The SoOpenCLContext used for this buffer is the one active when the constructor is called.

---

Member Function Documentation

virtual void SoOpenCLBufferObject::clearInstance

(

)

[virtual]

Free the memory allocated by the buffer object.

Implements SoBufferObject.

virtual SoBufferObject* SoOpenCLBufferObject::createInstance

(

)

const [virtual]

Creates 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 cl_mem SoOpenCLBufferObject::getLocation

(

)

[virtual]

Returns a OpenCL pointer for this buffer object.


Be careful, the returned pointer is only valid in a OpenCL device function.

Returns:

OpenCL pointer of this buffer.

virtual void SoOpenCLBufferObject::map	(	SoGLBufferObject *	targetBufferObject,
		AccessMode	accessMode,
		size_t	startPosition = 0,
		size_t	mappingSize = SO_BUFFER_SIZE_ALL
	)			[virtual]

Map the buffer object to a GL buffer object.


It is defined just to speed up the call when the type of the object is known.


See the general map function for more information.

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

Map the buffer object to a CPU buffer object.


It is defined just to speed up the call when the type of the object is known.


See the general map function for more information.

Implements SoBufferObject.

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

Map the buffer object to a OpenCL buffer object.


It is defined just to speed up the call when the type of the object is known.


See the general map function for more information.

Implements SoBufferObject.

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

Map the buffer object to any buffer object.


It can be called from any context, the function binds the correct context when it's called!

If the target buffer is another OpenCL buffer object, the map function copies the data according to the context. It does a copy of the source buffer in a temp buffer if the two buffers don't use the same OpenCL context.

Parameters:

	targetBufferObject	The target buffer object which receives the mapping from the OpenCL buffer.
	accessMode	The access mode used for the mapping.
	startPosition	Offset in source buffer to map from.
	mappingSize	Number of bytes to map, if SO_BUFFER_SIZE_ALL then the whole buffer is mapped.

virtual void SoOpenCLBufferObject::memcpy	(	SoGLBufferObject *	sourceBufferObject,
		size_t	destOffset = 0,
		size_t	sourceOffset = 0,
		size_t	copySize = SO_BUFFER_SIZE_ALL
	)			[virtual]

Copy data from the specified GL buffer object into this buffer object.




This is an optimized implementation. See the general memcpy method for more information.

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

Copy data from a OpenCL buffer into this OpenCL buffer.

Warning:

: Source and destination overlaping is NOT supported.

This function is a specialized function for speed-up.
See the regular memcpy function for more information

Implements SoBufferObject.

virtual void SoOpenCLBufferObject::memcpy	(	SoCpuBufferObject *	sourceBufferObject,
		size_t	destOffset = 0,
		size_t	sourceOffset = 0,
		size_t	copySize = SO_BUFFER_SIZE_ALL
	)			[virtual]

Copy data from a CPU buffer into the OpenCL buffer.

This function is a specialized function for speed-up.
See the regular memcpy function for more information

Implements SoBufferObject.

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

Copy data from any SoBufferObject into the OpenCL memory.

Parameters:

	sourceBufferObject	The source buffer object which contains the data to copy.
	destOffset	The starting offset in the source buffer.
	sourceOffset	The starting offset in the source buffer.
	copySize	The size in bytes of the chunk of data to copy.

Warning:

: Source and destination overlaping is NOT supported.

NOTES

• Ensure that the context which was used when the constructor was called is currently bound before calling this function.