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.

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

READ_ONLY, READ_WRITE, SET, 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.
java.nio.ByteBuffer	map(SoBufferObject.AccessModes accessMode) Map the buffer to a system memory address.
void	map(SoGLBufferObject targetBufferObject, SoBufferObject.AccessModes accessMode) Calls map(targetBufferObject, accessMode, (long)0, (long)SO_BUFFER_SIZE_ALL).
void	map(SoGLBufferObject targetBufferObject, SoBufferObject.AccessModes accessMode, long startPosition) Calls map(targetBufferObject, accessMode, startPosition, (long)SO_BUFFER_SIZE_ALL).
void	map(SoGLBufferObject targetBufferObject, SoBufferObject.AccessModes accessMode, long startPosition, long mappingSize) Map the current buffer object into the specified GL buffer object.
void	memcpy(SoGLBufferObject sourceBufferObject) Calls memcpy(sourceBufferObject, (long)0, (long)0, (long)SO_BUFFER_SIZE_ALL).
void	memcpy(SoGLBufferObject sourceBufferObject, long destOffset) Calls memcpy(sourceBufferObject, destOffset, (long)0, (long)SO_BUFFER_SIZE_ALL).
void	memcpy(SoGLBufferObject sourceBufferObject, long destOffset, long sourceOffset) Calls memcpy(sourceBufferObject, destOffset, sourceOffset, (long)SO_BUFFER_SIZE_ALL).
void	memcpy(SoGLBufferObject sourceBufferObject, long destOffset, long sourceOffset, long copySize) Copy data from the specified GL buffer object into this 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.
void	unmap() Unmap a buffer mapped to a system memory address.
void	unmap(SoGLBufferObject bufferObject) Unmap the specified GL buffer object.

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

createInstance, dispose, getBufferObjectCache, getContext, getMappedBufferObject, getMappingAccessMode, getMappingSize, getMappingStartPosition, getSize, isDisposable, lockBuffer, map, map, map, map, map, map, memcpy, memcpy, memcpy, memcpy, memcpy, memcpy, memcpy, memcpy, setMappedBufferObject, setMappingAccessMode, setMappingZoneInformation, unlockBuffer, unmap, unmap

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Constructor Detail

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.

SoCpuBufferObject

public SoCpuBufferObject()

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

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.

Overrides:

setSize in class SoBufferObject

Parameters:

size - The requested size in bytes.

Returns:

True if the operation was successful.

map

public void map(SoGLBufferObject targetBufferObject,
                SoBufferObject.AccessModes accessMode,
                long startPosition)

Calls map(targetBufferObject, accessMode, startPosition, (long)SO_BUFFER_SIZE_ALL).

memcpy

public void memcpy(SoGLBufferObject sourceBufferObject,
                   long destOffset)

Calls memcpy(sourceBufferObject, destOffset, (long)0, (long)SO_BUFFER_SIZE_ALL).

memcpy

public void memcpy(SoGLBufferObject sourceBufferObject)

Calls memcpy(sourceBufferObject, (long)0, (long)0, (long)SO_BUFFER_SIZE_ALL).

map

public void map(SoGLBufferObject targetBufferObject,
                SoBufferObject.AccessModes accessMode)

Calls map(targetBufferObject, accessMode, (long)0, (long)SO_BUFFER_SIZE_ALL).

memcpy

public void memcpy(SoGLBufferObject sourceBufferObject,
                   long destOffset,
                   long sourceOffset)

Calls memcpy(sourceBufferObject, destOffset, sourceOffset, (long)SO_BUFFER_SIZE_ALL).

memcpy

public void memcpy(SoGLBufferObject sourceBufferObject,
                   long destOffset,
                   long sourceOffset,
                   long copySize)

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.

map

public void map(SoGLBufferObject targetBufferObject,
                SoBufferObject.AccessModes accessMode,
                long startPosition,
                long mappingSize)

Map the current buffer object into the specified GL buffer object. This is an optimized implementation. See the general map() method for more information.

unmap

public void unmap(SoGLBufferObject bufferObject)

Unmap the specified GL buffer object. This is an optimized implementation. See the general unmap function for more information.

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 (ie. SSE/Altivec computing, CUDA memory mapping, etc).

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

map

public java.nio.ByteBuffer map(SoBufferObject.AccessModes accessMode)

Map the buffer to a system memory address.

Returns:

the byte buffer associated with this cpu buffer. Returns null if empty. The size of the returned byte buffer can be limited to 2^31 bytes. This is a limitation of the jvm. See the java runtime option -XX:MaxDirectMemorySize for details.

unmap

public void unmap()

Unmap a buffer mapped to a system memory address. No error is reported if the buffer was not mapped.