clRetainMemObject3clc
Increments the memory object reference count.
cl_int clRetainMemObject(cl_mem memobj);
Parameters
memobj
A valid memory object.
Notes
clCreateBuffer(3clc), clCreateSubBuffer(3clc), and clCreateImage(3clc), and perform an implicit retain.
After the memobj reference count becomes zero and commands queued for execution on a command-queue(s) that use memobj have finished, the memory object is deleted. If memobj is a buffer object, memobj cannot be deleted until all sub-buffer objects associated with memobj are deleted.
Errors
Returns CL_SUCCESS if the function is executed successfully. Otherwise, it returns one of the following errors:
• CL_INVALID_MEM_OBJECT if memobj is a not a valid memory object (buffer or image object).
• CL_OUT_OF_RESOURCES if there is a failure to allocate resources required by the OpenCL implementation on the device.
• CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host.
Specification
OpenCL Specification[1]
Notes
- 1.
-
OpenCL Specification
page 118, section 5.4.1 - Retaining and Releasing Memory Objects
Releases
5 releases since Debian 8 (Jessie); the text changed 3 times.