OpenCL support

Classes
class	cv::ocl::Device
class	cv::ocl::Context
class	cv::ocl::Platform
class	cv::ocl::Queue
class	cv::ocl::KernelArg
class	cv::ocl::Kernel
class	cv::ocl::Program
class	cv::ocl::ProgramSource
class	cv::ocl::PlatformInfo
class	cv::ocl::Image2D
class	cv::ocl::Timer
class	cv::ocl::OpenCLExecutionContext
class	cv::ocl::OpenCLExecutionContextScope

Enumerations
enum	cv::ocl::OclVectorStrategy { cv::ocl::OCL_VECTOR_OWN = 0 , cv::ocl::OCL_VECTOR_MAX = 1 , cv::ocl::OCL_VECTOR_DEFAULT = OCL_VECTOR_OWN }

Functions
CV_EXPORTS_W bool	cv::ocl::haveOpenCL ()
CV_EXPORTS_W bool	cv::ocl::useOpenCL ()
CV_EXPORTS_W bool	cv::ocl::haveAmdBlas ()
CV_EXPORTS_W bool	cv::ocl::haveAmdFft ()
CV_EXPORTS_W void	cv::ocl::setUseOpenCL (bool flag)
CV_EXPORTS_W void	cv::ocl::finish ()
CV_EXPORTS bool	cv::ocl::haveSVM ()
CV_EXPORTS void	cv::ocl::attachContext (const String &platformName, void *platformID, void *context, void *deviceID)
	Attaches OpenCL context to OpenCV. More...
CV_EXPORTS void	cv::ocl::convertFromBuffer (void *cl_mem_buffer, size_t step, int rows, int cols, int type, UMat &dst)
	Convert OpenCL buffer to UMat. More...
CV_EXPORTS void	cv::ocl::convertFromImage (void *cl_mem_image, UMat &dst)
	Convert OpenCL image2d_t to UMat. More...
void	cv::ocl::initializeContextFromHandle (Context &ctx, void *platform, void *context, void *device)
CV_EXPORTS CV_DEPRECATED const char *	cv::ocl::convertTypeStr (int sdepth, int ddepth, int cn, char *buf)
CV_EXPORTS const char *	cv::ocl::convertTypeStr (int sdepth, int ddepth, int cn, char *buf, size_t buf_size)
CV_EXPORTS const char *	cv::ocl::typeToStr (int t)
CV_EXPORTS const char *	cv::ocl::memopTypeToStr (int t)
CV_EXPORTS const char *	cv::ocl::vecopTypeToStr (int t)
CV_EXPORTS const char *	cv::ocl::getOpenCLErrorString (int errorCode)
CV_EXPORTS String	cv::ocl::kernelToStr (InputArray _kernel, int ddepth=-1, const char *name=NULL)
CV_EXPORTS void	cv::ocl::getPlatfomsInfo (std::vector< PlatformInfo > &platform_info)
CV_EXPORTS int	cv::ocl::predictOptimalVectorWidth (InputArray src1, InputArray src2=noArray(), InputArray src3=noArray(), InputArray src4=noArray(), InputArray src5=noArray(), InputArray src6=noArray(), InputArray src7=noArray(), InputArray src8=noArray(), InputArray src9=noArray(), OclVectorStrategy strat=OCL_VECTOR_DEFAULT)
CV_EXPORTS int	cv::ocl::checkOptimalVectorWidth (const int *vectorWidths, InputArray src1, InputArray src2=noArray(), InputArray src3=noArray(), InputArray src4=noArray(), InputArray src5=noArray(), InputArray src6=noArray(), InputArray src7=noArray(), InputArray src8=noArray(), InputArray src9=noArray(), OclVectorStrategy strat=OCL_VECTOR_DEFAULT)
CV_EXPORTS int	cv::ocl::predictOptimalVectorWidthMax (InputArray src1, InputArray src2=noArray(), InputArray src3=noArray(), InputArray src4=noArray(), InputArray src5=noArray(), InputArray src6=noArray(), InputArray src7=noArray(), InputArray src8=noArray(), InputArray src9=noArray())
CV_EXPORTS void	cv::ocl::buildOptionsAddMatrixDescription (String &buildOptions, const String &name, InputArray _m)
CV_EXPORTS MatAllocator *	cv::ocl::getOpenCLAllocator ()

Variables
class CV_EXPORTS	cv::ocl::Context
class CV_EXPORTS_W_SIMPLE	cv::ocl::Device
class CV_EXPORTS	cv::ocl::Kernel
class CV_EXPORTS	cv::ocl::Program
class CV_EXPORTS	cv::ocl::ProgramSource
class CV_EXPORTS	cv::ocl::Queue
class CV_EXPORTS	cv::ocl::PlatformInfo
class CV_EXPORTS	cv::ocl::Image2D

Detailed Description

Enumeration Type Documentation

OclVectorStrategy

enum cv::ocl::OclVectorStrategy

Enumerator
OCL_VECTOR_OWN
OCL_VECTOR_MAX
OCL_VECTOR_DEFAULT

Function Documentation

attachContext()

CV_EXPORTS void cv::ocl::attachContext	(	const String &	platformName,
		void *	platformID,
		void *	context,
		void *	deviceID
	)

Attaches OpenCL context to OpenCV.

Note

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.

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
context	OpenCL context to be attached to OpenCV
deviceID	ID of device, must be created from attached context

buildOptionsAddMatrixDescription()

CV_EXPORTS void cv::ocl::buildOptionsAddMatrixDescription	(	String &	buildOptions,
		const String &	name,
		InputArray	_m
	)

