org.bytedeco.opencv.opencv_core

Class Kernel

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_core.Kernel

All Implemented Interfaces:

AutoCloseable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Kernel.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
Kernel()
Kernel(BytePointer kname, Program prog)
Kernel(Kernel k)
Kernel(long size) Native array allocator.
Kernel(Pointer p) Pointer cast constructor.
Kernel(String kname, Program prog)
Kernel(String kname, ProgramSource prog, String buildopts, BytePointer errmsg)

Method Summary

Modifier and Type	Method and Description
boolean	compileWorkGroupSize(SizeTPointer wsz)
boolean	create(BytePointer kname, Program prog)
boolean	create(String kname, Program prog)
boolean	create(String kname, ProgramSource prog, String buildopts, BytePointer errmsg)
boolean	empty()
long	localMemSize()
Kernel	position(long position)
long	preferedWorkGroupSizeMultiple()
Pointer	ptr()
Kernel	put(Kernel k)
boolean	run(int dims, SizeTPointer globalsize, SizeTPointer localsize, boolean sync)
boolean	run(int dims, SizeTPointer globalsize, SizeTPointer localsize, boolean sync, Queue q) \brief Run the OpenCL kernel.
long	runProfiling(int dims, SizeTPointer globalsize, SizeTPointer localsize)
long	runProfiling(int dims, SizeTPointer globalsize, SizeTPointer localsize, Queue q) \brief Similar to synchronized run() call with returning of kernel execution time Separate OpenCL command queue may be used (with CL_QUEUE_PROFILING_ENABLE)
boolean	runTask(boolean sync)
boolean	runTask(boolean sync, Queue q)
int	set(int i, Image2D image2D)
int	set(int i, KernelArg arg)
int	set(int i, Pointer value, long sz)
int	set(int i, UMat m)
long	workGroupSize()

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, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

Kernel

public Kernel(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Kernel

public Kernel(long size)

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

Kernel

public Kernel()

Kernel

public Kernel(@Cast(value="const char*")
              BytePointer kname,
              @Const @ByRef
              Program prog)

Kernel

public Kernel(String kname,
              @Const @ByRef
              Program prog)

Kernel

public Kernel(String kname,
              @Const @ByRef
              ProgramSource prog,
              @opencv_core.Str
              String buildopts,
              @opencv_core.Str
              BytePointer errmsg)

Kernel

public Kernel(@Const @ByRef
              Kernel k)

Method Detail

position

public Kernel position(long position)

Overrides:

position in class Pointer

put

@ByRef
 @Name(value="operator =")
public Kernel put(@Const @ByRef
                                                    Kernel k)

empty

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

create

@Cast(value="bool")
public boolean create(@Cast(value="const char*")
                                          BytePointer kname,
                                          @Const @ByRef
                                          Program prog)

create

@Cast(value="bool")
public boolean create(String kname,
                                          @Const @ByRef
                                          Program prog)

create

@Cast(value="bool")
public boolean create(String kname,
                                          @Const @ByRef
                                          ProgramSource prog,
                                          @opencv_core.Str
                                          String buildopts,
                                          @Cast(value={"","cv::String*"}) @opencv_core.Str
                                          BytePointer errmsg)

set

public int set(int i,
               @Const
               Pointer value,
               @Cast(value="size_t")
               long sz)

set

public int set(int i,
               @Const @ByRef
               Image2D image2D)

set

public int set(int i,
               @Const @ByRef
               UMat m)

set

public int set(int i,
               @Const @ByRef
               KernelArg arg)

run

@Cast(value="bool")
public boolean run(int dims,
                                       @Cast(value="size_t*")
                                       SizeTPointer globalsize,
                                       @Cast(value="size_t*")
                                       SizeTPointer localsize,
                                       @Cast(value="bool")
                                       boolean sync,
                                       @Const @ByRef(nullValue="cv::ocl::Queue()")
                                       Queue q)

\brief Run the OpenCL kernel.

Parameters:

dims - the work problem dimensions. It is the length of globalsize and localsize. It can be either 1, 2 or 3.

globalsize - work items for each dimension. It is not the final globalsize passed to OpenCL. Each dimension will be adjusted to the nearest integer divisible by the corresponding value in localsize. If localsize is NULL, it will still be adjusted depending on dims. The adjusted values are greater than or equal to the original values.

localsize - work-group size for each dimension.

sync - specify whether to wait for OpenCL computation to finish before return.

q - command queue

run

@Cast(value="bool")
public boolean run(int dims,
                                       @Cast(value="size_t*")
                                       SizeTPointer globalsize,
                                       @Cast(value="size_t*")
                                       SizeTPointer localsize,
                                       @Cast(value="bool")
                                       boolean sync)

runTask

@Cast(value="bool")
public boolean runTask(@Cast(value="bool")
                                           boolean sync,
                                           @Const @ByRef(nullValue="cv::ocl::Queue()")
                                           Queue q)

runTask

@Cast(value="bool")
public boolean runTask(@Cast(value="bool")
                                           boolean sync)

runProfiling

@Cast(value="int64")
public long runProfiling(int dims,
                                              @Cast(value="size_t*")
                                              SizeTPointer globalsize,
                                              @Cast(value="size_t*")
                                              SizeTPointer localsize,
                                              @Const @ByRef(nullValue="cv::ocl::Queue()")
                                              Queue q)

\brief Similar to synchronized run() call with returning of kernel execution time Separate OpenCL command queue may be used (with CL_QUEUE_PROFILING_ENABLE)

Returns:

Execution time in nanoseconds or negative number on error

runProfiling

@Cast(value="int64")
public long runProfiling(int dims,
                                              @Cast(value="size_t*")
                                              SizeTPointer globalsize,
                                              @Cast(value="size_t*")
                                              SizeTPointer localsize)

workGroupSize

@Cast(value="size_t")
public long workGroupSize()

preferedWorkGroupSizeMultiple

@Cast(value="size_t")
public long preferedWorkGroupSizeMultiple()

compileWorkGroupSize

@Cast(value="bool")
public boolean compileWorkGroupSize(@Cast(value="size_t*")
                                                        SizeTPointer wsz)

localMemSize

@Cast(value="size_t")
public long localMemSize()

ptr

public Pointer ptr()