CLRETAINEVENT(3clc)

✨ NAME ✨

clRetainEvent — bestie, this one just bumps up the event reference count. That's it. That's the whole job. 💖

cl_int clRetainEvent(cl_event event);

Welcome to the OpenCL Manual, babe. We're doing reference counting today and honestly? It's giving ✨ownership✨.

---

🌸 PARAMETERS 🌸

• event — the event object you're retaining. Like, you're telling the universe "yeah I'm holding onto this one, don't you dare free it yet." 🫶

---

💅 NOTES 💅

Okay so important lil fact: the OpenCL commands that return an event do an implicit retain already. So the runtime's got your back there. No cap. 🎀

---

🔥 ERRORS 🔥

Returns CL_SUCCESS if the function executed successfully, or one of the errors below:

• CL_INVALID_EVENT — if event is not a valid event 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 👀

• clGetEventInfo(3clc)
• clReleaseEvent(3clc)
• clWaitForEvents(3clc)

---

💜 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 184, section 5.9 - Event Objects

---

and that's the whole page bestie, retain responsibly 💅

That was CLRETAINEVENT(3clc) from the OpenCL Manual, brought to you by The Khronos Group, dated 01/14/2021. Go retain something (and remember to release it later, iykyk). 🎀✨