CLCREATEPROGRAMWITHS(3clc)

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

💖 CLCREATEPROGRAMWITHS 💖

okay bestie, welcome to the OpenCL manual page for clCreateProgramWithSource, from the OpenCL Manual (that's the 3clc section, iykyk). this one's literally the glow-up moment where your source code becomes a whole program object. let's get into it 🫶

✨ NAME ✨

clCreateProgramWithSource — creates a program object for a context, and loads the source code specified by the text strings in the strings array into the program object. that's it, that's the job, and she does it flawlessly 💅

🌸 SYNOPSIS 🌸

cl_program clCreateProgramWithSource(cl_context context, cl_uint count,
                                     const char **strings,
                                     const size_t *lengths,
                                     cl_int *errcode_ret);

look at that signature. no cap, she's iconic.

🎀 PARAMETERS 🎀

  • context — must be a valid OpenCL context. that's the vibe check, no fake contexts allowed 🙈
  • strings — an array of count pointers to optionally null-terminated character strings that make up the source code. yes, optionally — she's flexible like that ✨
  • lengths — an array with the number of chars in each string (the string length). the deets:
    • if an element in lengths is zero, its accompanying string is null-terminated.
    • if lengths is NULL, all strings in the strings argument are considered null-terminated.
    • any length value passed in that is greater than zero excludes the null terminator in its count — so don't be out here counting the \0, bestie, she said no 💀
  • errcode_ret — returns an appropriate error code. if errcode_ret is NULL, no error code is returned. she's quiet, she's mysterious, she's not gonna tell you what went wrong 🧚

💜 DESCRIPTION 💜

so. this function creates a program object for a context, and loads the source code specified by the text strings in the strings array into the program object. the devices associated with the program object are the devices associated with context — they match, they're a set, they're giving main character energy together 👑

and the source code specified by strings? it's either an OpenCL C program source, a header, or implementation-defined source for custom devices that support an online compiler. so many options and she supports all of them. obsessed. 🌈

🔥 ERRORS 🔥

clCreateProgramWithSource returns a valid non-zero program object and errcode_ret is set to CL_SUCCESS if the program object is created successfully. slay ✅

otherwise? she returns a NULL value with one of the following error values returned in errcode_ret — so pay attention, bestie:

  • CL_INVALID_CONTEXT — if context is not a valid context. fake context detected, blocked 🚫
  • CL_INVALID_VALUE — if count is zero or if strings or any entry in strings is NULL. zero strings? empty? we don't know her 💀
  • CL_OUT_OF_RESOURCES — if there is a failure to allocate resources required by the OpenCL implementation on the device. the device is going through it 😭
  • CL_OUT_OF_HOST_MEMORY — if there is a failure to allocate resources required by the OpenCL implementation on the host. the host is also going through it 😭

🌟 SPECIFICATION 🌟

OpenCL Specification[1] — go read it, it's right there, she's sourced, she's cited, she's academically valid 🎓

🦋 SEE ALSO 🦋

the whole friend group, fr fr:

👑 AUTHORS 👑

The Khronos Group — the icons who wrote this 💖

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.

like, legal said what she said and she ate 💅

📝 NOTES 📝

  1. OpenCL Specification — page 132, section 5.6.1 - Creating Program Objects. page number and all, we keep receipts 🧾✨

and that's the whole page, bestie!! 🎀 source: The Khronos Group, dated 01/14/2021, from the OpenCL Manual — mwah, love you, go create some program objects, periodt 💖✨🦋

📦 where this page comes from