C Specification

To retain a memory object, call the function

cl_int clRetainMemObject(
    cl_mem memobj);

Parameters

  • memobj specifies the memory object to be retained.

Description

The memobj reference count is incremented.

clRetainMemObject returns CL_​SUCCESS if the function is executed successfully. Otherwise, it returns one of the following errors:

  • CL_​INVALID_​MEM_​OBJECT if memobj is 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.

clCreateBuffer, clCreateSubBuffer, clCreateImage, clCreateImage2D, clCreateImage3D and clCreatePipe perform an implicit retain.

See Also

Document Notes

For more information, see the OpenCL Specification

This page is extracted from the OpenCL Specification. Fixes and changes should be made to the Specification, not directly.

Copyright (c) 2014-2020 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.