CLCREATEPROGRAMWITHB(3clc)

💖 NAME 💖

clCreateProgramWithBuiltInKernels — bestie, this one makes a program object for a context and yeets all the built-in-kernel info into it. It's giving "let me set you up with the hardware's own special sauce kernels" ✨

cl_program clCreateProgramWithBuiltInKernels(cl_context context,
                                             cl_uint num_devices,
                                             const cl_device_id *device_list,
                                             const char *kernel_names,
                                             cl_int *errcode_ret);

---

🌸 PARAMETERS 🌸

• context — gotta be a valid OpenCL context, no fakes allowed 💅
• num_devices — how many devices are in the device_list. Count them, bestie, we're not guessing 🔢
• device_list — a pointer to a list of devices that live in context. This one is NOT allowed to be a NULL value, periodt. The built-in kernels get loaded for exactly the devices in this list. The devices tied to your program object will be the list you pass here, and every single one of them must be a device associated with context — no random devices sneaking in from other contexts, we see you 👀
• kernel_names — a semi-colon separated list of built-in kernel names. Like a lil playlist but for kernels 🎀

---

🔥 ERRORS 🔥

If everything goes slay, you get a valid non-zero program object back and errcode_ret gets set to CL_SUCCESS. Otherwise it's a NULL return and errcode_ret carries one of these lil gremlins:

• CL_INVALID_CONTEXT if context is not a valid context 🙈
• CL_INVALID_VALUE if device_list is NULL or num_devices is zero 💀
• CL_INVALID_VALUE if kernel_names is NULL, or kernel_names contains a kernel name that none of the devices in device_list support. Yeah, that one hurts 😭
• CL_INVALID_DEVICE if the devices listed in device_list are not in the list of devices associated with context — caught lacking fr fr
• CL_OUT_OF_RESOURCES if there's a failure to allocate the resources the OpenCL implementation needs on the device 🫠
• CL_OUT_OF_HOST_MEMORY if there's a failure to allocate the resources the OpenCL implementation needs on the host 🫠

---

📜 SPECIFICATION 📜

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

---

👀 SEE ALSO 👀

clCreateProgramWithSource(3clc), clReleaseProgram(3clc), clRetainProgram(3clc), classDiagram(3clc)

---

👑 AUTHORS 👑

The Khronos Group — icons only 💜

---

🎀 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 above copyright notice and this permission notice shall be included in all copies or substantial portions of the Materials. That's the deal, no cap 🫶

---

🦋 NOTES 🦋

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

---

okay that's the whole page bestie, you ate 💅 this was CLCREATEPROGRAMWITHB(3clc) from the OpenCL Manual, brought to you by The Khronos Group, dated 01/14/2021. stan the man page, mwah 😘