Class cv::ocl::Kernel#

#include <opencv2/core/ocl.hpp>

Collaboration diagram for cv::ocl::Kernel:

Examples#

Examples: samples/cpp/tutorial_code/ImgProc/Morphology_1.cpp, samples/cpp/tutorial_code/ImgProc/Morphology_2.cpp, and samples/python/snippets/laplace.py.

Constructor & Destructor Documentation#

Kernel()#

cv::ocl::Kernel::Kernel()

Kernel()#

cv::ocl::Kernel::Kernel(
const char * kname,
const Program & prog )

Kernel()#

cv::ocl::Kernel::Kernel(
const char * kname,
const ProgramSource & prog,
const String & buildopts = String(),
String * errmsg = 0 )

Kernel()#

cv::ocl::Kernel::Kernel(const Kernel & k)

Kernel()#

cv::ocl::Kernel::Kernel(Kernel && k)

~Kernel()#

cv::ocl::Kernel::~Kernel()

Member Function Documentation#

args()#

template<typename... _Tps>
Kernel & cv::ocl::Kernel::args(const _Tps &… kernel_args)

Setup OpenCL Kernel arguments. Avoid direct using of set(i, …) methods.

bool ok = kernel
    .args(
        srcUMat, dstUMat,
        (float)some_float_param
    ).run(ndims, globalSize, localSize);
if (!ok) return false;

compileWorkGroupSize()#

bool cv::ocl::Kernel::compileWorkGroupSize(size_t[] wsz)

create()#

bool cv::ocl::Kernel::create(
const char * kname,
const Program & prog )

create()#

bool cv::ocl::Kernel::create(
const char * kname,
const ProgramSource & prog,
const String & buildopts,
String * errmsg = 0 )

empty()#

bool cv::ocl::Kernel::empty()

localMemSize()#

size_t cv::ocl::Kernel::localMemSize()

operator=()#

Kernel & cv::ocl::Kernel::operator=(const Kernel & k)

operator=()#

Kernel & cv::ocl::Kernel::operator=(Kernel && k)

preferedWorkGroupSizeMultiple()#

size_t cv::ocl::Kernel::preferedWorkGroupSizeMultiple()

ptr()#

void * cv::ocl::Kernel::ptr()

run()#

bool cv::ocl::Kernel::run(
int dims,
size_t[] globalsize,
size_t[] localsize,
bool sync,
const Queue & q = Queue() )

Run the OpenCL kernel (globalsize value may be adjusted)

Note

Use run_() if your kernel code doesn’t support adjusted globalsize.

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_()#

bool cv::ocl::Kernel::run_(
int dims,
size_t[] globalsize,
size_t[] localsize,
bool sync,
const Queue & q = Queue() )

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. This value is passed to OpenCL without changes.
localsize — work-group size for each dimension.
sync — specify whether to wait for OpenCL computation to finish before return.
q — command queue

runProfiling()#

int64 cv::ocl::Kernel::runProfiling(
int dims,
size_t[] globalsize,
size_t[] localsize,
const Queue & q = Queue() )

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

runTask()#

bool cv::ocl::Kernel::runTask(
bool sync,
const Queue & q = Queue() )

set()#

template<typename _Tp>
int cv::ocl::Kernel::set(
int i,
const _Tp & value )

set()#

int cv::ocl::Kernel::set(
int i,
const Image2D & image2D )

set()#

int cv::ocl::Kernel::set(
int i,
const KernelArg & arg )

set()#

int cv::ocl::Kernel::set(
int i,
const UMat & m )

set()#

int cv::ocl::Kernel::set(
int i,
const void * value,
size_t sz )

workGroupSize()#

size_t cv::ocl::Kernel::workGroupSize()

set_args_()#

template<typename _Tp0>
int cv::ocl::Kernel::set_args_(
int i,
const _Tp0 & a0 )

set_args_()#

template<typename _Tp0, typename... _Tps>
int cv::ocl::Kernel::set_args_(
int i,
const _Tp0 & a0,
const _Tps &… rest_args )

Here is the call graph for this function:

Member Data Documentation#

p#

Impl * cv::ocl::Kernel::p

Source file#

The documentation for this class was generated from the following file:

opencv2/core/ocl.hpp