opencv/modules/ocl/doc/structures_and_functions.rst
Andrey Kamaev 73bbabf207 Eliminate discrepancies between signatures in documentation and OpenCV headers
All errors were found by doc/check_docs2.py
2012-10-18 13:03:12 +04:00

24 lines
643 B
ReStructuredText

Data Structures and Functions
=============================
.. highlight:: cpp
ocl::Info
---------
.. ocv:class:: ocl::Info
this class should be maintained by the user and be passed to getDevice
ocl::getDevice
------------------
Returns the list of devices
.. ocv:function:: int ocl::getDevice( std::vector<Info> & oclinfo, int devicetype=CVCL_DEVICE_TYPE_GPU )
:param oclinfo: Output vector of ``ocl::Info`` structures
:param devicetype: One of ``CVCL_DEVICE_TYPE_GPU``, ``CVCL_DEVICE_TYPE_CPU`` or ``CVCL_DEVICE_TYPE_DEFAULT``.
the function must be called before any other ``cv::ocl`` functions; it initializes ocl runtime.