CLRELEASEDEVICE(3clc)

✨ CLRELEASEDEVICE(3clc) ✨

okay bestie, we're in the OpenCL Manual today and this one is a whole mood: it's the lil function that says "you can let go now 💅" to a sub-device.

🌸 NAME 🌸

clReleaseDevice — decrements the device reference count. that's it, that's the whole job, and honestly? iconic for it.

cl_int clReleaseDevice(cl_device_id device);

---

🫶 NOTES 🫶

so here's the tea ☕ — if device is a valid sub-device that came from a call to clCreateSubDevices(3clc), the device reference count goes down by one. bye bestie 👋

but plot twist: if device is a root level device — like, a cl_device_id that clGetDeviceIDs(3clc) handed you — then the device reference count stays exactly the same. nothing happens. no cap. it's giving "you can't fire me, I quit" energy. 💀

and once the device reference count hits zero, and all the objects attached to device (command-queues and friends, you know the type 🎀) are released too, then the device object itself gets deleted. gone. poof. ✨

---

💅 ERRORS 💅

returns CL_SUCCESS if the function executed successfully, slay. otherwise it hands you one of these lil guys:

• CL_INVALID_DEVICE — device is not a valid sub-device created by a call to clCreateSubDevices(3clc). yeah. rude. 🙈
• CL_OUT_OF_RESOURCES — there was a failure to allocate resources required by the OpenCL implementation on the device. 😭
• CL_OUT_OF_HOST_MEMORY — there was a failure to allocate resources required by the OpenCL implementation on the host. also 😭

---

🌈 SPECIFICATION 🌈

OpenCL Specification[1] — the source of truth, the blueprint, the moment 👑

---

⭐ SEE ALSO ⭐

• clCreateSubDevices(3clc)
• clGetDeviceIDs(3clc)
• clRetainDevice(3clc)

(the friend group 🫂 — retain and release are literally the duo of the century)

---

👑 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 following condition:

the condition being that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials. periodt. 📜

---

💖 NOTES 💖

1. OpenCL Specification — page 52, section 4.3 - Partitioning a Device 📖

---

okay that's the whole page, we ate and left no crumbs 🍓

sign-off time: this was brought to you by The Khronos Group, dated 01/14/2021, for the page CLRELEASEDEVICE(3clc) — go release your sub-devices responsibly, mwah 💋🦋