Merge pull request #550 from VerenaBeckham/verena/item_conversion

Deprecate item's conversion operator to an item with offset (cherry picked from commit 9d39fb3)
KhronosGroup · Nov 7, 2024 · c2aff41 · c2aff41
1 parent f3931cb
commit c2aff41
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/adoc/chapters/programming_interface.adoc b/adoc/chapters/programming_interface.adoc
@@ -11696,8 +11696,11 @@ a@
 [source]
 ----
 operator item<Dimensions, true>() const
+    // Deprecated in SYCL 2020.
 ----
-   a@ Available only when: [code]#WithOffset == false#
+   a@ Deprecated in SYCL 2020.
+
+Available only when: [code]#WithOffset == false#
 
 Returns an [code]#item# representing the same information as the object holds
 but also includes the offset set to 0. This conversion allow users to seamlessly

diff --git a/adoc/headers/item.h b/adoc/headers/item.h
@@ -24,6 +24,7 @@ template <int Dimensions = 1, bool WithOffset = true> class item {
   // only available if WithOffset is true
   id<Dimensions> get_offset() const;
 
+  // Deprecated in SYCL 2020.
   // only available if WithOffset is false
   operator item<Dimensions, true>() const;