Skip to content

Commit 12bed31

Browse files
committed
Refactoring table sec:accessors-command-buffer-members
1 parent 7c1f7b9 commit 12bed31

1 file changed

Lines changed: 60 additions & 54 deletions

File tree

adoc/chapters/programming_interface.adoc

Lines changed: 60 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -7762,7 +7762,7 @@ The member types are listed in <<table.accessors.common.types>> and
77627762
<<table.accessors.command.buffer.types>>.
77637763
The constructors are listed in <<table.accessors.command.buffer.constructors>>,
77647764
and the member functions are listed in <<table.accessors.common.members>> and
7765-
<<table.accessors.command.buffer.members>>.
7765+
<<sec:accessors-command-buffer-members>>.
77667766

77677767
The additional common special member functions and common member functions are
77687768
listed in <<sec:reference-semantics>> in
@@ -8064,109 +8064,115 @@ the sum of [code]#accessRange# and [code]#accessOffset# exceeds the range of
80648064
|====
80658065

80668066

8067-
[[table.accessors.command.buffer.members]]
8068-
.Member functions of the [code]#accessor# class
8069-
[width="100%",options="header",separator="@",cols="65%,35%"]
8070-
|====
8071-
@ Member function @ Description
8072-
a@
8073-
[source]
8067+
[[sec:accessors-command-buffer-members]]
8068+
====== Member functions of the [code]#accessor# class
8069+
8070+
.[apidef]#accessor::swap#
8071+
[source,role=synopsis,id=api:accessors-command-buffer-members-swap]
80748072
----
80758073
void swap(accessor& other);
80768074
----
8077-
a@ Swaps the contents of the current accessor with the contents of
8078-
[code]#other#.
80798075

8080-
a@
8081-
[source]
8076+
Swaps the contents of the current accessor with the contents of [code]#other#.
8077+
8078+
'''
8079+
8080+
.[apidef]#accessor::is_placeholder#
8081+
[source,role=synopsis,id=api:accessors-command-buffer-members-is-placeholder]
80828082
----
80838083
bool is_placeholder() const
80848084
----
8085-
a@ Returns [code]#true# if the accessor is a placeholder. Otherwise returns
8086-
[code]#false#.
80878085

8088-
a@
8089-
[source]
8086+
Returns [code]#true# if the accessor is a placeholder.
8087+
Otherwise returns [code]#false#.
8088+
8089+
'''
8090+
8091+
.[apidef]#accessor::get_offset#
8092+
[source,role=synopsis,id=api:accessors-command-buffer-members-get-offset]
80908093
----
80918094
id<Dimensions> get_offset() const
80928095
----
8093-
a@ Available only when [code]#(Dimensions > 0)#.
8096+
8097+
Available only when [code]#(Dimensions > 0)#.
80948098

80958099
If this is a <<ranged-accessor>>, returns the offset that was specified when the
8096-
accessor was constructed. For other accessors, returns the default constructed
8097-
[code]#id<Dimensions>{}#.
8100+
accessor was constructed.
8101+
For other accessors, returns the default constructed [code]#id<Dimensions>{}#.
80988102

