SoGLBufferObject Class

OpenGL buffer object class.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.DevicesSoBufferObject
        OIV.Inventor.DevicesSoGLBufferObject

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

Syntax

C++

Copy

public class SoGLBufferObject : SoBufferObject

Public Class SoGLBufferObject
	Inherits SoBufferObject

public ref class SoGLBufferObject : public SoBufferObject

type SoGLBufferObject =  
    class
        inherit SoBufferObject
    end

The SoGLBufferObject type exposes the following members.

Constructors

	Name	Description
	SoGLBufferObject	Constructor.

Top

Methods

	Name	Description
	Bind	Bind the current buffer to the specified target so it's usable by OpenGL operations.
	ClearInstance	Free the memory allocated in the buffer object. (Overrides SoBufferObjectClearInstance.)
	CreateInstance	Create 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.)
	GetId	Returns the OpenGL id of the buffer.
	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.)
	GetTarget	Returns the current buffer target.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsAvailable	Query if SoGLBufferObjects are available on this system.
	IsValid	Query if the buffer is valid in the current context.
	LockBuffer	Locks the buffer against concurrent calls from different threads. (Inherited from SoBufferObject.)
	Map(SoBufferObjectAccessModes)	This function maps the OpenGL buffer memory into CPU memory.
	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(SoBufferObject, SoBufferObjectAccessModes, UInt64)	Calls Map(targetBufferObject, accessMode, startPosition, System.Convert.ToUInt64(SO_BUFFER_SIZE_ALL)).
	Map(SoBufferObjectAccessModes, UInt64, UInt64)	This function extends the map(AccessMode) method by allowing the mapping of a sub part of the buffer object into CPU memory.
	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(SoBufferObject, SoBufferObjectAccessModes, UInt64, UInt64)	Map the current buffer object into the specified buffer object. (Overrides SoBufferObjectMap(SoBufferObject, SoBufferObjectAccessModes, UInt64, UInt64).)
	Map(SoCpuBufferObject, SoBufferObjectAccessModes, UInt64, UInt64)	Map the current buffer object into the specified CPU buffer object. (Overrides SoBufferObjectMap(SoCpuBufferObject, SoBufferObjectAccessModes, UInt64, UInt64).)
	Map(SoGLBufferObject, SoBufferObjectAccessModes, UInt64, UInt64)	Map the current buffer object into the specified GL 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(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(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(SoBufferObject, UInt64, UInt64, UInt64)	Copy data from any SoBufferObject into this buffer. (Overrides SoBufferObjectMemcpy(SoBufferObject, UInt64, UInt64, UInt64).)
	Memcpy(SoCpuBufferObject, UInt64, UInt64, UInt64)	Copy data from a CPU buffer into this buffer. (Overrides SoBufferObjectMemcpy(SoCpuBufferObject, UInt64, UInt64, UInt64).)
	Memcpy(SoGLBufferObject, UInt64, UInt64, UInt64)	Copy data from a GL buffer into this 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)	Set 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	Set the size of the buffer in bytes. (Overrides SoBufferObjectSetSize(UInt64).)
	SetTarget	Specify the buffer target, which defines possible usage of the buffer.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unbind	Unbind the buffer.
	UnlockBuffer	Unlocks the buffer object. (Inherited from SoBufferObject.)
	Unmap	Unmaps the buffer using the regular unmap function.
	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.

Top

Properties

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

Top

Remarks

This class provides management functions for OpenGL memory buffers.

NOTES:

Creating a OpenGL buffer requires a current OpenGL context. For example, by calling the viewer's bindNormalContext() method or by creating an SoGLContext object and binding (then unbinding) it.
Modifying the properties of an OpenGL buffer require a current OpenGL context. This includes changing properties (e.g. setTarget()), allocating memory (setSize()) and copying data into the buffer (e.g. memcpy()). Mapping a buffer does not require explicitly binding a context.
The setTarget() method must be called before any operation, as long as OpenGL requires the target for that operation.
For detailed use of this class it may be helpful to review and understand the use of OpenGL Buffer Objects, particularly Vertex Buffer Objects (VBO).

See SoBufferObject for general information about buffer objects.

See SoBufferedShape for an example of storing vertices in an OpenGL buffer.

EXAMPLE

Load data into a buffer object.

Create a GPU buffer object and load data from an array in memory:

Copy

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

SoGLContext glContext = new SoGLContext(true);
glContext.Bind();
   SoGLBufferObject gpuBuffer = new SoGLBufferObject(SoGLBufferObject.Usages.STATIC_DRAW);
   gpuBuffer.SetTarget( SoGLBufferObject.BufferObjectTargets.ARRAY_BUFFER );
   gpuBuffer.SetSize( cpuBuffer.GetSize() );  // Set the buffer size (allocate memory)
   gpuBuffer.Memcpy ( cpuBuffer );            // Copy data into the buffer
glContext.Unbind();

Load data into an existing GPU buffer from a CPU buffer:

Copy

SoGLContext ctx = (SoGLContext)gpuBuffer.GetContext();
ctx.Bind();
   gpuBuffer.SetSize( cpuBuffer.GetSize() ); // Set the buffer size (allocate memory)
   gpuBuffer.Memcpy ( cpuBuffer );           // Copy data into the buffer
ctx.Unbind();

Copy

cpuBuffer.Map( gpuBuffer, SoBufferObject.AccessModes.READ_ONLY );
cpuBuffer.Unmap();

EXAMPLE

Access data stored in a GPU buffer object.

Copy

SbNativeArray<float> data = (SbNativeArray<float>)gpuBuffer.Map( SoBufferObject.AccessModes.READ_ONLY );
float value = data[0];
value = data[1];
   . . .
gpuBuffer.Unmap();

Reference

OIV.Inventor.Devices Namespace

OIV.Inventor.DevicesSoCpuBufferObject