From 12bed318af8314ebcf6a2a6c68815e1795be0782 Mon Sep 17 00:00:00 2001 From: Thomas Applencourt Date: Thu, 5 Feb 2026 15:14:26 -0600 Subject: [PATCH 1/4] Refactoring table sec:accessors-command-buffer-members --- adoc/chapters/programming_interface.adoc | 114 ++++++++++++----------- 1 file changed, 60 insertions(+), 54 deletions(-) diff --git a/adoc/chapters/programming_interface.adoc b/adoc/chapters/programming_interface.adoc index af808c6cb..4da9299ae 100644 --- a/adoc/chapters/programming_interface.adoc +++ b/adoc/chapters/programming_interface.adoc @@ -7762,7 +7762,7 @@ The member types are listed in <> and <>. The constructors are listed in <>, and the member functions are listed in <> and -<>. +<>. The additional common special member functions and common member functions are listed in <> in @@ -8064,109 +8064,115 @@ the sum of [code]#accessRange# and [code]#accessOffset# exceeds the range of |==== -[[table.accessors.command.buffer.members]] -.Member functions of the [code]#accessor# class -[width="100%",options="header",separator="@",cols="65%,35%"] -|==== -@ Member function @ Description -a@ -[source] +[[sec:accessors-command-buffer-members]] +====== Member functions of the [code]#accessor# class + +.[apidef]#accessor::swap# +[source,role=synopsis,id=api:accessors-command-buffer-members-swap] ---- void swap(accessor& other); ---- - a@ Swaps the contents of the current accessor with the contents of - [code]#other#. -a@ -[source] +Swaps the contents of the current accessor with the contents of [code]#other#. + +''' + +.[apidef]#accessor::is_placeholder# +[source,role=synopsis,id=api:accessors-command-buffer-members-is-placeholder] ---- bool is_placeholder() const ---- - a@ Returns [code]#true# if the accessor is a placeholder. Otherwise returns - [code]#false#. -a@ -[source] +Returns [code]#true# if the accessor is a placeholder. +Otherwise returns [code]#false#. + +''' + +.[apidef]#accessor::get_offset# +[source,role=synopsis,id=api:accessors-command-buffer-members-get-offset] ---- id get_offset() const ---- - a@ Available only when [code]#(Dimensions > 0)#. + +Available only when [code]#(Dimensions > 0)#. If this is a <>, returns the offset that was specified when the -accessor was constructed. For other accessors, returns the default constructed -[code]#id{}#. +accessor was constructed. +For other accessors, returns the default constructed [code]#id{}#. -a@ -[source] +''' + +.[apidef]#accessor::get_pointer# +[source,role=synopsis,id=api:accessors-command-buffer-members-get-pointer] ---- -global_ptr get_pointer() const noexcept +global_ptr get_pointer() const noexcept // (1) +std::add_pointer_t get_pointer() const noexcept // (2) ---- - a@ Available only when [code]#(AccessTarget == target::device)#. + +(1) Available only when [code]#(AccessTarget == target::device)#. Returns a [code]#multi_ptr# to the start of this accessor's underlying buffer, even if this is a <> whose range does not start at the -beginning of the buffer. The return value is unspecified if the accessor is -empty. +beginning of the buffer. +The return value is unspecified if the accessor is empty. _Preconditions_: Must be called within a <>. -Deprecated in SYCL 2020. Use [code]#get_multi_ptr# instead. +Deprecated in SYCL 2020. +Use [code]#get_multi_ptr# instead. -a@ -[source] ----- -std::add_pointer_t get_pointer() const noexcept ----- - a@ Available only when [code]#(AccessTarget == target::host_task)#. +(2) Available only when [code]#(AccessTarget == target::host_task)#. Returns a pointer to the start of this accessor's underlying buffer, even if -this is a <> whose range does not start at the beginning of -the buffer. The return value is unspecified if the accessor is empty. +this is a <> whose range does not start at the beginning of the +buffer. +The return value is unspecified if the accessor is empty. _Preconditions_: Must be called within a <>. -a@ -[source] +''' + +.[apidef]#accessor::get_multi_ptr# +[source,role=synopsis,id=api:accessors-command-buffer-members-get-multi-ptr] ---- template accessor_ptr get_multi_ptr() const noexcept ---- - a@ Available only when [code]#(AccessTarget == target::device)#. + +Available only when [code]#(AccessTarget == target::device)#. Returns a [code]#multi_ptr# to the start of this accessor's underlying buffer, even if this is a <> whose range does not start at the -beginning of the buffer. The return value is unspecified if the accessor is -empty. +beginning of the buffer. +The return value is unspecified if the accessor is empty. _Preconditions_: Must be called within a <>. -a@ -[source] +''' + +.[apidef]#accessor::operator=# +[source,role=synopsis,id=api:accessors-command-buffer-members-operator-assign] ---- -const accessor& operator=(const value_type& other) const +const accessor& operator=(const value_type& other) const // (1) +const accessor& operator=(value_type&& other) const // (2) ---- - a@ Available only when - [code]#(AccessMode != access_mode::atomic && - AccessMode != access_mode::read && Dimensions == 0)#. + +(1) Available only when [code]#(AccessMode != access_mode::atomic && AccessMode +!= access_mode::read && Dimensions == 0)#. Assignment to the single element that is accessed by this accessor. _Preconditions_: Must be called within a <>. -a@ -[source] ----- -const accessor& operator=(value_type&& other) const ----- - a@ Available only when - [code]#(AccessMode != access_mode::atomic && - AccessMode != access_mode::read && Dimensions == 0)#. +(2) Available only when [code]#(AccessMode != access_mode::atomic && AccessMode +!= access_mode::read && Dimensions == 0)#. Assignment to the single element that is accessed by this accessor. _Preconditions_: Must be called within a <>. -|==== +''' + [[sec:accessor.command.buffer.tags]] From 2f3289d4821f30dfce38fdd98b502a68b84d0400 Mon Sep 17 00:00:00 2001 From: tapplencourt Date: Fri, 13 Feb 2026 21:56:09 +0000 Subject: [PATCH 2/4] better id name --- adoc/chapters/programming_interface.adoc | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/adoc/chapters/programming_interface.adoc b/adoc/chapters/programming_interface.adoc index 4da9299ae..8d1ea619a 100644 --- a/adoc/chapters/programming_interface.adoc +++ b/adoc/chapters/programming_interface.adoc @@ -8068,7 +8068,7 @@ the sum of [code]#accessRange# and [code]#accessOffset# exceeds the range of ====== Member functions of the [code]#accessor# class .[apidef]#accessor::swap# -[source,role=synopsis,id=api:accessors-command-buffer-members-swap] +[source,role=synopsis,id=api:accessor-swap] ---- void swap(accessor& other); ---- @@ -8078,7 +8078,7 @@ Swaps the contents of the current accessor with the contents of [code]#other#. ''' .[apidef]#accessor::is_placeholder# -[source,role=synopsis,id=api:accessors-command-buffer-members-is-placeholder] +[source,role=synopsis,id=api:accessor-is-placeholder] ---- bool is_placeholder() const ---- @@ -8089,7 +8089,7 @@ Otherwise returns [code]#false#. ''' .[apidef]#accessor::get_offset# -[source,role=synopsis,id=api:accessors-command-buffer-members-get-offset] +[source,role=synopsis,id=api:accessor-get-offset] ---- id get_offset() const ---- @@ -8103,10 +8103,11 @@ For other accessors, returns the default constructed [code]#id{}#. ''' .[apidef]#accessor::get_pointer# -[source,role=synopsis,id=api:accessors-command-buffer-members-get-pointer] +[source,role=synopsis,id=api:accessor-get-pointer] ---- -global_ptr get_pointer() const noexcept // (1) -std::add_pointer_t get_pointer() const noexcept // (2) +global_ptr get_pointer() const noexcept (1) + +std::add_pointer_t get_pointer() const noexcept (2) ---- (1) Available only when [code]#(AccessTarget == target::device)#. @@ -8133,7 +8134,7 @@ _Preconditions_: Must be called within a <>. ''' .[apidef]#accessor::get_multi_ptr# -[source,role=synopsis,id=api:accessors-command-buffer-members-get-multi-ptr] +[source,role=synopsis,id=api:accessor-get-multi-ptr] ---- template accessor_ptr get_multi_ptr() const noexcept @@ -8151,10 +8152,11 @@ _Preconditions_: Must be called within a <>. ''' .[apidef]#accessor::operator=# -[source,role=synopsis,id=api:accessors-command-buffer-members-operator-assign] +[source,role=synopsis,id=api:accessor-operator-assign] ---- -const accessor& operator=(const value_type& other) const // (1) -const accessor& operator=(value_type&& other) const // (2) +const accessor& operator=(const value_type& other) const (1) + +const accessor& operator=(value_type&& other) const (2) ---- (1) Available only when [code]#(AccessMode != access_mode::atomic && AccessMode @@ -8174,7 +8176,6 @@ _Preconditions_: Must be called within a <>. ''' - [[sec:accessor.command.buffer.tags]] ===== Deduction tags for buffer command accessors From a824e7a664ca3dcd163aa710498a519cff2c3d7d Mon Sep 17 00:00:00 2001 From: tapplencourt Date: Fri, 13 Feb 2026 21:58:50 +0000 Subject: [PATCH 3/4] only one space --- adoc/chapters/programming_interface.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/adoc/chapters/programming_interface.adoc b/adoc/chapters/programming_interface.adoc index 8d1ea619a..2712c0f3f 100644 --- a/adoc/chapters/programming_interface.adoc +++ b/adoc/chapters/programming_interface.adoc @@ -8105,9 +8105,9 @@ For other accessors, returns the default constructed [code]#id{}#. .[apidef]#accessor::get_pointer# [source,role=synopsis,id=api:accessor-get-pointer] ---- -global_ptr get_pointer() const noexcept (1) +global_ptr get_pointer() const noexcept (1) -std::add_pointer_t get_pointer() const noexcept (2) +std::add_pointer_t get_pointer() const noexcept (2) ---- (1) Available only when [code]#(AccessTarget == target::device)#. @@ -8154,9 +8154,9 @@ _Preconditions_: Must be called within a <>. .[apidef]#accessor::operator=# [source,role=synopsis,id=api:accessor-operator-assign] ---- -const accessor& operator=(const value_type& other) const (1) +const accessor& operator=(const value_type& other) const (1) -const accessor& operator=(value_type&& other) const (2) +const accessor& operator=(value_type&& other) const (2) ---- (1) Available only when [code]#(AccessMode != access_mode::atomic && AccessMode From 0f6f8f5446e17da338ab3e6556b5afef5c05a221 Mon Sep 17 00:00:00 2001 From: tapplencourt Date: Fri, 13 Feb 2026 22:10:56 +0000 Subject: [PATCH 4/4] Fix name of section --- adoc/chapters/programming_interface.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adoc/chapters/programming_interface.adoc b/adoc/chapters/programming_interface.adoc index 2712c0f3f..1e05c3951 100644 --- a/adoc/chapters/programming_interface.adoc +++ b/adoc/chapters/programming_interface.adoc @@ -8065,7 +8065,7 @@ the sum of [code]#accessRange# and [code]#accessOffset# exceeds the range of [[sec:accessors-command-buffer-members]] -====== Member functions of the [code]#accessor# class +====== Member functions .[apidef]#accessor::swap# [source,role=synopsis,id=api:accessor-swap]