C Specification

To return information about a sampler object, call the function

// Provided by CL_VERSION_1_0
cl_int clGetSamplerInfo(
    cl_sampler sampler,
    cl_sampler_info param_name,
    size_t param_value_size,
    void* param_value,
    size_t* param_value_size_ret);

Parameters

  • sampler specifies the sampler being queried.

  • param_name specifies the information to query. The list of supported param_name types and the information returned in param_value by clGetSamplerInfo is described in the Sampler Object Queries table.

  • param_value is a pointer to memory where the appropriate result being queried is returned. If param_value is NULL, it is ignored.

  • param_value_size specifies the size in bytes of memory pointed to by param_value. This size must be greater than or equal to the size of the return type specified in the Sampler Object Queries table. If param_value is NULL, it is ignored.

  • param_value_size_ret returns the actual size in bytes of data being queried by param_name. If param_value_size_ret is NULL, it is ignored.

Description

Table 1. List of supported param_names by clGetSamplerInfo
Sampler Info Return Type Description

CL_SAMPLER_REFERENCE_COUNT [1]

cl_uint

Return the sampler reference count.

CL_SAMPLER_CONTEXT

cl_context

Return the context specified when the sampler is created.

CL_SAMPLER_NORMALIZED_COORDS

cl_bool

Return the normalized coords value associated with sampler.

CL_SAMPLER_ADDRESSING_MODE

cl_addressing_mode

Return the addressing mode value associated with sampler.

CL_SAMPLER_FILTER_MODE

cl_filter_mode

Return the filter mode value associated with sampler.

CL_SAMPLER_PROPERTIES

missing before version 3.0.

cl_sampler_properties[]

Return the properties argument specified in clCreateSamplerWithProperties.

If the properties argument specified in clCreateSamplerWithProperties used to create sampler was not NULL, the implementation must return the values specified in the properties argument in the same order and without including additional properties.

If sampler was created using clCreateSampler, or if the properties argument specified in clCreateSamplerWithProperties was NULL, the implementation must return param_value_size_ret equal to 0, indicating that there are no properties to be returned.

clGetSamplerInfo returns CL_SUCCESS if the function is executed successfully. Otherwise, it returns one of the following errors:

  • CL_INVALID_SAMPLER if sampler is a not a valid sampler object.

  • CL_INVALID_VALUE if param_name is not one of the supported values, or if the size in bytes specified by param_value_size is less than size of the return type specified in the Sampler Object Queries table and param_value is not NULL.

  • 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, cl_sampler_info

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

1. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.