Skip to content

Commit 38d0ee7

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

1 file changed

Lines changed: 52 additions & 45 deletions

File tree

adoc/chapters/programming_interface.adoc

Lines changed: 52 additions & 45 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,44 +8064,53 @@ 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
8077+
[code]#other#.
8078+
8079+
'''
8080+
8081+
.[apidef]#accessor::is_placeholder#
8082+
[source,role=synopsis,id=api:accessors-command-buffer-members-is-placeholder]
80828083
----
80838084
bool is_placeholder() const
80848085
----
8085-
a@ Returns [code]#true# if the accessor is a placeholder. Otherwise returns
8086-
[code]#false#.
80878086

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

80958100
If this is a <<ranged-accessor>>, returns the offset that was specified when the
80968101
accessor was constructed. For other accessors, returns the default constructed
80978102
[code]#id<Dimensions>{}#.
80988103

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

81068115
Returns a [code]#multi_ptr# to the start of this accessor's underlying buffer,
81078116
even if this is a <<ranged-accessor>> whose range does not start at the
@@ -8112,26 +8121,24 @@ _Preconditions_: Must be called within a <<command>>.
81128121

81138122
Deprecated in SYCL 2020. 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
81238127
this is a <<ranged-accessor>> whose range does not start at the beginning of
81248128
the buffer. The return value is unspecified if the accessor is empty.
81258129

81268130
_Preconditions_: Must be called within a <<command>>.
81278131

8128-
a@
8129-
[source]
8132+
'''
8133+
8134+
.[apidef]#accessor::get_multi_ptr#
8135+
[source,role=synopsis,id=api:accessors-command-buffer-members-get-multi-ptr]
81308136
----
81318137
template <access::decorated IsDecorated>
81328138
accessor_ptr<IsDecorated> get_multi_ptr() const noexcept
81338139
----
8134-
a@ Available only when [code]#(AccessTarget == target::device)#.
8140+
8141+
Available only when [code]#(AccessTarget == target::device)#.
81358142

81368143
Returns a [code]#multi_ptr# to the start of this accessor's underlying buffer,
81378144
even if this is a <<ranged-accessor>> whose range does not start at the
@@ -8140,33 +8147,33 @@ empty.
81408147

81418148
_Preconditions_: Must be called within a <<command>>.
81428149

8143-
a@
8144-
[source]
8150+
'''
8151+
8152+
.[apidef]#accessor::operator=#
8153+
[source,role=synopsis,id=api:accessors-command-buffer-members-operator-assign]
81458154
----
8146-
const accessor& operator=(const value_type& other) const
8155+
const accessor& operator=(const value_type& other) const // (1)
8156+
const accessor& operator=(value_type&& other) const // (2)
81478157
----
8148-
a@ Available only when
8149-
[code]#(AccessMode != access_mode::atomic &&
8150-
AccessMode != access_mode::read && Dimensions == 0)#.
8158+
8159+
(1) Available only when
8160+
[code]#(AccessMode != access_mode::atomic &&
8161+
AccessMode != 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
8168+
[code]#(AccessMode != access_mode::atomic &&
8169+
AccessMode != access_mode::read && Dimensions == 0)#.
81648170

81658171
Assignment to the single element that is accessed by this accessor.
81668172

81678173
_Preconditions_: Must be called within a <<command>>.
81688174

8169-
|====
8175+
'''
8176+
81708177

81718178

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

0 commit comments

Comments
 (0)