com.openinventor.inventor.devices

Class SoCpuBufferObject

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.devices.SoBufferObject

com.openinventor.inventor.devices.SoCpuBufferObject

All Implemented Interfaces:

SafeDisposable

Direct Known Subclasses:

SoCpuBufferBasicProperty, SoCpuBufferBitSet, SoCpuBufferCompressed, SoCpuBufferFromVolumeReader, SoCpuBufferUniform

public class SoCpuBufferObject
extends SoBufferObject

CPU buffer object class. This 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 SoPreferences).

See SoBufferObject for general information about buffer objects.

See 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 = {
         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
 };
 
 // Create a CPU buffer object and set its size (allocate memory)
 SoCpuBufferObject cpuBuffer = new SoCpuBufferObject();
 cpuBuffer.setSize( vertices.length * Float.SIZE/8 );
 
 // Copy vertex data into the buffer object
 FloatBuffer vertData = cpuBuffer.map( SoBufferObject.AccessModes.SET ).asFloatBuffer();
 vertData.put(vertices);
 cpuBuffer.unmap();

EXAMPLE

Access data stored in a buffer object.

 ByteBuffer data = cpuBuffer.map( SoBufferObject.AccessModes.READ_ONLY );
 byte value = data.get(0);
     . . .
 cpuBuffer.unmap();

See also:

SoGLBufferObject

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.devices.SoBufferObject

SoBufferObject.AccessModes

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.devices.SoBufferObject

SO_BUFFER_SIZE_ALL

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoCpuBufferObject() Default constructor.
SoCpuBufferObject(java.nio.ByteBuffer buffer) Constructor that takes an existing block of CPU memory.

Method Summary

Modifier and Type	Method and Description
void	clearInstance() Free the memory allocated by the buffer object.
void	setBuffer(java.nio.ByteBuffer buffer) Request that the buffer object manage an existing block of memory.
boolean	setSize(long size) Sets the size in bytes of the buffer object.

Methods inherited from class com.openinventor.inventor.devices.SoBufferObject

createInstance, dispose, getBufferObjectCache, getContext, getMappedBufferObject, getMappedBufferObjectAccessMode, getMappedBufferObjectPosition, getMappedBufferObjectSize, getSize, isDisposable, lockBuffer, map, map, map, map, map, map, memcpy, memcpy, memcpy, memcpy, unlockBuffer, unmap, unmap

Methods inherited from class com.openinventor.inventor.Inventor

getNativeResourceHandle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SoCpuBufferObject

public SoCpuBufferObject()

Default constructor. The contents of the buffer are initially empty.

SoCpuBufferObject

public SoCpuBufferObject(java.nio.ByteBuffer buffer)

Constructor that takes an existing block of CPU memory.
This memory is owned, and should be freed by, the application.

Parameters:

buffer - Pointer to the buffer to manage.

size - Size of buffer in bytes.

Method Detail

clearInstance

public void clearInstance()

Description copied from class: SoBufferObject

Free the memory allocated by the buffer object.

Overrides:

clearInstance in class SoBufferObject

setSize

public boolean setSize(long size)

Description copied from class: SoBufferObject

Sets the size in bytes of the buffer object.

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.

Overrides:

setSize in class SoBufferObject

Parameters:

size - The requested size in bytes.

Returns:

true if the operation was successful.

setBuffer

public void setBuffer(java.nio.ByteBuffer buffer)

Request that the buffer object manage an existing block of memory.
The application still owns this memory and is responsible for releasing the memory (when no SoCpuBufferObjects have a reference on it).

We recommend to use the most aligned memory pointer possible to enable optimized algorithm usage.

NOTE: If another buffer object is currently mapped into another buffer, the other buffer is automatically unmapped and its contents are undefined.