Skip to content

Commit 97adb9a

Browse files
authored
clarify cl_mem_flags to not affect copies (KhronosGroup#1230)
1 parent 503dbce commit 97adb9a

1 file changed

Lines changed: 65 additions & 0 deletions

File tree

api/opencl_runtime_layer.asciidoc

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1256,6 +1256,11 @@ include::{generated}/api/version-notes/clEnqueueCopyBuffer.asciidoc[]
12561256
If _event_wait_list_ and _event_ are not `NULL`, _event_ must not refer
12571257
to an element of the _event_wait_list_ array.
12581258

1259+
The usage information which indicates whether the memory object can be read
1260+
or written by a kernel and/or the host and is given by the {cl_mem_flags_TYPE}
1261+
argument value specified when _src_buffer_ or _dst_buffer is created is ignored by
1262+
{clEnqueueCopyBuffer}.
1263+
12591264
// refError
12601265

12611266
{clEnqueueCopyBuffer} returns {CL_SUCCESS} if the function is executed
@@ -1383,6 +1388,11 @@ must equal _dst_row_pitch_ and _src_slice_pitch_ must equal
13831388
_dst_slice_pitch_.
13841389
====
13851390

1391+
The usage information which indicates whether the memory object can be read
1392+
or written by a kernel and/or the host and is given by the {cl_mem_flags_TYPE}
1393+
argument value specified when _src_buffer_ or _dst_buffer_ is created is ignored by
1394+
{clEnqueueCopyBufferRect}.
1395+
13861396
// refError
13871397

13881398
{clEnqueueCopyBufferRect} returns {CL_SUCCESS} if the function is executed
@@ -3553,6 +3563,11 @@ memory objects for {clEnqueueCopyImage} must have the exact same image
35533563
format (i.e. the {cl_image_format_TYPE} descriptor specified when _src_image_ and
35543564
_dst_image_ are created must match).
35553565

3566+
The usage information which indicates whether the memory object can be read
3567+
or written by a kernel and/or the host and is given by the {cl_mem_flags_TYPE}
3568+
argument value specified when _src_image_ or _dst_image_ is created is ignored by
3569+
{clEnqueueCopyImage}.
3570+
35563571
// refError
35573572

35583573
{clEnqueueCopyImage} returns {CL_SUCCESS} if the function is executed
@@ -3800,6 +3815,11 @@ endif::cl_khr_mipmap_image[]
38003815
If _event_wait_list_ and _event_ are not `NULL`, _event_ must not refer
38013816
to an element of the _event_wait_list_ array.
38023817

3818+
The usage information which indicates whether the memory object can be read
3819+
or written by a kernel and/or the host and is given by the {cl_mem_flags_TYPE}
3820+
argument value specified when _src_image_ or _dst_buffer_ is created is ignored by
3821+
{clEnqueueCopyImageToBuffer}.
3822+
38033823
// refError
38043824

38053825
{clEnqueueCopyImageToBuffer} returns {CL_SUCCESS} if the function is executed
@@ -3927,6 +3947,11 @@ image or 1D image buffer object and is computed as _width_ {times}
39273947
_arraysize_ {times} _bytes/image element_ if _dst_image_ is a 1D image array
39283948
object.
39293949

3950+
The usage information which indicates whether the memory object can be read
3951+
or written by a kernel and/or the host and is given by the {cl_mem_flags_TYPE}
3952+
argument value specified when _src_buffer_ or _dst_image_ is created is ignored by
3953+
{clEnqueueCopyBufferToImage}.
3954+
39303955
// refError
39313956

39323957
{clEnqueueCopyBufferToImage} returns {CL_SUCCESS} if the function is executed
@@ -14529,6 +14554,14 @@ after the function returns.
1452914554
* _mutable_handle_ returns a handle to the command.
1453014555
This parameter is unused, and **must** be `NULL`.
1453114556

14557+
[NOTE]
14558+
====
14559+
The usage information which indicates whether the memory object can be read or
14560+
written by a kernel and/or the host and is given by the {cl_mem_flags_TYPE} argument
14561+
value specified when _src_buffer_ or _dst_buffer_ is created is ignored by
14562+
{clCommandCopyBufferKHR}.
14563+
====
14564+
1453214565
// refError
1453314566

1453414567
{clCommandCopyBufferKHR} returns {CL_SUCCESS} if the function is executed
@@ -14643,6 +14676,14 @@ After copying each 2D rectangle, the source and destination offsets are
1464314676
incremented by their respective source and destination slice pitches.
1464414677
====
1464514678

14679+
[NOTE]
14680+
====
14681+
The usage information which indicates whether the memory object can be read or
14682+
written by a kernel and/or the host and is given by the {cl_mem_flags_TYPE} argument
14683+
value specified when _src_buffer_ or _dst_buffer_ is created is ignored by
14684+
{clCommandCopyBufferRectKHR}.
14685+
====
14686+
1464614687
// refError
1464714688

1464814689
{clCommandCopyBufferRectKHR} returns {CL_SUCCESS} if the function is
@@ -14741,6 +14782,14 @@ after the function returns.
1474114782
* _mutable_handle_ returns a handle to the command.
1474214783
This parameter is unused, and **must** be `NULL`.
1474314784

14785+
[NOTE]
14786+
====
14787+
The usage information which indicates whether the memory object can be read or
14788+
written by a kernel and/or the host and is given by the {cl_mem_flags_TYPE} argument
14789+
value specified when _src_buffer_ or _dst_image_ is created is ignored by
14790+
{clCommandCopyBufferToImageKHR}.
14791+
====
14792+
1474414793
// refError
1474514794

1474614795
{clCommandCopyBufferToImageKHR} returns {CL_SUCCESS} if the function is executed
@@ -14846,6 +14895,14 @@ format, i.e. the {cl_image_format_TYPE} descriptor specified when
1484614895
_src_image_ and _dst_image_ are created must match.
1484714896
====
1484814897

14898+
[NOTE]
14899+
====
14900+
The usage information which indicates whether the memory object can be read or
14901+
written by a kernel and/or the host and is given by the {cl_mem_flags_TYPE} argument
14902+
value specified when _src_image_ or _dst_image_ is created is ignored by
14903+
{clCommandCopyImageKHR}.
14904+
====
14905+
1484914906
// refError
1485014907

1485114908
{clCommandCopyImageKHR} returns {CL_SUCCESS} if the function is executed
@@ -14943,6 +15000,14 @@ after the function returns.
1494315000
* _mutable_handle_ returns a handle to the command.
1494415001
This parameter is unused, and **must** be `NULL`.
1494515002

15003+
[NOTE]
15004+
====
15005+
The usage information which indicates whether the memory object can be read or
15006+
written by a kernel and/or the host and is given by the {cl_mem_flags_TYPE} argument
15007+
value specified when _src_image_ or _dst_buffer_ is created is ignored by
15008+
{clCommandCopyImageToBufferKHR}.
15009+
====
15010+
1494615011
// refError
1494715012

1494815013
{clCommandCopyImageToBufferKHR} returns {CL_SUCCESS} if the function is

0 commit comments

Comments
 (0)