---
name: "clGetSamplerInfo"
section: "3clc"
platform: "linux"
package: "opencl-1.2-man-doc"
version: "1.0~svn33624-5.1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/clGetSamplerInfo"
---

# clGetSamplerInfo(3clc)

Returns information about the sampler object.

## NAME

clGetSamplerInfo - Returns information about the sampler object.

##

**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 table below.

| | |
| --- | --- |
| **cl\_sampler\_info** | **Return Type and Info. returned in *param\_value*** |
| **CL\_SAMPLER\_REFERENCE\_COUNT** | Return type: cl\_uint Return the *sampler* reference count. 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. |
| **CL\_SAMPLER\_CONTEXT** | Return type: cl\_context Return the context specified when the sampler is created. |
| **CL\_SAMPLER\_NORMALIZED\_COORDS** | Return type: cl\_bool Return the normalized coords value associated with *sampler*. |
| **CL\_SAMPLER\_ADDRESSING\_MODE** | Return type: cl\_addressing\_mode Return the addressing mode value associated with *sampler*. |
| **CL\_SAMPLER\_FILTER\_MODE** | Return type: cl\_filter\_mode Return the filter mode value associated with *sampler*. |

*param\_value*

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 ≥ size of return type as described in the table above.

 *param\_value\_size\_ret*

Returns the actual size in bytes of data copied to *param\_value*. If *param\_value\_size\_ret* is NULL, it is ignored.

## ERRORS

Returns CL\_SUCCESS if the function is executed successfully. Otherwise, it returns one of the following errors:

• CL\_INVALID\_VALUE if *param\_name* is not valid, or if size in bytes specified by *param\_value\_size* is \< size of return type as described in the table above and *param\_value* is not NULL

• CL\_INVALID\_SAMPLER if   *sampler* is a 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.

## SPECIFICATION

**OpenCL Specification**\[1\]

## SEE ALSO

[**clCreateSampler**(3clc)](/clCreateSampler/3clc.md), [**clRetainSampler**(3clc)](/clRetainSampler/3clc.md), [**clReleaseSampler**(3clc)](/clReleaseSampler/3clc.md)

## 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 130, section 5.5.2 - Sampler Object Queries