org.bytedeco.opencv.opencv_core

Class OpenCLExecutionContext

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_core.OpenCLExecutionContext

All Implemented Interfaces:

AutoCloseable

@Namespace(value="cv::ocl")
 @NoOffset
 @Properties(inherit=opencv_core.class)
public class OpenCLExecutionContext
extends Pointer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenCLExecutionContext.Impl

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
OpenCLExecutionContext()
OpenCLExecutionContext(long size) Native array allocator.
OpenCLExecutionContext(OpenCLExecutionContext arg0)
OpenCLExecutionContext(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
void	bind() Bind this OpenCL execution context to current thread.
OpenCLExecutionContext	cloneWithNewQueue() \overload
OpenCLExecutionContext	cloneWithNewQueue(Queue q) Creates new execution context with same OpenCV context and device
static OpenCLExecutionContext	create(BytePointer platformName, Pointer platformID, Pointer context, Pointer deviceID) \brief Creates OpenCL execution context OpenCV will check if available OpenCL platform has platformName name, then assign context to OpenCV and call clRetainContext function.
static OpenCLExecutionContext	create(Context context, Device device) \overload
static OpenCLExecutionContext	create(Context context, Device device, Queue queue) \brief Creates OpenCL execution context
static OpenCLExecutionContext	create(String platformName, Pointer platformID, Pointer context, Pointer deviceID)
boolean	empty()
Context	getContext() Get associated ocl::Context
static OpenCLExecutionContext	getCurrent() Get OpenCL execution context of current thread.
static OpenCLExecutionContext	getCurrentRef() Get OpenCL execution context of current thread (can be empty)
Device	getDevice() Get the single default associated ocl::Device
OpenCLExecutionContext	getPointer(long i)
Queue	getQueue() Get the single ocl::Queue that is associated with the ocl::Context and the single default ocl::Device
OpenCLExecutionContext	position(long position)
OpenCLExecutionContext	put(OpenCLExecutionContext arg0)
void	release()
void	setUseOpenCL(boolean flag)
boolean	useOpenCL()

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OpenCLExecutionContext

public OpenCLExecutionContext(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

OpenCLExecutionContext

public OpenCLExecutionContext(long size)

Native array allocator. Access with Pointer.position(long).

OpenCLExecutionContext

public OpenCLExecutionContext()

OpenCLExecutionContext

public OpenCLExecutionContext(@Const @ByRef
                              OpenCLExecutionContext arg0)

Method Detail

position

public OpenCLExecutionContext position(long position)

Overrides:

position in class Pointer

getPointer

public OpenCLExecutionContext getPointer(long i)

Overrides:

getPointer in class Pointer

put

@ByRef
 @Name(value="operator =")
public OpenCLExecutionContext put(@Const @ByRef
                                                                      OpenCLExecutionContext arg0)

getContext

@ByRef
public Context getContext()

Get associated ocl::Context

getDevice

@ByRef
public Device getDevice()

Get the single default associated ocl::Device

getQueue

@ByRef
public Queue getQueue()

Get the single ocl::Queue that is associated with the ocl::Context and the single default ocl::Device

useOpenCL

@Cast(value="bool")
public boolean useOpenCL()

setUseOpenCL

public void setUseOpenCL(@Cast(value="bool")
                         boolean flag)

getCurrent

@ByRef
public static OpenCLExecutionContext getCurrent()

Get OpenCL execution context of current thread. Initialize OpenCL execution context if it is empty - create new - reuse context of the main thread (threadID = 0)

getCurrentRef

@ByRef
public static OpenCLExecutionContext getCurrentRef()

Get OpenCL execution context of current thread (can be empty)

bind

public void bind()

Bind this OpenCL execution context to current thread. Context can't be empty. \note clFinish is not called for queue of previous execution context

cloneWithNewQueue

@ByVal
public OpenCLExecutionContext cloneWithNewQueue(@Const @ByRef
                                                        Queue q)

Creates new execution context with same OpenCV context and device

Parameters:

q - OpenCL queue

cloneWithNewQueue

@ByVal
public OpenCLExecutionContext cloneWithNewQueue()

\overload

create

@ByVal
public static OpenCLExecutionContext create(@StdString
                                                    BytePointer platformName,
                                                    Pointer platformID,
                                                    Pointer context,
                                                    Pointer deviceID)

\brief Creates OpenCL execution context OpenCV will check if available OpenCL platform has platformName name, then assign context to OpenCV and call clRetainContext function. The deviceID device will be used as target device and new command queue will be created. \note Lifetime of passed handles is transferred to OpenCV wrappers on success

Parameters:

platformName - name of OpenCL platform to attach, this string is used to check if platform is available to OpenCV at runtime

platformID - ID of platform attached context was created for (cl_platform_id)

context - OpenCL context to be attached to OpenCV (cl_context)

deviceID - OpenCL device (cl_device_id)

create

@ByVal
public static OpenCLExecutionContext create(@StdString
                                                    String platformName,
                                                    Pointer platformID,
                                                    Pointer context,
                                                    Pointer deviceID)

create

@ByVal
public static OpenCLExecutionContext create(@Const @ByRef
                                                    Context context,
                                                    @Const @ByRef
                                                    Device device,
                                                    @Const @ByRef
                                                    Queue queue)

\brief Creates OpenCL execution context

Parameters:

context - non-empty OpenCL context

device - non-empty OpenCL device (must be a part of context)

queue - non-empty OpenCL queue for provided context and device

create

@ByVal
public static OpenCLExecutionContext create(@Const @ByRef
                                                    Context context,
                                                    @Const @ByRef
                                                    Device device)

\overload

empty

@Cast(value="bool")
public boolean empty()

release

public void release()