C Specification

To retain a sampler object, call the function

// Provided by CL_VERSION_1_0
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

CL_VERSION_1_0, cl_sampler

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

Copyright 2014-2025 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0