SoOpenCLBufferObject Class

OpenCL buffer object managment class.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.DevicesSoBufferObject
        OIV.Inventor.DevicesSoOpenCLBufferObject

Namespace: OIV.Inventor.Devices
Assembly: OIV.Inventor.OpenCL (in OIV.Inventor.OpenCL.dll) Version: 9.9.13.0 (9.9.13.0)

Syntax

C++

Copy

public class SoOpenCLBufferObject : SoBufferObject

Public Class SoOpenCLBufferObject
	Inherits SoBufferObject

public ref class SoOpenCLBufferObject : public SoBufferObject

type SoOpenCLBufferObject =  
    class
        inherit SoBufferObject
    end

The SoOpenCLBufferObject type exposes the following members.

Constructors

	Name	Description
	SoOpenCLBufferObject	Default constructor.

Top

Methods

	Name	Description
	ClearInstance	Free the memory allocated by the buffer object. (Overrides SoBufferObjectClearInstance.)
	CreateInstance	Creates a new buffer with the same properties as the current one. (Overrides SoBufferObjectCreateInstance.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FillT	Convenient method to fill an SoBufferObject with a default value. (Inherited from SoBufferObject.)
	GetContext	Returns the device context where this buffer is valid. (Inherited from SoBufferObject.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetLongMappingSize	Obsolete. Returns the size of the mapped area in bytes. (Inherited from SoBufferObject.)
	GetLongMappingStartPosition	Obsolete. Returns the position in the source buffer mapped in this buffer. (Inherited from SoBufferObject.)
	GetLongSize	Obsolete. Returns the size, in bytes, of the buffer object. (Inherited from SoBufferObject.)
	GetMappedBufferObject	Returns a pointer to the buffer object which is mapped by the actual object. (Inherited from SoBufferObject.)
	GetMappingAccessMode	Returns the access mode used for the buffer mapping. (Inherited from SoBufferObject.)
	GetMappingSize	Returns the size of the mapped area in bytes. (Inherited from SoBufferObject.)
	GetMappingStartPosition	Returns the position in the source buffer mapped in this buffer. (Inherited from SoBufferObject.)
	GetSize	Returns the size, in bytes, of the buffer object. (Inherited from SoBufferObject.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	LockBuffer	Locks the buffer against concurrent calls from different threads. (Inherited from SoBufferObject.)
	Map(SoBufferObject, SoBufferObjectAccessModes)	Calls Map(targetBufferObject, accessMode, System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Map(SoCpuBufferObject, SoBufferObjectAccessModes)	Calls Map(targetBufferObject, accessMode, System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Map(SoGLBufferObject, SoBufferObjectAccessModes)	Calls Map(targetBufferObject, accessMode, System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Map(SoOpenCLBufferObject, SoBufferObjectAccessModes)	Calls Map(targetBufferObject, accessMode, System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Map(SoBufferObject, SoBufferObjectAccessModes, UInt64)	Calls Map(targetBufferObject, accessMode, startPosition, System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Map(SoCpuBufferObject, SoBufferObjectAccessModes, UInt64)	Calls Map(targetBufferObject, accessMode, startPosition, System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Map(SoGLBufferObject, SoBufferObjectAccessModes, UInt64)	Calls Map(targetBufferObject, accessMode, startPosition, System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Map(SoOpenCLBufferObject, SoBufferObjectAccessModes, UInt64)	Calls Map(targetBufferObject, accessMode, startPosition, System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Map(SoBufferObject, SoBufferObjectAccessModes, UInt64, UInt64)	Map the buffer object to any buffer object. (Overrides SoBufferObjectMap(SoBufferObject, SoBufferObjectAccessModes, UInt64, UInt64).)
	Map(SoCpuBufferObject, SoBufferObjectAccessModes, UInt64, UInt64)	Map the buffer object to a CPU buffer object. (Overrides SoBufferObjectMap(SoCpuBufferObject, SoBufferObjectAccessModes, UInt64, UInt64).)
	Map(SoGLBufferObject, SoBufferObjectAccessModes, UInt64, UInt64)	Map the buffer object to a GL buffer object.
	Map(SoOpenCLBufferObject, SoBufferObjectAccessModes, UInt64, UInt64)	Map the buffer object to a OpenCL buffer object.
	Memcpy(SoBufferObject)	Calls Memcpy(sourceBufferObject, System.UInt64(0), System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Memcpy(SoCpuBufferObject)	Calls Memcpy(sourceBufferObject, System.UInt64(0), System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Memcpy(SoGLBufferObject)	Calls Memcpy(sourceBufferObject, System.UInt64(0), System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Memcpy(SoOpenCLBufferObject)	Calls Memcpy(sourceBufferObject, System.UInt64(0), System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Memcpy(SoBufferObject, UInt64)	Calls Memcpy(sourceBufferObject, destOffset, System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Memcpy(SoCpuBufferObject, UInt64)	Calls Memcpy(sourceBufferObject, destOffset, System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Memcpy(SoGLBufferObject, UInt64)	Calls Memcpy(sourceBufferObject, destOffset, System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Memcpy(SoOpenCLBufferObject, UInt64)	Calls Memcpy(sourceBufferObject, destOffset, System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Memcpy(SoBufferObject, UInt64, UInt64)	Calls Memcpy(sourceBufferObject, destOffset, sourceOffset, System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Memcpy(SoCpuBufferObject, UInt64, UInt64)	Calls Memcpy(sourceBufferObject, destOffset, sourceOffset, System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Memcpy(SoGLBufferObject, UInt64, UInt64)	Calls Memcpy(sourceBufferObject, destOffset, sourceOffset, System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Memcpy(SoOpenCLBufferObject, UInt64, UInt64)	Calls Memcpy(sourceBufferObject, destOffset, sourceOffset, System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Memcpy(SoBufferObject, UInt64, UInt64, UInt64)	Copy data from any SoBufferObject into the OpenCL memory. (Overrides SoBufferObjectMemcpy(SoBufferObject, UInt64, UInt64, UInt64).)
	Memcpy(SoCpuBufferObject, UInt64, UInt64, UInt64)	Copy data from a CPU buffer into the OpenCL buffer. (Overrides SoBufferObjectMemcpy(SoCpuBufferObject, UInt64, UInt64, UInt64).)
	Memcpy(SoGLBufferObject, UInt64, UInt64, UInt64)	Copy data from the specified GL buffer object into this buffer object.
	Memcpy(SoOpenCLBufferObject, UInt64, UInt64, UInt64)	Copy data from a OpenCL buffer into this OpenCL buffer.
	Memset(IntPtr)	Calls Memset(value, System.Convert.ToUInt64(1), System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Memset(IntPtr, UInt64)	Calls Memset(value, valueSize, System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Memset(IntPtr, UInt64, UInt64)	Calls Memset(value, valueSize, offset, System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Memset(IntPtr, UInt64, UInt64, UInt64)	This function sets the contents of (or a portion of) this buffer object to the specified value. (Overrides SoBufferObjectMemset(IntPtr, UInt64, UInt64, UInt64).)
	SetMappedBufferObject	This function is used when the instance of buffer object is used to map a buffer. (Inherited from SoBufferObject.)
	SetMappingAccessMode	Sets the mapping mode used for the mapping of a buffer object. (Inherited from SoBufferObject.)
	SetMappingZoneInformation	Stores information about the mapping in order to know the subset of the data mapped in the buffer. (Inherited from SoBufferObject.)
	SetSize	Sets the size in bytes of the buffer. (Overrides SoBufferObjectSetSize(UInt64).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnlockBuffer	Unlocks the buffer object. (Inherited from SoBufferObject.)
	Unmap(SoBufferObject)	Unmap the specified buffer object. (Overrides SoBufferObjectUnmap(SoBufferObject).)
	Unmap(SoCpuBufferObject)	Unmap the specified CPU buffer object. (Overrides SoBufferObjectUnmap(SoCpuBufferObject).)
	Unmap(SoGLBufferObject)	Unmap the specified GL buffer object.
	Unmap(SoOpenCLBufferObject)	Unmap the specified OpenCL buffer object.

Top

Properties

	Name	Description
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)

Top

Remarks

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.

Reference

OIV.Inventor.Devices Namespace