JOCL 2.3.2 · com.jogamp.opencl.CLContext

Modifier and Type	Class and Description
protected static class	CLContext.ErrorDispatcher

Modifier and Type	Field and Description
protected CLDevice[]	devices
private final CLContext.ErrorDispatcher	errorHandler
protected final Set<CLMemory<? extends Buffer>>	memoryObjects
protected final CLPlatform	platform
protected final Set<CLProgram>	programs
protected final Map<CLDevice, List<CLCommandQueue>>	queuesMap
protected final Set<CLSampler>	samplers

Access	Constructor and Description
protected	CLContext(final CLPlatform platform, final long contextID, final CLContext.ErrorDispatcher dispatcher)

Method Summary

Modifier and Type	Method and Description
public void	addCLErrorHandler(final CLErrorHandler handler)
public static CLContext	create() Creates a context on all available devices (CL_DEVICE_TYPE_ALL).
public static CLContext	create(final CLDevice.Type... deviceTypes) Creates a context on the specified device types.
public static CLContext	create(final CLPlatform platform) Creates a context on the specified platform on all available devices (CL_DEVICE_TYPE_ALL).
public static CLContext	create(CLPlatform platform, final CLDevice.Type... deviceTypes) Creates a context on the specified platform and with the specified device types.
public static CLContext	create(final CLDevice... devices) Creates a context on the specified devices.
public final CLBuffer<?>	createBuffer(final int size, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags.
public final CLBuffer<?>	createBuffer(final int size, final int flags) Creates a CLBuffer with the specified flags.
public final <B extends Buffer> CLBuffer<B>	createBuffer(final B directBuffer, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags.
public final <B extends Buffer> CLBuffer<B>	createBuffer(final B directBuffer, final int flags) Creates a CLBuffer with the specified flags.
public final CLBuffer<ByteBuffer>	createByteBuffer(final int size, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags and buffer size in bytes.
public final CLBuffer<ByteBuffer>	createByteBuffer(final int size, final int flags) Creates a CLBuffer with the specified flags and buffer size in bytes.
pack-priv CLCommandQueue	createCommandQueue(final CLDevice device, final long properties)
protected static long	createContext(final CLPlatform platform, final CLErrorHandler handler, final PointerBuffer properties, final CLDevice... devices)
protected static long	createContextFromType(final CLPlatform platform, final CLErrorHandler handler, final PointerBuffer properties, final long deviceType)
public final CLBuffer<DoubleBuffer>	createDoubleBuffer(final int size, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags and element count.
protected static CLContext.ErrorDispatcher	createErrorHandler()
public final CLBuffer<FloatBuffer>	createFloatBuffer(final int size, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags and element count.
public final CLImage2d<?>	createImage2d(final int width, final int height, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage2d with the specified format, dimension and flags.
public final CLImage2d<?>	createImage2d(final int width, final int height, final int rowPitch, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage2d with the specified format, dimension and flags.
public final <B extends Buffer> CLImage2d<B>	createImage2d(final B directBuffer, final int width, final int height, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage2d with the specified format, dimension and flags.
public final <B extends Buffer> CLImage2d<B>	createImage2d(final B directBuffer, final int width, final int height, final int rowPitch, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage2d with the specified format, dimension and flags.
public final CLImage3d<?>	createImage3d(final int width, final int height, final int depth, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage3d with the specified format, dimension and flags.
public final CLImage3d<?>	createImage3d(final int width, final int height, final int depth, final int rowPitch, final int slicePitch, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage3d with the specified format, dimension and flags.
public final <B extends Buffer> CLImage3d<B>	createImage3d(final B directBuffer, final int width, final int height, final int depth, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage3d with the specified format, dimension and flags.
public final <B extends Buffer> CLImage3d<B>	createImage3d(final B directBuffer, final int width, final int height, final int depth, final int rowPitch, final int slicePitch, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage3d with the specified format, dimension and flags.
public final CLBuffer<IntBuffer>	createIntBuffer(final int size, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags and element count.
public final CLBuffer<LongBuffer>	createLongBuffer(final int size, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags and element count.
public CLProgram	createProgram(final String src) Creates a program from the given sources, the returned program is not build yet.
public CLProgram	createProgram(final InputStream source) Creates a program and reads the source from stream, the returned program is not build yet.
public CLProgram	createProgram(final Map<CLDevice, byte[]> binaries) Creates a program from the given binaries, the program is not build yet.
public CLSampler	createSampler(final CLSampler.AddressingMode addrMode, final CLSampler.FilteringMode filtMode, final boolean normalizedCoords)
public final CLBuffer<ShortBuffer>	createShortBuffer(final int size, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags and element count.
public boolean	equals(final Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public CL	getCL() Return the low level OpenCL interface.
public CLContext	getContext() Overrides com.jogamp.opencl.CLObject.getContext. Returns the context for this OpenCL object.
pack-priv CLDevice	getDevice(final long dID)
public CLDevice[]	getDevices() Returns all devices associated with this CLContext.
public CLDevice	getMaxFlopsDevice() Returns the device with maximal FLOPS from this context.
public CLDevice	getMaxFlopsDevice(final CLDevice.Type type) Returns the device with maximal FLOPS of the specified device type from this context.
public long	getMaxMemBaseAddrAlign() Returns the maximum `CLDevice#getMemBaseAddrAlign()` of all devices.
public List<CLMemory<? extends Buffer>>	getMemoryObjects() Returns a read only shapshot of all allocated memory objects associated with this context.
public CLPlatform	getPlatform() Overrides com.jogamp.opencl.CLObject.getPlatform. Returns the CLPlatform this context is running on.
public List<CLProgram>	getPrograms() Returns a read only shapshot of all programs associated with this context.
public List<CLSampler>	getSamplers() Returns a read only shapshot of all samplers associated with this context.
public CLImageFormat[]	getSupportedImage2dFormats(final CLMemory.Mem... flags) Returns all supported 2d image formats with the (optional) memory allocation flags.
public CLImageFormat[]	getSupportedImage3dFormats(final CLMemory.Mem... flags) Returns all supported 3d image formats with the (optional) memory allocation flags.
private CLImageFormat[]	getSupportedImageFormats(final int flags, final int type)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private synchronized void	initDevices(final CLContextBinding cl)
pack-priv void	onCommandQueueReleased(final CLDevice device, final CLCommandQueue queue)
pack-priv void	onMemoryReleased(final CLMemory<?> buffer)
pack-priv void	onProgramReleased(final CLProgram program)
pack-priv void	onSamplerReleased(final CLSampler sampler)
protected void	overrideContext(final CLDevice device)
private void	release(final Collection<? extends CLResource> resources)
public synchronized void	release() Overrides com.jogamp.opencl.CLObjectResource.release. Implements com.jogamp.opencl.CLResource.release. Releases this context and all resources.
public void	removeCLErrorHandler(final CLErrorHandler handler)
private static PointerBuffer	setupContextProperties(final CLPlatform platform)
protected static long	toDeviceBitmap(final CLDevice.Type[] deviceTypes)
public String	toString() Overrides com.jogamp.opencl.CLObject.toString. Returns a string representation of the object.

Inherited from com.jogamp.opencl.CLObjectResource:: close isReleased

devices	back to summary
protected CLDevice[] devices

errorHandler	back to summary
private final CLContext.ErrorDispatcher errorHandler

memoryObjects	back to summary
protected final Set<CLMemory<? extends Buffer>> memoryObjects

platform	back to summary
protected final CLPlatform platform

programs	back to summary
protected final Set<CLProgram> programs

queuesMap	back to summary
protected final Map<CLDevice, List<CLCommandQueue>> queuesMap

samplers	back to summary
protected final Set<CLSampler> samplers

CLContext	back to summary
protected CLContext(final CLPlatform platform, final long contextID, final CLContext.ErrorDispatcher dispatcher)

Method Detail

addCLErrorHandler	back to summary
public void addCLErrorHandler(final CLErrorHandler handler)

create	back to summary
public static CLContext create() Creates a context on all available devices (CL_DEVICE_TYPE_ALL). The platform to be used is implementation dependent.

create	back to summary
public static CLContext create(final CLDevice.Type... deviceTypes) Creates a context on the specified device types. The platform to be used is implementation dependent.

create	back to summary
public static CLContext create(final CLPlatform platform) Creates a context on the specified platform on all available devices (CL_DEVICE_TYPE_ALL).

create	back to summary
public static CLContext create(CLPlatform platform, final CLDevice.Type... deviceTypes) Creates a context on the specified platform and with the specified device types.

create	back to summary
public static CLContext create(final CLDevice... devices) Creates a context on the specified devices.

createBuffer	back to summary
public final CLBuffer<?> createBuffer(final int size, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags. No flags creates a MEM.READ_WRITE buffer.

createBuffer	back to summary
public final CLBuffer<?> createBuffer(final int size, final int flags) Creates a CLBuffer with the specified flags.

createBuffer	back to summary
public final <B extends Buffer> CLBuffer<B> createBuffer(final B directBuffer, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags. No flags creates a MEM.READ_WRITE buffer.

createBuffer	back to summary
public final <B extends Buffer> CLBuffer<B> createBuffer(final B directBuffer, final int flags) Creates a CLBuffer with the specified flags.

createByteBuffer	back to summary
public final CLBuffer<ByteBuffer> createByteBuffer(final int size, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags and buffer size in bytes. No flags creates a MEM.READ_WRITE buffer.

createByteBuffer	back to summary
public final CLBuffer<ByteBuffer> createByteBuffer(final int size, final int flags) Creates a CLBuffer with the specified flags and buffer size in bytes.

createCommandQueue	back to summary
pack-priv CLCommandQueue createCommandQueue(final CLDevice device, final long properties)

createContext	back to summary
protected static long createContext(final CLPlatform platform, final CLErrorHandler handler, final PointerBuffer properties, final CLDevice... devices)

createContextFromType	back to summary
protected static long createContextFromType(final CLPlatform platform, final CLErrorHandler handler, final PointerBuffer properties, final long deviceType)

createDoubleBuffer	back to summary
public final CLBuffer<DoubleBuffer> createDoubleBuffer(final int size, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags and element count. No flags creates a MEM.READ_WRITE buffer.

createErrorHandler	back to summary
protected static CLContext.ErrorDispatcher createErrorHandler()

createFloatBuffer	back to summary
public final CLBuffer<FloatBuffer> createFloatBuffer(final int size, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags and element count. No flags creates a MEM.READ_WRITE buffer.

createImage2d	back to summary
public final CLImage2d<?> createImage2d(final int width, final int height, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage2d with the specified format, dimension and flags.

createImage2d	back to summary
public final CLImage2d<?> createImage2d(final int width, final int height, final int rowPitch, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage2d with the specified format, dimension and flags.

createImage2d	back to summary
public final <B extends Buffer> CLImage2d<B> createImage2d(final B directBuffer, final int width, final int height, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage2d with the specified format, dimension and flags.

createImage2d	back to summary
public final <B extends Buffer> CLImage2d<B> createImage2d(final B directBuffer, final int width, final int height, final int rowPitch, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage2d with the specified format, dimension and flags.

createImage3d	back to summary
public final CLImage3d<?> createImage3d(final int width, final int height, final int depth, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage3d with the specified format, dimension and flags.

createImage3d	back to summary
public final CLImage3d<?> createImage3d(final int width, final int height, final int depth, final int rowPitch, final int slicePitch, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage3d with the specified format, dimension and flags.

createImage3d	back to summary
public final <B extends Buffer> CLImage3d<B> createImage3d(final B directBuffer, final int width, final int height, final int depth, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage3d with the specified format, dimension and flags.

createImage3d	back to summary
public final <B extends Buffer> CLImage3d<B> createImage3d(final B directBuffer, final int width, final int height, final int depth, final int rowPitch, final int slicePitch, final CLImageFormat format, final CLMemory.Mem... flags) Creates a CLImage3d with the specified format, dimension and flags.

createIntBuffer	back to summary
public final CLBuffer<IntBuffer> createIntBuffer(final int size, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags and element count. No flags creates a MEM.READ_WRITE buffer.

createLongBuffer	back to summary
public final CLBuffer<LongBuffer> createLongBuffer(final int size, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags and element count. No flags creates a MEM.READ_WRITE buffer.

createProgram	back to summary
public CLProgram createProgram(final String src) Creates a program from the given sources, the returned program is not build yet.

createProgram	back to summary
public CLProgram createProgram(final InputStream source) throws IOException Creates a program and reads the source from stream, the returned program is not build yet. The InputStream is automatically closed after the sources have been read. Exceptions IOException: when a IOException occurred while reading or closing the stream.

createProgram

back to summary

public CLProgram createProgram(final InputStream source) throws IOException

Creates a program and reads the source from stream, the returned program is not build yet. The InputStream is automatically closed after the sources have been read.

Exceptions

IOException:: when a IOException occurred while reading or closing the stream.

createProgram	back to summary
public CLProgram createProgram(final Map<CLDevice, byte[]> binaries) Creates a program from the given binaries, the program is not build yet. Creating a program will fail if: the submitted binaries are invalid or can not be loaded from the OpenCL driver the binaries do not fit to the CLDevices associated with this context binaries are missing for one or more CLDevices

createProgram

back to summary

public CLProgram createProgram(final Map<CLDevice, byte[]> binaries)

Creates a program from the given binaries, the program is not build yet.
Creating a program will fail if:

the submitted binaries are invalid or can not be loaded from the OpenCL driver
the binaries do not fit to the CLDevices associated with this context
binaries are missing for one or more CLDevices

createSampler	back to summary
public CLSampler createSampler(final CLSampler.AddressingMode addrMode, final CLSampler.FilteringMode filtMode, final boolean normalizedCoords)

createShortBuffer	back to summary
public final CLBuffer<ShortBuffer> createShortBuffer(final int size, final CLMemory.Mem... flags) Creates a CLBuffer with the specified flags and element count. No flags creates a MEM.READ_WRITE buffer.

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getCL	back to summary
public CL getCL() Return the low level OpenCL interface.

getContext	back to summary
public CLContext getContext() Overrides com.jogamp.opencl.CLObject.getContext. Doc from com.jogamp.opencl.CLObject.getContext. Returns the context for this OpenCL object. Annotations @Override

getContext

back to summary

public CLContext getContext()

Overrides com.jogamp.opencl.CLObject.getContext.

Doc from com.jogamp.opencl.CLObject.getContext.

Returns the context for this OpenCL object.

Annotations

@Override

getDevice	back to summary
pack-priv CLDevice getDevice(final long dID)

getDevices	back to summary
public CLDevice[] getDevices() Returns all devices associated with this CLContext.

getMaxFlopsDevice back to summary

public CLDevice getMaxFlopsDevice()

Returns the device with maximal FLOPS from this context. The device speed is estimated by calculating the product of MAX_COMPUTE_UNITS and MAX_CLOCK_FREQUENCY.

See Also: getMaxFlopsDevice(com.jogamp.opencl.CLDevice.Type)

getMaxFlopsDevice	back to summary
public CLDevice getMaxFlopsDevice(final CLDevice.Type type) Returns the device with maximal FLOPS of the specified device type from this context. The device speed is estimated by calculating the product of MAX_COMPUTE_UNITS and MAX_CLOCK_FREQUENCY.

getMaxMemBaseAddrAlign	back to summary
public long getMaxMemBaseAddrAlign() Returns the maximum `CLDevice#getMemBaseAddrAlign()` of all devices.

getMemoryObjects	back to summary
public List<CLMemory<? extends Buffer>> getMemoryObjects() Returns a read only shapshot of all allocated memory objects associated with this context.

getPlatform

back to summary

public CLPlatform getPlatform()

Overrides com.jogamp.opencl.CLObject.getPlatform.

Returns the CLPlatform this context is running on.

Annotations

@Override

getPrograms	back to summary
public List<CLProgram> getPrograms() Returns a read only shapshot of all programs associated with this context.

getSamplers	back to summary
public List<CLSampler> getSamplers() Returns a read only shapshot of all samplers associated with this context.

getSupportedImage2dFormats	back to summary
public CLImageFormat[] getSupportedImage2dFormats(final CLMemory.Mem... flags) Returns all supported 2d image formats with the (optional) memory allocation flags.

getSupportedImage3dFormats	back to summary
public CLImageFormat[] getSupportedImage3dFormats(final CLMemory.Mem... flags) Returns all supported 3d image formats with the (optional) memory allocation flags.

getSupportedImageFormats	back to summary
private CLImageFormat[] getSupportedImageFormats(final int flags, final int type)

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

initDevices	back to summary
private synchronized void initDevices(final CLContextBinding cl)

onCommandQueueReleased	back to summary
pack-priv void onCommandQueueReleased(final CLDevice device, final CLCommandQueue queue)

onMemoryReleased	back to summary
pack-priv void onMemoryReleased(final CLMemory<?> buffer)

onProgramReleased	back to summary
pack-priv void onProgramReleased(final CLProgram program)

onSamplerReleased	back to summary
pack-priv void onSamplerReleased(final CLSampler sampler)

overrideContext	back to summary
protected void overrideContext(final CLDevice device)

release	back to summary
private void release(final Collection<? extends CLResource> resources)

release

back to summary

public synchronized void release()

Overrides com.jogamp.opencl.CLObjectResource.release.

Implements com.jogamp.opencl.CLResource.release.

Releases this context and all resources.

Annotations

@Override

removeCLErrorHandler	back to summary
public void removeCLErrorHandler(final CLErrorHandler handler)

setupContextProperties	back to summary
private static PointerBuffer setupContextProperties(final CLPlatform platform)

toDeviceBitmap	back to summary
protected static long toDeviceBitmap(final CLDevice.Type[] deviceTypes)

toString

back to summary

public String toString()

Overrides com.jogamp.opencl.CLObject.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

public Class CLContext

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class CLContext.ErrorDispatcher

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Method and Description
private synchronized void	addHandler(final CLErrorHandler handler)
public synchronized void	onError(final String errinfo, final ByteBuffer private_info, final long cb) Implements com.jogamp.opencl.CLErrorHandler.onError.
private synchronized void	removeHandler(final CLErrorHandler handler)