CLRELEASESAMPLER(3clc)

📦
version 1.0~svn33624 · 3 versions
, in ubuntu jammy, ubuntu noble

✨ CLRELEASESAMPLER ✨

okay bestie, welcome to the OpenCL Manual 💖 you're reading the page for clReleaseSampler from 3clc, and honestly? it's a short one but it's IMPORTANT, so let's go 🫶

🌸 NAME 🌸

clReleaseSampler — the way it decrements the sampler reference count 💅

🦋 SYNOPSIS 🦋

cl_int clReleaseSampler(cl_sampler sampler);

that's it. that's the whole vibe check. one function, one arg, one cl_int coming back at you ✨

🎀 PARAMETERS 🎀

  • sampler — the sampler you're releasing. (the original text says "specifies the sampler being retained," which is lowkey a typo in the source but we're keeping it fr fr, no cap 🙈)

💜 NOTES 💜

okay so here's the tea ☕ the sampler object gets deleted once two things have happened:

  1. the reference count drops all the way to zero, and
  2. every command queued for execution on the command-queue(s) that use sampler has finished 🏁

so like, don't panic if it's still hanging around for a sec — it's just waiting for its moment, main character energy 👑

🔥 ERRORS 🔥

returns CL_SUCCESS when everything goes off without a hitch ✨ otherwise it hits you with one of these:

  • CL_INVALID_SAMPLER — sampler is not a valid sampler object. it's giving "who is she" 💀
  • CL_OUT_OF_RESOURCES — the OpenCL implementation on the device failed to allocate the resources it needed 😭
  • CL_OUT_OF_HOST_MEMORY — the OpenCL implementation on the host failed to allocate the resources it needed 😭
not me manifesting CL_SUCCESS for you every single time 🕯️

🌈 SPECIFICATION 🌈

OpenCL Specification[1] 📖

⭐ SEE ALSO ⭐

the whole sampler friend group 🫶 go read them too, iykyk

👑 AUTHORS 👑

The Khronos Group 🧚

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 129, section 5.5.1 - Creating Sampler Objects 📚

and that's the whole page bestie!! 🎀 brought to you by The Khronos Group, dated 01/14/2021, on the CLRELEASESAMPLER(3clc) page 💅 go forth and release your samplers responsibly, mwah 😘

📦 where this page comes from