Skip to content

Commit 73d88dc

Browse files
[SYCL][DOC] Tweaks and fixes for bindless images spec (#19840)
Fixed weird rendering of \` symbols in the spec, fixed `create_image` arguments order to match the implementation.
1 parent 29d4440 commit 73d88dc

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

sycl/doc/extensions/experimental/sycl_ext_oneapi_bindless_images.asciidoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -226,8 +226,8 @@ semantics.
226226

227227
[NOTE]
228228
====
229-
Additional future `image_type`s _may_ include combined image types like
230-
"mipmapped cubemap".
229+
Additional future `image_type` enumerators _may_ include combined image types
230+
like "mipmapped cubemap".
231231
====
232232

233233
Note that `image_channel_type` and `image_channel_order` existed in SYCL 1.2.1,
@@ -269,7 +269,7 @@ to query device support for the allocation and creation of images for a given
269269
Before allocating memory for an image, the user may first query whether their
270270
desired image backing memory type is supported by the device.
271271

272-
The following query returns a vector of supported `image_memory_handle_type`s
272+
The following query returns a vector of supported `image_memory_handle_type`
273273
based on the properties of a given `image_descriptor`.
274274

275275
The `image_memory_handle_type::usm_pointer` relates to USM allocations, while
@@ -616,13 +616,13 @@ unsampled_image_handle create_image(image_mem_handle memHandle,
616616

617617
// Creating a sampled image from an `image_mem_handle`
618618
sampled_image_handle create_image(image_mem_handle memHandle,
619-
const image_descriptor &desc,
620619
const bindless_image_sampler &sampler,
620+
const image_descriptor &desc,
621621
const sycl::device &syclDevice,
622622
const sycl::context &syclContext);
623623
sampled_image_handle create_image(image_mem_handle memHandle,
624-
const image_descriptor &desc,
625624
const bindless_image_sampler &sampler,
625+
const image_descriptor &desc,
626626
const sycl::queue &syclQueue);
627627

628628
// Creating an unsampled image from an `image_mem` object
@@ -636,24 +636,24 @@ unsampled_image_handle create_image(const image_mem &memHandle,
636636

637637
// Creating a sampled image from an `image_mem` object
638638
sampled_image_handle create_image(const image_mem &memHandle,
639-
const image_descriptor &desc,
640639
const bindless_image_sampler &sampler,
640+
const image_descriptor &desc,
641641
const sycl::device &syclDevice,
642642
const sycl::context &syclContext);
643643
sampled_image_handle create_image(const image_mem &memHandle,
644-
const image_descriptor &desc,
645644
const bindless_image_sampler &sampler,
645+
const image_descriptor &desc,
646646
const sycl::queue &syclQueue);
647647

648648
// Creating a sampled image from a USM allocation and pitch
649649
sampled_image_handle create_image(const void *usmPtr, size_t pitch,
650-
const image_descriptor &desc,
651650
const bindless_image_sampler &sampler,
651+
const image_descriptor &desc,
652652
const sycl::device &syclDevice,
653653
const sycl::context &syclContext);
654654
sampled_image_handle create_image(const void *usmPtr, size_t pitch,
655-
const image_descriptor &desc,
656655
const bindless_image_sampler &sampler,
656+
const image_descriptor &desc,
657657
const sycl::queue &syclQueue);
658658

659659
// Destroying an image handle
@@ -1387,7 +1387,7 @@ dimensions are `x` for 1D images, `x` and `y` for 2D images, and `x`, `y`, and
13871387
`z` for 3D images. `x`, `y`, and `z` correspond to indices `0`, `1`, and `2` of
13881388
the `SrcOffset` and `CopyExtent` parameters, respectively.
13891389

1390-
11. The `CopyExtent`'s' `x`, `y`, and `z` dimensions must not be `0`. They must
1390+
11. Dimensions `x`, `y`, and `z` of the `CopyExtent` must not be `0`. They must
13911391
be greater than or equal to `1`. Even if the image is 1D or 2D, the remaining
13921392
non-relevant dimension's values must be set to `1` in the `CopyExtent`
13931393
parameter.
@@ -2017,7 +2017,7 @@ The device aspect descriptors for these queries are:
20172017
|Device descriptor |Description
20182018
|`aspect::ext_oneapi_external_memory_import` | Indicates if the device supports
20192019
importing external memory resources.
2020-
|`aspect::ext_oneapi_external_semaphore_import`` | Indicates if the device
2020+
|`aspect::ext_oneapi_external_semaphore_import` | Indicates if the device
20212021
supports importing external semaphore resources.
20222022
|======================
20232023

0 commit comments

Comments
 (0)