Skip to content

Commit 8224594

Browse files
kpetbashbaug
andauthored
Tighten the definition of CL_IMAGE_{ROW,SLICE}_PITCH queries (#777)
* Tighten the definition of CL_IMAGE_{ROW,SLICE}_PITCH queries Fixes #763 Signed-off-by: Kevin Petit <kevin.petit@arm.com> Change-Id: I50875d6aa1ffdf6152832c68ac6cf6bdcb434304 * Update api/opencl_runtime_layer.asciidoc Co-authored-by: Ben Ashbaugh <ben.ashbaugh@intel.com> * Remove mention of linear tiling Change-Id: I4ecd773019f56af391f00333b58ceb8221ca9f0c Co-authored-by: Ben Ashbaugh <ben.ashbaugh@intel.com>
1 parent 7425ff8 commit 8224594

1 file changed

Lines changed: 14 additions & 4 deletions

File tree

api/opencl_runtime_layer.asciidoc

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3430,15 +3430,25 @@ include::{generated}/api/version-notes/CL_IMAGE_ELEMENT_SIZE.asciidoc[]
34303430

34313431
include::{generated}/api/version-notes/CL_IMAGE_ROW_PITCH.asciidoc[]
34323432
| {size_t_TYPE}
3433-
| Return calculated row pitch in bytes of a row of elements of the
3434-
image object given by _image_.
3433+
| Returns the row pitch in bytes of a row of elements of the
3434+
image object given by _image_. +
3435+
If _image_ was created with a non-zero value for `image_row_pitch`,
3436+
then the value provided for `image_row_pitch` by the application is
3437+
returned, otherwise the returned value is calculated as
3438+
{CL_IMAGE_WIDTH} {times} {CL_IMAGE_ELEMENT_SIZE}.
34353439
| {CL_IMAGE_SLICE_PITCH_anchor}
34363440

34373441
include::{generated}/api/version-notes/CL_IMAGE_SLICE_PITCH.asciidoc[]
34383442
| {size_t_TYPE}
3439-
| Return calculated slice pitch in bytes of a 2D slice for the 3D
3443+
| Returns the slice pitch in bytes of a 2D slice for the 3D
34403444
image object or size of each image in a 1D or 2D image array given
3441-
by _image_.
3445+
by _image_. +
3446+
If _image_ was created with a non-zero value for `image_slice_pitch`
3447+
then the value provided for `image_slice_pitch` by the application
3448+
is returned, otherwise the returned value is calculated as: +
3449+
- {CL_IMAGE_ROW_PITCH} for 1D image arrays. +
3450+
- {CL_IMAGE_HEIGHT} {times} {CL_IMAGE_ROW_PITCH} for 3D images and
3451+
2D image arrays. +
34423452
For a 1D image, 1D image buffer and 2D image object return 0.
34433453
| {CL_IMAGE_WIDTH_anchor}
34443454

0 commit comments

Comments
 (0)