C Specification

To retain a sampler object, call the function

cl_int clRetainSampler(
    cl_sampler sampler);

Parameters

  • sampler specifies the sampler to be released.

Description

The sampler reference count is incremented. clCreateSamplerWithProperties and clCreateSampler perform an implicit retain.

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

  • CL_​INVALID_​SAMPLER if sampler is not a valid sampler 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.

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.