CLGETSAMPLERINFO(3clc)

✨ CLGETSAMPLERINFO ✨

okay bestie, welcome to the OpenCL Manual page for clGetSamplerInfo 💖 this is the one that spills the tea about a sampler object. no cap.

---

🌸 NAME 🌸

clGetSamplerInfo — returns information about the sampler object. it's giving "tell me everything about this sampler" energy 👑

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 — the sampler you're interrogating, bestie. 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 (but like, as a list, because we're cute like that):
  • 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. 💀 (yes it goes stale instantly, don't @ me, that's just what it is)
  • 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. so like, big enough or else. 👀
• 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. girl is not who she says she is 💀
• 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] — that's the source of truth, periodt.

---

👑 SEE ALSO 👑

clCreateSampler(3clc), clRetainSampler(3clc), clReleaseSampler(3clc)

go read those too, they're all connected fr fr 🧚

---

🌟 AUTHORS 🌟

The Khronos Group — icons, honestly.

---

🎀 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.

yes bestie that's the whole license text, every word, don't skip it 💖

---

⭐ NOTES ⭐

1. OpenCL Specification — page 130, section 5.5.2 - Sampler Object Queries 📖

---

and that's the whole page, bestie!! written by The Khronos Group, from the OpenCL Manual, dated 01/14/2021, CLGETSAMPLERINFO(3clc) — slay, go query some samplers responsibly 💅✨