Skip to content

Commit 94dc220

Browse files
authored
A few editorial fixes to cl_ext_image_requirements_info and cl_ext_image_from_buffer (#942)
- Fix status of cl_ext_image_requirements_info - Use macros for all commands and enums - Fix mismatched parenthesis See KhronosGroup/OpenCL-Registry#141 Change-Id: I36ae9926e1da3fcf9c74d221888d30ab61c75b4e Signed-off-by: Kevin Petit <kevin.petit@arm.com>
1 parent ff88d06 commit 94dc220

2 files changed

Lines changed: 12 additions & 12 deletions

File tree

extensions/cl_ext_image_from_buffer.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ object.
5656

5757
== New API Enums
5858

59-
Accepted value for the _param_name_ parameter to *clGetImageRequirementsInfoEXT*:
59+
Accepted value for the _param_name_ parameter to {clGetImageRequirementsInfoEXT}:
6060

6161
[source,c]
6262
----
@@ -265,7 +265,7 @@ None.
265265
- For all image types (one format per element size)
266266
- For a few different row/pitch sizes (image dimensions being equal or not)
267267
- Create an image from a buffer
268-
- Check that the returned values for {CL_IMAGE_ROW_PITCH} and {CL_IMAGE_SLICE_PICTH} are correct.
268+
- Check that the returned values for {CL_IMAGE_ROW_PITCH} and {CL_IMAGE_SLICE_PITCH} are correct.
269269

270270
. Test clGetMemObjectInfo
271271
- For all image types (1 format only)

extensions/cl_ext_image_requirements_info.asciidoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ include::../copyrights.txt[]
3434

3535
== Status
3636

37-
Draft spec, NOT APPROVED!!
37+
Shipping.
3838

3939
== Version
4040

@@ -77,7 +77,7 @@ typedef cl_uint cl_image_requirements_info_ext;
7777

7878
== New API Enums
7979

80-
Accepted value for the _param_name_ parameter to *clGetImageRequirementsInfoEXT*:
80+
Accepted value for the _param_name_ parameter to {clGetImageRequirementsInfoEXT}:
8181

8282
[source,c]
8383
----
@@ -91,7 +91,8 @@ CL_IMAGE_REQUIREMENTS_MAX_ARRAY_SIZE_EXT 0x12B6
9191
----
9292

9393
== Modifications to the OpenCL API Specification
94-
Modify Section 5.3.1, *Creating Image Objects*) ::
94+
95+
(Modify Section 5.3.1, *Creating Image Objects*) ::
9596
+
9697
--
9798
The following text:
@@ -115,7 +116,7 @@ compatible with those used to create the image.
115116
The following text:
116117
--
117118
If the buffer object specified by mem_object was created with {CL_MEM_USE_HOST_PTR},
118-
the _host_ptr_ specified to *clCreateBuffer* or *clCreateBufferWithProperties* must
119+
the _host_ptr_ specified to {clCreateBuffer} or {clCreateBufferWithProperties} must
119120
be aligned to the maximum of the {CL_DEVICE_IMAGE_BASE_ADDRESS_ALIGNMENT} value for
120121
all devices in the context associated with the buffer specified by mem_object that
121122
support images.
@@ -125,7 +126,7 @@ is replaced with:
125126

126127
--
127128
If the buffer object specified by mem_object was created with {CL_MEM_USE_HOST_PTR},
128-
the _host_ptr_ specified to *clCreateBuffer* or *clCreateBufferWithProperties* must
129+
the _host_ptr_ specified to {clCreateBuffer} or {clCreateBufferWithProperties} must
129130
be aligned to the {CL_IMAGE_REQUIREMENTS_BASE_ADDRESS_ALIGNMENT_EXT} value for the
130131
returned for parameters compatible with those used to create the image.
131132
--
@@ -136,7 +137,6 @@ returned for parameters compatible with those used to create the image.
136137
+
137138
--
138139

139-
140140
(Add a new subsection 5.3.X, *Querying image requirements*) ::
141141
+
142142
--
@@ -240,7 +240,7 @@ include::{generated}/api/protos/clGetImageRequirementsInfoEXT.txt[]
240240
except `mem_object` may be `0` to require that the value returned be supported
241241
for all possible values of the members that are set to `0`. +
242242
If _image_desc_ is not `NULL`, then _image_type_ must be either `0`,
243-
`CL_MEM_OBJECT_IMAGE2D`, `CL_MEM_OBJECT_IMAGE2D_ARRAY`, or `CL_MEM_OBJECT_IMAGE3D`,
243+
{CL_MEM_OBJECT_IMAGE2D}, {CL_MEM_OBJECT_IMAGE2D_ARRAY}, or {CL_MEM_OBJECT_IMAGE3D},
244244
otherwise {CL_INVALID_IMAGE_DESCRIPTOR} is returned. +
245245
TODO: should we require _image_height_ to be `0`?
246246

@@ -256,7 +256,7 @@ include::{generated}/api/protos/clGetImageRequirementsInfoEXT.txt[]
256256
except `mem_object` may be `0` to require that the value returned be supported
257257
for all possible values of the members that are set to `0`. +
258258
If _image_desc_ is not `NULL`, then _image_type_ must be either `0` or
259-
`CL_MEM_OBJECT_IMAGE3D`, otherwise {CL_INVALID_IMAGE_DESCRIPTOR} is returned. +
259+
{CL_MEM_OBJECT_IMAGE3D}, otherwise {CL_INVALID_IMAGE_DESCRIPTOR} is returned. +
260260
TODO: should we require _image_depth_ to be `0`?
261261

262262
| {CL_IMAGE_REQUIREMENTS_MAX_ARRAY_SIZE_EXT}
@@ -271,7 +271,7 @@ include::{generated}/api/protos/clGetImageRequirementsInfoEXT.txt[]
271271
except `mem_object` may be `0` to require that the value returned be supported
272272
for all possible values of the members that are set to `0`. +
273273
If _image_desc_ is not `NULL`, then _image_type_ must be either `0`,
274-
`CL_MEM_OBJECT_IMAGE1D_ARRAY` or `CL_MEM_OBJECT_IMAGE2D_ARRAY`, otherwise
274+
{CL_MEM_OBJECT_IMAGE1D_ARRAY} or {CL_MEM_OBJECT_IMAGE2D_ARRAY}, otherwise
275275
{CL_INVALID_IMAGE_DESCRIPTOR} is returned. +
276276
TODO: should we require _image_array_size_ to be `0`?
277277
|====
@@ -371,7 +371,7 @@ When `cl_khr_image2d_from_buffer` is supported:
371371
** Check that the {CL_IMAGE_REQUIREMENTS_MAX_ARRAY_SIZE_EXT} query can be performed successfully
372372
** Check that the value is smaller than or equal to the value returned for {CL_DEVICE_IMAGE_MAX_ARRAY_SIZE}.
373373

374-
. General negative testing for *clGetImageRequirementsInfoEXT*
374+
. General negative testing for {clGetImageRequirementsInfoEXT}
375375
** Write tests for all possible testable generic error codes.
376376

377377
== Issues

0 commit comments

Comments
 (0)