com.nativelibs4java.opencl

Class CLImage

java.lang.Object

com.nativelibs4java.opencl.CLMem

com.nativelibs4java.opencl.CLImage

Direct Known Subclasses:

CLImage2D

public abstract class CLImage
extends CLMem

OpenCL Image Memory Object.
An image object is used to store a two- or three- dimensional texture, frame-buffer or image
An image object is used to represent a buffer that can be used as a texture or a frame-buffer. The elements of an image object are selected from a list of predefined image formats.

Author:

Oliveir 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
CLEvent	copyTo(CLQueue queue, CLImage destination, CLEvent... eventsToWaitFor) Calls clEnqueueCopyImage.
CLEvent	copyTo(CLQueue queue, CLImage destination, long[] sourceOrigin, long[] destinationOrigin, long[] region, CLEvent... eventsToWaitFor) Calls clEnqueueCopyImage.
boolean	equals(Object obj) Underyling implementation pointer-based equality test
CLEvent	fillImage(CLQueue queue, Object color, CLEvent... eventsToWaitFor) Calls clEnqueueFillImage.
CLEvent	fillImage(CLQueue queue, Object color, long[] origin, long[] region, CLEvent... eventsToWaitFor) Calls clEnqueueFillImage.
long	getElementSize() Return size of each element of the image memory object given by image.
static <E extends TypedPointer,A extends com.nativelibs4java.opencl.CLAbstractEntity> Pointer<E>	getEntities(A[] objects, Pointer<E> out)
CLImageFormat	getFormat() Return image format descriptor specified when image is created with CLContext.create{Input|Output|InputOutput}{2D|3D}.
int	hashCode() Underyling implementation pointer-based hashCode computation
void	release() Manual release of the OpenCL resources represented by this object.
CLEvent	unmap(CLQueue queue, ByteBuffer buffer, CLEvent... eventsToWaitFor) Calls clEnqueueUnmapMemObject.

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

getFormat

public CLImageFormat getFormat()

Return image format descriptor specified when image is created with CLContext.create{Input|Output|InputOutput}{2D|3D}.

getElementSize

public long getElementSize()

Return size of each element of the image memory object given by image.
An element is made up of n channels. The value of n is given in cl_image_format descriptor.

fillImage

public CLEvent fillImage(CLQueue queue,
                         Object color,
                         CLEvent... eventsToWaitFor)

Calls clEnqueueFillImage.

Parameters:

queue -

queue - Queue on which to enqueue this fill buffer command.

color - Color components to fill the buffer with.

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.

fillImage

public CLEvent fillImage(CLQueue queue,
                         Object color,
                         long[] origin,
                         long[] region,
                         CLEvent... eventsToWaitFor)

Calls clEnqueueFillImage.

Parameters:

queue -

queue - Queue on which to enqueue this fill buffer command.

color - Color components to fill the buffer with.

origin - Origin point.

region - Size of the region to fill.

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.

unmap

public CLEvent unmap(CLQueue queue,
                     ByteBuffer buffer,
                     CLEvent... eventsToWaitFor)

Calls clEnqueueUnmapMemObject.
see CLImage2D.map(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLMem.MapFlags, com.nativelibs4java.opencl.CLEvent[]) see CLImage3D.map(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLMem.MapFlags, com.nativelibs4java.opencl.CLEvent[])

Parameters:

queue -

buffer -

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.

copyTo

public CLEvent copyTo(CLQueue queue,
                      CLImage destination,
                      CLEvent... eventsToWaitFor)

Calls clEnqueueCopyImage.

Parameters:

queue -

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.

copyTo

public CLEvent copyTo(CLQueue queue,
                      CLImage destination,
                      long[] sourceOrigin,
                      long[] destinationOrigin,
                      long[] region,
                      CLEvent... eventsToWaitFor)

Calls clEnqueueCopyImage.

Parameters:

queue -

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.

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