com.nativelibs4java.opencl

Class CLImage2D

java.lang.Object

com.nativelibs4java.opencl.CLMem

com.nativelibs4java.opencl.CLImage

com.nativelibs4java.opencl.CLImage2D

Direct Known Subclasses:

CLImage3D

public class CLImage2D
extends CLImage

OpenCL 2D Image Memory Object
see CLContext.createImage2D(com.nativelibs4java.opencl.CLMem.Usage, java.awt.Image, boolean) see CLContext.createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long) see CLContext.createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long) see CLContext.createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, java.nio.Buffer, boolean) see CLContext.createImage2DFromGLRenderBuffer(com.nativelibs4java.opencl.CLMem.Usage, int) see CLContext.createImage2DFromGLTexture2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLContext.GLTextureTarget, 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
static <E extends TypedPointer,A extends com.nativelibs4java.opencl.CLAbstractEntity> Pointer<E>	getEntities(A[] objects, Pointer<E> out)
long	getHeight() Return height of the image in pixels
long	getRowPitch() Return size in bytes of a row of elements of the image object given by image.
long	getWidth() Return width of the image in pixels
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 lengthX, long lengthY, long rowPitch, CLEvent... eventsToWaitFor)
Pair<ByteBuffer,CLEvent>	mapLater(CLQueue queue, CLMem.MapFlags flags, boolean blocking, CLEvent... eventsToWaitFor)
Pair<ByteBuffer,CLEvent>	mapLater(CLQueue queue, CLMem.MapFlags flags, long offsetX, long offsetY, long lengthX, long lengthY, long rowPitch, boolean blocking, CLEvent... eventsToWaitFor)
void	read(CLQueue queue, BufferedImage imageOut, boolean allowDeoptimizingDirectWrite, CLEvent... eventsToWaitFor)
BufferedImage	read(CLQueue queue, CLEvent... eventsToWaitFor)
CLEvent	read(CLQueue queue, long minX, long minY, long width, long height, long rowPitch, Buffer out, boolean blocking, CLEvent... eventsToWaitFor)
CLEvent	read(CLQueue queue, long minX, long minY, long width, long height, long rowPitch, Pointer<?> out, boolean blocking, CLEvent... eventsToWaitFor)
void	release() Manual release of the OpenCL resources represented by this object.
void	write(CLQueue queue, BufferedImage im)
void	write(CLQueue queue, BufferedImage imageIn, boolean allowDeoptimizingDirectRead, CLEvent... eventsToWaitFor)
CLEvent	write(CLQueue queue, Image image, boolean allowDeoptimizingDirectRead, boolean blocking, CLEvent... eventsToWaitFor)
CLEvent	write(CLQueue queue, Image image, CLEvent... eventsToWaitFor)
CLEvent	write(CLQueue queue, Image image, int destX, int destY, int width, int height, boolean allowDeoptimizingDirectRead, boolean blocking, CLEvent... eventsToWaitFor)
CLEvent	write(CLQueue queue, long minX, long minY, long width, long height, long rowPitch, Buffer in, boolean blocking, CLEvent... eventsToWaitFor)
CLEvent	write(CLQueue queue, long minX, long minY, long width, long height, long rowPitch, Pointer<?> in, boolean blocking, CLEvent... eventsToWaitFor)

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

getRowPitch

public long getRowPitch()

Return size in bytes of a row of elements of the image object given by image.

getWidth

public long getWidth()

Return width of the image in pixels

getHeight

public long getHeight()

Return height of the image in pixels

read

public CLEvent read(CLQueue queue,
                    long minX,
                    long minY,
                    long width,
                    long height,
                    long rowPitch,
                    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.

read

public CLEvent read(CLQueue queue,
                    long minX,
                    long minY,
                    long width,
                    long height,
                    long rowPitch,
                    Pointer<?> 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 width,
                     long height,
                     long rowPitch,
                     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.

write

public CLEvent write(CLQueue queue,
                     long minX,
                     long minY,
                     long width,
                     long height,
                     long rowPitch,
                     Pointer<?> 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.

read

public BufferedImage read(CLQueue queue,
                          CLEvent... eventsToWaitFor)

Parameters:

eventsToWaitFor - Events that need to complete before this particular command can be executed.

read

public void read(CLQueue queue,
                 BufferedImage imageOut,
                 boolean allowDeoptimizingDirectWrite,
                 CLEvent... eventsToWaitFor)

Parameters:

eventsToWaitFor - Events that need to complete before this particular command can be executed.

write

public CLEvent write(CLQueue queue,
                     Image image,
                     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,
                     Image image,
                     boolean allowDeoptimizingDirectRead,
                     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,
                     Image image,
                     int destX,
                     int destY,
                     int width,
                     int height,
                     boolean allowDeoptimizingDirectRead,
                     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 void write(CLQueue queue,
                  BufferedImage imageIn,
                  boolean allowDeoptimizingDirectRead,
                  CLEvent... eventsToWaitFor)

write

public void write(CLQueue queue,
                  BufferedImage im)

map

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

map

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

mapLater

public Pair<ByteBuffer,CLEvent> mapLater(CLQueue queue,
                                         CLMem.MapFlags flags,
                                         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:

Pair with byte buffer 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.

mapLater

public Pair<ByteBuffer,CLEvent> mapLater(CLQueue queue,
                                         CLMem.MapFlags flags,
                                         long offsetX,
                                         long offsetY,
                                         long lengthX,
                                         long lengthY,
                                         long rowPitch,
                                         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:

Pair with byte buffer 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