Skip to content

[SYCL][DOC] Update sycl_ext_oneapi_enqueue_barrier with clarifications. #21777

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
slawekptak wants to merge 2 commits into
base: sycl
Choose a base branch
from
Draft

[SYCL][DOC] Update sycl_ext_oneapi_enqueue_barrier with clarifications. #21777

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bbe32f
[SYCL][DOC] Update sycl_ext_oneapi_enqueue_barrier with clarifications.
slawekptak Apr 15, 2026
a89c7eb
Clarify the event state.
slawekptak Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions sycl/doc/extensions/supported/sycl_ext_oneapi_enqueue_barrier.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ void wait();
|========================================
|*Member functions*|*Description*
|`event ext_oneapi_submit_barrier()` | Same effect as submitting a `handler::ext_oneapi_barrier()` within a command group to this `queue`. The returned event enters the `info::event_command_status::complete` state when all events that the barrier is dependent on (implicitly from all previously submitted commands to the same queue) have entered the `info::event_command_status::complete` state.
|`event ext_oneapi_submit_barrier( const std::vector<event> &waitList )` | Same effect as submitting a `handler:ext_oneapi_barrier( const std::vector<event> &waitList )` within a command group to this `queue`. The returned event enters the `info::event_command_status::complete` state when all events that the barrier is dependent on (explicitly from `waitList`) have entered the `info::event_command_status::complete` state.
|`event ext_oneapi_submit_barrier( const std::vector<event> &waitList )` | Same effect as submitting a `handler:ext_oneapi_barrier( const std::vector<event> &waitList )` within a command group to this `queue`. The returned event enters the `info::event_command_status::complete` state when all events that the barrier is dependent on (explicitly from `waitList`) have entered the `info::event_command_status::complete` state. If `waitList` is empty, then the barrier has no effect and the returned event enters the `info::event_command_status::complete` state immediately.
|========================================


Expand Down Expand Up @@ -297,7 +297,7 @@ Barriers can be created by two members of the `handler` class that force synchro
|========================================
|*Member functions*|*Description*
|`void ext_oneapi_barrier()` | Prevents any commands submitted afterward to this queue from executing until all commands previously submitted to this queue have entered the `info::event_command_status::complete` state.
|`void ext_oneapi_barrier( const std::vector<event> &waitList` ) | Prevents any commands submitted afterward to this queue from executing until all events in `waitList` have entered the `info::event_command_status::complete` state. If `waitList` is empty, then the barrier has no effect.
|`void ext_oneapi_barrier( const std::vector<event> &waitList` ) | Prevents any commands submitted afterward to this queue from executing until all events in `waitList` have entered the `info::event_command_status::complete` state. If `waitList` is empty and no explicit dependencies were set using `handler::depends_on()`, then the barrier has no effect and the barrier event enters the `info::event_command_status::complete` state immediately. If `waitList` is empty and dependencies were set using `handler::depends_on()`, then the dependencies are honored and the barrier event enters the `info::event_command_status::complete` state once all of those dependent events have entered the `info::event_command_status::complete` state.
|========================================

== Issues
Expand Down
Loading