NAME

       clRetainDevice - Increments the devices reference count.

       cl_int clRetainDevice(cl_device_id device);

NOTES

       Increments the device reference count if device is a valid sub-device created by a call to
       clCreateSubDevices(3clc). If device is a root level device i.e. a cl_device_id returned by
       clGetDeviceIDs(3clc), the device reference count remains unchanged.

ERRORS

       Returns CL_SUCCESS if the function is executed successfully or the device is a root-level
       device. Otherwise, it returns one of the following errors:

       •   CL_INVALID_DEVICE if device is not a valid sub-device created by a call to
           clCreateSubDevices(3clc).

       •   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

       clCreateSubDevices(3clc), clGetDeviceIDs(3clc), clReleaseDevice(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 52, section 4.3 - Partitioning a Device