mirror/opencv
1
0
Fork 0
mirror of https://github.com/opencv/opencv.git synced 2025-06-07 17:44:04 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #20536 from hedgepigdaniel:fix/ocl-context-create-ownership

Browse Source 
docs(core/ocl): clarify ownership of arguments passed into OpenCL related functions

* docs(core/ocl): clarify ownership in OpenCLExecutionContext::create

Although it is technically true that OpenCLExecutionContext::create
calls `clRetainContext` on its context argument, it is misleading
because it does not increase the reference count overall. Clarify that
the ownership of one reference of the passed context and device is
taken.

* docs(core/ocl): document ownership transfer in ocl::Device::fromHandle
This commit is contained in:
Daniel Playfair Cal 2021-08-12 03:58:08 +10:00 committed by GitHub
parent aaca4987c9
commit 4d63a89fa6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
modules/core/include/opencv2/core/ocl.hpp
View File

@ -235,6 +235,10 @@ public:
/**
* @param d OpenCL handle (cl_device_id). clRetainDevice() is called on success.
*
* @note Ownership of the passed device is passed to OpenCV on success.
* The caller should additionally call `clRetainDevice` on it if it intends
* to continue using the device.
*/
static Device fromHandle(void* d);
@ -826,11 +830,13 @@ public:
OpenCLExecutionContext cloneWithNewQueue() const;
/** @brief Creates OpenCL execution context
* 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.
* OpenCV will check if available OpenCL platform has platformName name,
* then assign context to OpenCV.
* The deviceID device will be used as target device and a new command queue will be created.
*
* @note Lifetime of passed handles is transferred to OpenCV wrappers on success
* @note On success, ownership of one reference of the context and device is taken.
* The caller should additionally call `clRetainContext` and/or `clRetainDevice`
* to increase the reference count if it wishes to continue using them.
*
* @param platformName name of OpenCL platform to attach, this string is used to check if platform is available to OpenCV at runtime
* @param platformID ID of platform attached context was created for (cl_platform_id)