com.nativelibs4java.opencl

Class CLImage3D

java.lang.Object

com.nativelibs4java.opencl.CLMem

com.nativelibs4java.opencl.CLImage

com.nativelibs4java.opencl.CLImage2D

com.nativelibs4java.opencl.CLImage3D

public class CLImage3D
extends CLImage2D

OpenCL 3D Image Memory Object
see CLContext.createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long) see CLContext.createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, long, long) see CLContext.createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, long, long, java.nio.Buffer, boolean) see CLContext.createImage3DFromGLTexture3D(com.nativelibs4java.opencl.CLMem.Usage, int, int)

Author:

Olivier Chafik

Nested Class Summary

Nested classes/interfaces inherited from class com.nativelibs4java.opencl.CLMem

CLMem.DestructorCallback, CLMem.Flags, CLMem.GLObjectInfo, CLMem.GLObjectType, CLMem.MapFlags, CLMem.Migration, CLMem.ObjectType, CLMem.Usage

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Underyling implementation pointer-based equality test
long	getDepth() Return depth of the image in pixels.
static <E extends TypedPointer,A extends com.nativelibs4java.opencl.CLAbstractEntity> Pointer<E>	getEntities(A[] objects, Pointer<E> out)
long	getSlicePitch() Return size in bytes of a 2D slice for this 3D image object.
int	hashCode() Underyling implementation pointer-based hashCode computation
ByteBuffer	map(CLQueue queue, CLMem.MapFlags flags, CLEvent... eventsToWaitFor)
ByteBuffer	map(CLQueue queue, CLMem.MapFlags flags, long offsetX, long offsetY, long offsetZ, long lengthX, long lengthY, long lengthZ, long rowPitch, long slicePitch, boolean blocking, CLEvent... eventsToWaitFor)
Pair<ByteBuffer,CLEvent>	mapLater(CLQueue queue, CLMem.MapFlags flags, CLEvent... eventsToWaitFor)
Pair<ByteBuffer,CLEvent>	mapLater(CLQueue queue, CLMem.MapFlags flags, long offsetX, long offsetY, long offsetZ, long lengthX, long lengthY, long lengthZ, long rowPitch, long slicePitch, CLEvent... eventsToWaitFor)
CLEvent	read(CLQueue queue, long minX, long minY, long minZ, long width, long height, long depth, long rowPitch, long slicePitch, Buffer out, boolean blocking, CLEvent... eventsToWaitFor)
void	release() Manual release of the OpenCL resources represented by this object.
CLEvent	write(CLQueue queue, long minX, long minY, long minZ, long width, long height, long depth, long rowPitch, long slicePitch, Buffer in, boolean blocking, CLEvent... eventsToWaitFor)

Methods inherited from class com.nativelibs4java.opencl.CLImage2D

getHeight, getRowPitch, getWidth, map, mapLater, mapLater, read, read, read, read, write, write, write, write, write, write, write

Methods inherited from class com.nativelibs4java.opencl.CLImage

copyTo, copyTo, fillImage, fillImage, getElementSize, getFormat, unmap

Methods inherited from class com.nativelibs4java.opencl.CLMem

acquireGLObject, getByteCount, getContext, getGLObjectInfo, releaseGLObject, setDestructorCallback

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSlicePitch

public long getSlicePitch()

Return size in bytes of a 2D slice for this 3D image object.

getDepth

public long getDepth()

Return depth of the image in pixels.

read

public CLEvent read(CLQueue queue,
                    long minX,
                    long minY,
                    long minZ,
                    long width,
                    long height,
                    long depth,
                    long rowPitch,
                    long slicePitch,
                    Buffer out,
                    boolean blocking,
                    CLEvent... eventsToWaitFor)

Parameters:

eventsToWaitFor - Events that need to complete before this particular command can be executed. Special value CLEvent.FIRE_AND_FORGET can be used to avoid returning a CLEvent.

Returns:

Event object that identifies this command and can be used to query or queue a wait for the command to complete, or null if eventsToWaitFor contains CLEvent.FIRE_AND_FORGET.

write

public CLEvent write(CLQueue queue,
                     long minX,
                     long minY,
                     long minZ,
                     long width,
                     long height,
                     long depth,
                     long rowPitch,
                     long slicePitch,
                     Buffer in,
                     boolean blocking,
                     CLEvent... eventsToWaitFor)

Parameters:

eventsToWaitFor - Events that need to complete before this particular command can be executed. Special value CLEvent.FIRE_AND_FORGET can be used to avoid returning a CLEvent.

Returns:

Event object that identifies this command and can be used to query or queue a wait for the command to complete, or null if eventsToWaitFor contains CLEvent.FIRE_AND_FORGET.

map

public ByteBuffer map(CLQueue queue,
                      CLMem.MapFlags flags,
                      CLEvent... eventsToWaitFor)

Overrides:

map in class CLImage2D

mapLater

public Pair<ByteBuffer,CLEvent> mapLater(CLQueue queue,
                                         CLMem.MapFlags flags,
                                         CLEvent... eventsToWaitFor)

Parameters:

eventsToWaitFor - Events that need to complete before this particular command can be executed. Special value CLEvent.FIRE_AND_FORGET can be used to avoid returning a CLEvent.

Returns:

Pair with mapped data and event object that identifies this command and can be used to query or queue a wait for the command to complete, or null if eventsToWaitFor contains CLEvent.FIRE_AND_FORGET.

map

public ByteBuffer map(CLQueue queue,
                      CLMem.MapFlags flags,
                      long offsetX,
                      long offsetY,
                      long offsetZ,
                      long lengthX,
                      long lengthY,
                      long lengthZ,
                      long rowPitch,
                      long slicePitch,
                      boolean blocking,
                      CLEvent... eventsToWaitFor)

mapLater

public Pair<ByteBuffer,CLEvent> mapLater(CLQueue queue,
                                         CLMem.MapFlags flags,
                                         long offsetX,
                                         long offsetY,
                                         long offsetZ,
                                         long lengthX,
                                         long lengthY,
                                         long lengthZ,
                                         long rowPitch,
                                         long slicePitch,
                                         CLEvent... eventsToWaitFor)

Parameters:

eventsToWaitFor - Events that need to complete before this particular command can be executed. Special value CLEvent.FIRE_AND_FORGET can be used to avoid returning a CLEvent.

Returns:

Pair with mapped data and event object that identifies this command and can be used to query or queue a wait for the command to complete, or null if eventsToWaitFor contains CLEvent.FIRE_AND_FORGET.

release

public void release()

Manual release of the OpenCL resources represented by this object.
Note that resources are automatically released by the garbage collector, so in general there's no need to call this method.
In an environment with fast allocation/deallocation of large objects, it might be safer to call release() manually, though.
Note that release() does not necessarily free the object immediately : OpenCL maintains a reference count for all its objects, and an object released on the Java side might still be pointed to by running kernels or queued operations.

getEntities

public static <E extends TypedPointer,A extends com.nativelibs4java.opencl.CLAbstractEntity> Pointer<E> getEntities(A[] objects,
                                                                                                                    Pointer<E> out)

hashCode

public int hashCode()

Underyling implementation pointer-based hashCode computation

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Underyling implementation pointer-based equality test

Overrides:

equals in class Object