8099-
a@
8100-
[source]
8103+
'''
8104+
8105+
.[apidef]#accessor::get_pointer#
8106+
[source,role=synopsis,id=api:accessors-command-buffer-members-get-pointer]
81018107
----
8102-
global_ptr<value_type> get_pointer() const noexcept
8108+
global_ptr<value_type> get_pointer() const noexcept // (1)
8109+
std::add_pointer_t<value_type> get_pointer() const noexcept // (2)
81038110
----
8104-
a@ Available only when [code]#(AccessTarget == target::device)#.
8111+
8112+
(1) Available only when [code]#(AccessTarget == target::device)#.
81058113

81068114
Returns a [code]#multi_ptr# to the start of this accessor's underlying buffer,
81078115
even if this is a <<ranged-accessor>> whose range does not start at the
8108-
beginning of the buffer. The return value is unspecified if the accessor is
8109-
empty.
8116+
beginning of the buffer.
8117+
The return value is unspecified if the accessor is empty.
81108118

81118119
_Preconditions_: Must be called within a <<command>>.
81128120

8113-
Deprecated in SYCL 2020. Use [code]#get_multi_ptr# instead.
8121+
Deprecated in SYCL 2020.
8122+
Use [code]#get_multi_ptr# instead.
81148123

8115-
a@
8116-
[source]
8117-
----
8118-
std::add_pointer_t<value_type> get_pointer() const noexcept
8119-
----
8120-
a@ Available only when [code]#(AccessTarget == target::host_task)#.
8124+
(2) Available only when [code]#(AccessTarget == target::host_task)#.
81218125

81228126
Returns a pointer to the start of this accessor's underlying buffer, even if
8123-
this is a <<ranged-accessor>> whose range does not start at the beginning of
8124-
the buffer. The return value is unspecified if the accessor is empty.
8127+
this is a <<ranged-accessor>> whose range does not start at the beginning of the
8128+
buffer.
8129+
The return value is unspecified if the accessor is empty.
81258130

81268131
_Preconditions_: Must be called within a <<command>>.
81278132

8128-
a@
8129-
[source]
8133+
'''
8134+
8135+
.[apidef]#accessor::get_multi_ptr#
8136+
[source,role=synopsis,id=api:accessors-command-buffer-members-get-multi-ptr]
81308137
----
81318138
template <access::decorated IsDecorated>
81328139
accessor_ptr<IsDecorated> get_multi_ptr() const noexcept
81338140
----
8134-
a@ Available only when [code]#(AccessTarget == target::device)#.
8141+
8142+
Available only when [code]#(AccessTarget == target::device)#.
81358143

81368144
Returns a [code]#multi_ptr# to the start of this accessor's underlying buffer,
81378145
even if this is a <<ranged-accessor>> whose range does not start at the
8138-
beginning of the buffer. The return value is unspecified if the accessor is
8139-
empty.
8146+
beginning of the buffer.
8147+
The return value is unspecified if the accessor is empty.
81408148

81418149
_Preconditions_: Must be called within a <<command>>.
81428150

8143-
a@
8144-
[source]
8151+
'''
8152+
8153+
.[apidef]#accessor::operator=#
8154+
[source,role=synopsis,id=api:accessors-command-buffer-members-operator-assign]
81458155
----
8146-
const accessor& operator=(const value_type& other) const
8156+
const accessor& operator=(const value_type& other) const // (1)
8157+
const accessor& operator=(value_type&& other) const // (2)
81478158
----
8148-
a@ Available only when
8149-
[code]#(AccessMode != access_mode::atomic &&
8150-
AccessMode != access_mode::read && Dimensions == 0)#.
8159+
8160+
(1) Available only when [code]#(AccessMode != access_mode::atomic && AccessMode
8161+
!= access_mode::read && Dimensions == 0)#.
81518162

81528163
Assignment to the single element that is accessed by this accessor.
81538164

81548165
_Preconditions_: Must be called within a <<command>>.
81558166

8156-
a@
8157-
[source]
8158-
----
8159-
const accessor& operator=(value_type&& other) const
8160-
----
8161-
a@ Available only when
8162-
[code]#(AccessMode != access_mode::atomic &&
8163-
AccessMode != access_mode::read && Dimensions == 0)#.
8167+
(2) Available only when [code]#(AccessMode != access_mode::atomic && AccessMode
8168+
!= access_mode::read && Dimensions == 0)#.
81648169

81658170
Assignment to the single element that is accessed by this accessor.
81668171

81678172
_Preconditions_: Must be called within a <<command>>.
81688173

8169-
|====
8174+
'''
8175+
81708176

81718177

81728178
[[sec:accessor.command.buffer.tags]]

0 commit comments

Comments
 (0)