Skip to content

Commit 723f7d3

Browse files
authored
clarify the image row pitch requirements (#1380)
1 parent 1b63ead commit 723f7d3

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

api/opencl_runtime_layer.asciidoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2864,28 +2864,28 @@ include::{generated}/api/structs/cl_image_desc.txt[]
28642864
ifdef::cl_khr_external_memory[]
28652865
the image is not an image created from an external memory handle,
28662866
endif::cl_khr_external_memory[]
2867-
and the image is not a 2D image created from a buffer,
2867+
and the image is not a 2D image created from a buffer. +
28682868
If _image_row_pitch_ is zero and _host_ptr_ is not `NULL`, then the
2869-
image row pitch is calculated as _image_width_ {times} the size of an
2870-
image element in bytes.
2869+
image row pitch is calculated as _image_width_ times the size of an
2870+
image element in bytes. +
28712871
ifdef::cl_khr_external_memory[]
28722872
If _image_row_pitch_ is zero and the image is created from an external
2873-
memory handle, then the image row pitch is implementation-defined.
2873+
memory handle, then the image row pitch is implementation-defined. +
28742874
endif::cl_khr_external_memory[]
2875-
The image row pitch must be {geq} _image_width_ {times} the size of an
2876-
image element in bytes, and must be a multiple of the size of an image
2877-
element in bytes.
2875+
If _image_row_pitch_ is non-zero, then it must be greater than or equal to
2876+
the _image_width_ times the size of an image element in bytes, and must be a
2877+
multiple of the size of an image element in bytes. +
28782878
ifndef::cl_ext_image_requirements_info[]
2879-
For a 2D image created from a buffer the image row pitch must also be a
2879+
For a 2D image created from a buffer the _image_row_pitch_ must also be a
28802880
multiple of the maximum of the {CL_DEVICE_IMAGE_PITCH_ALIGNMENT} value
28812881
for all devices in the context that support images.
28822882
endif::cl_ext_image_requirements_info[]
28832883
ifdef::cl_ext_image_requirements_info[]
2884-
For an image created from a buffer, the image row pitch must also
2885-
- Be a multiple of the {CL_IMAGE_REQUIREMENTS_ROW_PITCH_ALIGNMENT_EXT} value
2886-
for the _image_format_, _image_type_ and _flags_ used to create the image, if
2884+
For an image created from a buffer, the _image_row_pitch_ must also:
2885+
** be a multiple of the {CL_IMAGE_REQUIREMENTS_ROW_PITCH_ALIGNMENT_EXT} value
2886+
for the _image_format_, _image_type_, and _flags_ used to create the image, if
28872887
the {cl_ext_image_requirements_info_EXT} extension is supported, or
2888-
- Be a multiple of the maximum of the {CL_DEVICE_IMAGE_PITCH_ALIGNMENT} value
2888+
** be a multiple of the maximum of the {CL_DEVICE_IMAGE_PITCH_ALIGNMENT} value
28892889
for all devices in the context that support images, otherwise.
28902890
endif::cl_ext_image_requirements_info[]
28912891
* _image_slice_pitch_ is the size in bytes of each 2D slice in a 3D image,

0 commit comments

Comments
 (0)