opencv/modules/ocl/doc/structures_and_utility_functions.rst

43 lines
1.2 KiB
ReStructuredText
Raw Normal View History

Data Structures and Utility Functions
========================================
.. highlight:: cpp
2013-10-04 00:00:41 +08:00
ocl::getOpenCLPlatforms
-----------------------
Returns the list of OpenCL platforms
2013-10-04 00:00:41 +08:00
.. ocv:function:: int ocl::getOpenCLPlatforms( PlatformsInfo& platforms )
2013-10-04 00:00:41 +08:00
:param platforms: Output variable
ocl::getOpenCLDevices
---------------------
Returns the list of devices
2013-10-04 00:00:41 +08:00
.. ocv:function:: int ocl::getOpenCLDevices( DevicesInfo& devices, int deviceType = CVCL_DEVICE_TYPE_GPU, const PlatformInfo* platform = NULL )
2013-10-04 00:00:41 +08:00
:param devices: Output variable
2013-10-04 00:00:41 +08:00
:param deviceType: Bitmask of ``CVCL_DEVICE_TYPE_GPU``, ``CVCL_DEVICE_TYPE_CPU`` or ``CVCL_DEVICE_TYPE_DEFAULT``.
2013-10-04 00:00:41 +08:00
:param platform: Specifies preferrable platform
ocl::setDevice
2013-10-04 00:00:41 +08:00
--------------
Returns void
2013-10-04 00:00:41 +08:00
.. ocv:function:: void ocl::setDevice( const DeviceInfo* info )
2013-10-04 00:00:41 +08:00
:param info: device info
2013-10-04 00:00:41 +08:00
ocl::setBinaryPath
------------------
Returns void
2013-10-04 00:00:41 +08:00
.. ocv:function:: void ocl::setBinaryPath(const char *path)
:param path: the path of OpenCL kernel binaries
If you call this function and set a valid path, the OCL module will save the compiled kernel to the address in the first time and reload the binary since that. It can save compilation time at the runtime.