NAME

       clRetainMemObject - 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]

SEE ALSO

       clCreateBuffer(3clc), clEnqueueCopyBuffer(3clc), clEnqueueReadBuffer(3clc),
       clEnqueueWriteBuffer(3clc), clReleaseMemObject(3clc)

AUTHORS

       The Khronos Group

COPYRIGHT

       Copyright © 2007-2011 The Khronos Group Inc.
       Permission is hereby granted, free of charge, to any person obtaining a copy of this
       software and/or associated documentation files (the "Materials"), to deal in the Materials
       without restriction, including without limitation the rights to use, copy, modify, merge,
       publish, distribute, sublicense, and/or sell copies of the Materials, and to permit
       persons to whom the Materials are furnished to do so, subject to the condition that this
       copyright notice and permission notice shall be included in all copies or substantial
       portions of the Materials.

NOTES

        1. OpenCL Specification
           page 118, section 5.4.1 - Retaining and Releasing Memory Objects