GET_LOCAL_ID(3clc)

💖 GET_LOCAL_ID 💖

okay bestie, this is a page from the OpenCL Manual, and it's the get_local_id one. it lives in section 3clc. let's get into it 🫶

✨ NAME ✨

get_local_id — Returns the unique local work-item ID. no cap, that's literally the whole job 💅

and the signature, verbatim, don't @ me:

size_t get_local_id(uint dimindx);

🌸 DESCRIPTION 🌸

so. get_local_id returns the unique local work-item ID — meaning a work-item within a specific work-group — for the dimension identified by dimindx. that's the tea ☕

valid values of dimindx are 0 to get_work_dim(3clc)() - 1. and if you pass literally anything else for dimindx? it just returns 0. like, it's not gonna yell at you, it's just gonna hand you a zero and move on 😭

also, for clEnqueueTask(3clc), this returns 0. so if that's your vibe, expect a zero, bestie 🎀

📜 SPECIFICATION 📜

OpenCL Specification[1] ✨

👀 SEE ALSO 👀

• workItemFunctions(3clc)
• clEnqueueNDRangeKernel(3clc)
• clEnqueueTask(3clc)

👑 AUTHORS 👑

The Khronos Group 💜 (icons, fr fr)

🌈 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 conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Materials.

---

📝 NOTES 📝

1. OpenCL Specification page 242, section 6.12.1 - Work-Item Functions

---

and that's the whole page, babe. this was brought to you by The Khronos Group, dated 01/14/2021, under the name GET_LOCAL_ID(3clc). slay, go read the spec, periodt 💅✨🦋