CLRETAINPROGRAM(3clc)

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

CLRETAINPROGRAM(3clc) 💖

okay bestie, welcome to the OpenCL Manual — yes that OpenCL, the one your GPU is lowkey obsessed with ✨ this page is literally just about bumping a ref count, and honestly? it's giving self-care. let's get into it 🫶

✨ NAME ✨

clRetainProgram — increments the program reference count, no cap 💅

cl_int clRetainProgram(cl_program program);

like. that's it. that's the whole function. you hand it a cl_program and it goes "mine now, keeping it alive" 🎀

📌 NOTES 📌

clCreateProgram does an implicit retain. so when you create a program object, it's already been retained for you — the vibes are already immaculate, you don't gotta do it yourself 🙈

💀 ERRORS 💀

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

  • CL_INVALID_PROGRAM — if program is not a valid program object. bestie that is not a program, that is a vibe and a prayer 😭
  • 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] — go read it, it's iconic 👑

👀 SEE ALSO 👀

(the last one is literally this page. not me linking you back to yourself 💀)

🌸 AUTHORS 🌸

The Khronos Group — the main characters fr fr 🫶

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.

legal text stays legal text bestie, I don't mess with the lawyers 💜

📝 NOTES 📝

  1. OpenCL Specification — page 136, section 5.6.1 - Creating Program Objects

and that's the whole page, bestie!! 🦋 this one came from The Khronos Group, dated 01/14/2021, and it lives under the name CLRETAINPROGRAM(3clc) — go retain something, you absolute legend 💖✨

📦 where this page comes from