checkOptimalVectorWidth()

CV_EXPORTS int cv::ocl::checkOptimalVectorWidth	(	const int *	vectorWidths,
		InputArray	src1,
		InputArray	src2 = noArray(),
		InputArray	src3 = noArray(),
		InputArray	src4 = noArray(),
		InputArray	src5 = noArray(),
		InputArray	src6 = noArray(),
		InputArray	src7 = noArray(),
		InputArray	src8 = noArray(),
		InputArray	src9 = noArray(),
		OclVectorStrategy	strat = OCL_VECTOR_DEFAULT
	)

convertFromBuffer()

CV_EXPORTS void cv::ocl::convertFromBuffer	(	void *	cl_mem_buffer,
		size_t	step,
		int	rows,
		int	cols,
		int	type,
		UMat &	dst
	)

Convert OpenCL buffer to UMat.

Note

OpenCL buffer (cl_mem_buffer) should contain 2D image data, compatible with OpenCV. Memory content is not copied from clBuffer to UMat. Instead, buffer handle assigned to UMat and clRetainMemObject is called.

Parameters

cl_mem_buffer	source clBuffer handle
step	num of bytes in single row
rows	number of rows
cols	number of cols
type	OpenCV type of image
dst	destination UMat

convertFromImage()

CV_EXPORTS void cv::ocl::convertFromImage	(	void *	cl_mem_image,
		UMat &	dst
	)

Convert OpenCL image2d_t to UMat.

Note

OpenCL image2d_t (cl_mem_image), should be compatible with OpenCV UMat formats. Memory content is copied from image to UMat with clEnqueueCopyImageToBuffer function.

Parameters

cl_mem_image	source image2d_t handle
dst	destination UMat

convertTypeStr() [1/2]

CV_EXPORTS CV_DEPRECATED const char* cv::ocl::convertTypeStr	(	int	sdepth,
		int	ddepth,
		int	cn,
		char *	buf
	)

convertTypeStr() [2/2]

CV_EXPORTS const char* cv::ocl::convertTypeStr	(	int	sdepth,
		int	ddepth,
		int	cn,
		char *	buf,
		size_t	buf_size
	)

finish()

CV_EXPORTS_W void cv::ocl::finish

(

)

getOpenCLAllocator()

CV_EXPORTS MatAllocator* cv::ocl::getOpenCLAllocator

(

)

getOpenCLErrorString()

CV_EXPORTS const char* cv::ocl::getOpenCLErrorString

(

int

errorCode

)

getPlatfomsInfo()

CV_EXPORTS void cv::ocl::getPlatfomsInfo

(

std::vector< PlatformInfo > &

platform_info

)

haveAmdBlas()

CV_EXPORTS_W bool cv::ocl::haveAmdBlas

(

)

haveAmdFft()

CV_EXPORTS_W bool cv::ocl::haveAmdFft

(

)

haveOpenCL()

CV_EXPORTS_W bool cv::ocl::haveOpenCL

(

)

haveSVM()

CV_EXPORTS bool cv::ocl::haveSVM

(

)

initializeContextFromHandle()

void cv::ocl::initializeContextFromHandle	(	Context &	ctx,
		void *	platform,
		void *	context,
		void *	device
	)

Deprecated:

kernelToStr()

CV_EXPORTS String cv::ocl::kernelToStr	(	InputArray	_kernel,
		int	ddepth = -1,
		const char *	name = NULL
	)

memopTypeToStr()

CV_EXPORTS const char* cv::ocl::memopTypeToStr

(

int

t

)

predictOptimalVectorWidth()

CV_EXPORTS int cv::ocl::predictOptimalVectorWidth	(	InputArray	src1,
		InputArray	src2 = noArray(),
		InputArray	src3 = noArray(),
		InputArray	src4 = noArray(),
		InputArray	src5 = noArray(),
		InputArray	src6 = noArray(),
		InputArray	src7 = noArray(),
		InputArray	src8 = noArray(),
		InputArray	src9 = noArray(),
		OclVectorStrategy	strat = OCL_VECTOR_DEFAULT
	)

predictOptimalVectorWidthMax()

CV_EXPORTS int cv::ocl::predictOptimalVectorWidthMax	(	InputArray	src1,
		InputArray	src2 = noArray(),
		InputArray	src3 = noArray(),
		InputArray	src4 = noArray(),
		InputArray	src5 = noArray(),
		InputArray	src6 = noArray(),
		InputArray	src7 = noArray(),
		InputArray	src8 = noArray(),
		InputArray	src9 = noArray()
	)

setUseOpenCL()

CV_EXPORTS_W void cv::ocl::setUseOpenCL

(

bool

flag

)

typeToStr()

CV_EXPORTS const char* cv::ocl::typeToStr

(

int

t

)

useOpenCL()

CV_EXPORTS_W bool cv::ocl::useOpenCL

(

)

vecopTypeToStr()

CV_EXPORTS const char* cv::ocl::vecopTypeToStr

(

int

t

)

Variable Documentation

Context

class CV_EXPORTS cv::ocl::Context

Device

class CV_EXPORTS_W_SIMPLE cv::ocl::Device

Image2D

class CV_EXPORTS cv::ocl::Image2D

Kernel

class CV_EXPORTS cv::ocl::Kernel

PlatformInfo

class CV_EXPORTS cv::ocl::PlatformInfo

Program

class CV_EXPORTS cv::ocl::Program

ProgramSource

class CV_EXPORTS cv::ocl::ProgramSource

Queue

class CV_EXPORTS cv::ocl::Queue