| SoCpuBufferObject Class |
CPU buffer object class.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.DevicesSoBufferObject
OIV.Inventor.DevicesSoCpuBufferObject
OIV.LDM.TilesSoCpuBufferBasicProperty
OIV.LDM.TilesSoCpuBufferBitSet
OIV.LDM.TilesSoCpuBufferCompressed
OIV.LDM.TilesSoCpuBufferFromVolumeReader
OIV.LDM.TilesSoCpuBufferUniform
Namespace: OIV.Inventor.Devices
Assembly: OIV.Inventor.Base (in OIV.Inventor.Base.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoCpuBufferObject type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoCpuBufferObject | Default constructor. |
| SoCpuBufferObject(SbNativeArrayByte) |
Constructor that takes an existing block of CPU memory.
|
Methods| Name | Description | |
|---|---|---|
| ClearInstance | This function clears the content of the buffer, it frees the memory if the mode was COPY. |
| CreateInstance | Create a new buffer with the same properties as the current one. |
 | CreateInstanceT(T) |
Factory method to create an instance of SoCpuBufferObject from
an arbitrary managed array of value type.
|
| CreateInstanceT(SbNativeArrayT) |
Factory method to create an instance of SoCpuBufferObject from
an arbitrary SbNativeArrayT.
|
| CreateInstanceT(T, Int32) |
Factory method to create an instance of SoCpuBufferObject from
an arbitrary managed array of value type.
|
| 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. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMappedBufferObject | Returns a pointer to the buffer object which is mapped by the actual object. |
| GetMappedBufferObjectAccessMode | Returns the access mode used for the buffer mapping. |
| GetMappedBufferObjectPosition | Returns the position in the source buffer mapped in this buffer. |
| GetMappedBufferObjectSize | Returns the size of the mapped area in bytes. |
| GetSize | Returns the size, in bytes, of the buffer object. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| LockBuffer | Locks the buffer against concurrent calls from different threads. |
| Map(SoBufferObjectAccessModes) | Calls Map(accessMode, System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)). (Inherited from SoBufferObject.) |
| Map(SoBufferObject, SoBufferObjectAccessModes) | Calls Map(targetBufferObject, accessMode, System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)). (Inherited from SoBufferObject.) |
| Map(SoBufferObjectAccessModes, UInt64) | Calls Map(accessMode, offset, System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)). (Inherited from SoBufferObject.) |
| Map(SoBufferObject, SoBufferObjectAccessModes, UInt64) | Calls Map(targetBufferObject, accessMode, startPosition, System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)). (Inherited from SoBufferObject.) |
| Map(SoBufferObjectAccessModes, UInt64, UInt64) | Map the buffer to a system memory address and allows the mapping of a sub part of the buffer object into CPU memory. |
| Map(SoBufferObject, SoBufferObjectAccessModes, UInt64, UInt64) | Maps the current buffer object into the specified buffer object. |
| Memcpy(SoBufferObject) | Calls Memcpy(sourceBufferObject, System.UInt64(0), System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)). (Inherited from SoBufferObject.) |
| Memcpy(SoBufferObject, UInt64) | Calls Memcpy(sourceBufferObject, destOffset, System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)). (Inherited from SoBufferObject.) |
| Memcpy(SoBufferObject, UInt64, UInt64) | Calls Memcpy(sourceBufferObject, destOffset, sourceOffset, System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)). (Inherited from SoBufferObject.) |
| Memcpy(SoBufferObject, UInt64, UInt64, UInt64) | Copies data from the specified buffer object into this buffer object. |
| Memset(IntPtr) | Calls Memset(value, System.Convert.ToUInt64(1), System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)). (Inherited from SoBufferObject.) |
| Memset(IntPtr, UInt64) | Calls Memset(value, valueSize, System.UInt64(0), System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)). (Inherited from SoBufferObject.) |
| Memset(IntPtr, UInt64, UInt64) | Calls Memset(value, valueSize, offset, System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)). (Inherited from SoBufferObject.) |
| Memset(IntPtr, UInt64, UInt64, UInt64) | This function sets the contents of (or a portion of) this buffer object to the specified value. |
| SetSize | Sets the size in bytes of the buffer object. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UnlockBuffer | Unlocks the buffer object. |
| Unmap | Unmaps the buffer from CPU address space. |
| Unmap(SoBufferObject) | Unmap this buffer from the specified buffer object. |
Properties| Name | Description | |
|---|---|---|
 | Buffer | Request that the buffer object manage an existing block of memory. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
RemarksThis class provides management functions for CPU memory buffers.
By default memory allocations have the maximum possible alignment to allow use with (for example) SSE instructions.
Memory is managed using the new/delete operators. On Microsoft Windows platforms it is possible to use VirtualAlloc/VirtualFree instead by setting OIV_BUFFER_USE_VIRTUAL_ALLOC (see OIV.Inventor.SoPreferences).
See OIV.Inventor.Devices.SoBufferObject for general information about buffer objects.
See OIV.Inventor.Nodes.SoBufferedShape for an example of storing vertices in a CPU buffer.
EXAMPLE
Load data into a buffer object from an array in memory:
float[] vertices = new float[9 * 3] { 1.0f, 0.5f,0.0f, 0.0f, 1.0f,0.0f, -1.0f,0.5f,0.0f, -1.0f,-1.0f,0.0f, 1.0f,-1.0f,0.0f, 1.0f,0.0f,0.0f, -1.0f,0.0f,0.0f, -1.0f,-1.5f,0.0f, 1.0f,-1.5f,0.0f }; SbNativeArray<float> vertArray = new SbNativeArray<float>(vertices); SoCpuBufferObject vertBuf = new SoCpuBufferObject( (SbNativeArray<byte>)vertArray );
EXAMPLE
Access data stored in a buffer object.
SbNativeArray<byte> data = (SbNativeArray<byte>)cpuBuffer.Map( SoBufferObject.AccessModes.READ_ONLY ); byte value = data[0]; . . . cpuBuffer.Unmap();
See Also