CLENQUEUEMARKERWITHW(3clc)

💅 CLENQUEUEMARKERWITHW(3clc) 💅

okay bestie, welcome to the OpenCL Manual, page CLENQUEUEMARKERWITHW(3clc) ✨ buckle up because we're about to talk about the single most chill little command in the whole queue. no cap.

---

🌸 NAME 🌸

clEnqueueMarkerWithWaitList — enqueues a marker command which waits for either a list of events to complete, or all previously enqueued commands to complete.

literally it's a "wait until all this stuff is done, then I'll tell you" situation. she's patient, she's organized, she ate 💅

---

🎀 SYNOPSIS 🎀

cl_int clEnqueueMarkerWithWaitList(cl_command_queue command_queue,
                                   cl_uint num_events_in_wait_list,
                                   const cl_event *event_wait_list,
                                   cl_event *event);

---

✨ PARAMETERS ✨

• command_queue — a valid command-queue. yes queen, it has to be valid, we do not do invalid queues around here 🙈
• event_wait_list, num_events_in_wait_list — these functions specify events that need to complete before this particular command can be executed.

if event_wait_list is NULL, num_events_in_wait_list must be 0. if event_wait_list is not NULL, the list of events pointed to by event_wait_list must be valid and num_events_in_wait_list must be greater than 0. the events specified in event_wait_list act as synchronization points. the context associated with events in event_wait_list and command_queue must be the same. the memory associated with event_wait_list can be reused or freed after the function returns — she doesn't hold a grudge, she lets you move on 🫶

if event_wait_list is NULL, then this particular command waits until all previous enqueued commands to command_queue have completed.

• event — returns an event object that identifies this particular command. event objects are unique and can be used to identify this marker command later on. event can be NULL, in which case it will not be possible for the application to query the status of this command or queue a wait for this command to complete. if the event_wait_list and the event arguments are not NULL, the event argument should not refer to an element of the event_wait_list array. (no self-referencing, that's giving toxic 💀)

---

🦋 DESCRIPTION 🦋

Enqueues a marker command which waits for either a list of events to complete, or, if the list is empty, it waits for all commands previously enqueued in command_queue to complete before it completes. this command returns an event which can be waited on, i.e. this event can be waited on to insure that all events either in the event_wait_list or all previously enqueued commands, queued before this command to command_queue, have completed.

so basically: she's the friend who holds the group together. "nobody leaves until everyone's done." iconic behavior, honestly 👑

---

🔥 ERRORS 🔥

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

• CL_INVALID_COMMAND_QUEUE if command_queue is not a valid command-queue. 😭
• CL_INVALID_EVENT_WAIT_LIST if event_wait_list is NULL and num_events_in_wait_list > 0, or event_wait_list is not NULL and num_events_in_wait_list is 0, or if event objects in event_wait_list are not valid events. (pick a lane bestie, either you have a list or you don't 💀)
• 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 👑

clWaitForEvents(3clc), clEnqueueBarrierWithWaitList(3clc)

iykyk — go read those next, they're the sibling energy to this one 🧚

---

💖 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.

legal bestie said "share the love, keep the notice" and honestly? valid. 🫶

---

⭐ NOTES ⭐

1. OpenCL Specification, page 186, section 5.10 - Markers, Barriers and Waiting for Events

---

okay that's the whole vibe check ✨ this was brought to you by The Khronos Group, dated 01/14/2021, and it's officially the end of CLENQUEUEMARKERWITHW(3clc) 💅🌸 no cap, go enqueue something iconic bestie 💖🦋🎀