com.nativelibs4java.opencl

Class CLSampler

java.lang.Object

com.nativelibs4java.opencl.CLSampler

public class CLSampler
extends Object

OpenCL sampler object.
A sampler object describes how to sample an image when the image is read in the kernel.
The built-in functions to read from an image in a kernel take a sampler as an argument.
The sampler arguments to the image read function can be sampler objects created using OpenCL functions and passed as argument values to the kernel or can be samplers declared inside a kernel.
see CLContext.createSampler(boolean, com.nativelibs4java.opencl.CLSampler.AddressingMode, com.nativelibs4java.opencl.CLSampler.FilterMode)

Author:

Olivier Chafik

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CLSampler.AddressingMode Values for CL_SAMPLER_ADDRESSING_MODE How out-of-range image coordinates are handled when reading from an image
static class	CLSampler.FilterMode Values for CL_SAMPLER_FILTER_MODE Type of filter that must be applied when reading an image

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Underyling implementation pointer-based equality test
CLSampler.AddressingMode	getAddressingMode() Return the value specified by addressing_mode argument to CLContext.createSampler.
static <E extends TypedPointer,A extends com.nativelibs4java.opencl.CLAbstractEntity> Pointer<E>	getEntities(A[] objects, Pointer<E> out)
CLSampler.FilterMode	getFilterMode() Return the value specified by filter_mode argument to CLContext.createSampler.
boolean	getNormalizedCoords() Return the value specified by normalized_coords argument to CLContext.createSampler.
int	hashCode() Underyling implementation pointer-based hashCode computation
void	release() Manual release of the OpenCL resources represented by this object.

Methods inherited from class java.lang.Object

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

Method Detail

getAddressingMode

public CLSampler.AddressingMode getAddressingMode()

Return the value specified by addressing_mode argument to CLContext.createSampler.

getFilterMode

public CLSampler.FilterMode getFilterMode()

Return the value specified by filter_mode argument to CLContext.createSampler.

getNormalizedCoords

public boolean getNormalizedCoords()

Return the value specified by normalized_coords argument to CLContext.createSampler.

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