Skip to content

Commit 0c7bc85

Browse files
committed
error consistency for filling images
1 parent dac4714 commit 0c7bc85

1 file changed

Lines changed: 37 additions & 33 deletions

File tree

api/opencl_runtime_layer.asciidoc

Lines changed: 37 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -3726,7 +3726,7 @@ Otherwise, it returns one of the following errors:
37263726
** if the context associated with _command_queue_ and _image_ are not the same
37273727
** if the context associated with _command_queue_ and events in _event_wait_list_ are not the same
37283728
* {CL_INVALID_MEM_OBJECT}
3729-
** if _image_ is not a valid buffer object
3729+
** if _image_ is not a valid image object
37303730
* {CL_INVALID_VALUE}
37313731
** if _origin_ is `NULL`
37323732
** if _region_ is `NULL`
@@ -4038,42 +4038,46 @@ argument value specified when _image_ is created is ignored by
40384038
successfully.
40394039
Otherwise, it returns one of the following errors:
40404040

4041-
* {CL_INVALID_COMMAND_QUEUE} if _command_queue_ is not a valid host
4042-
command-queue.
4043-
* {CL_INVALID_CONTEXT} if the context associated with _command_queue_ and
4044-
_image_ are not the same or if the context associated with
4045-
_command_queue_ and events in _event_wait_list_ are not the same.
4046-
* {CL_INVALID_MEM_OBJECT} if _image_ is not a valid image object.
4047-
* {CL_INVALID_VALUE} if _fill_color_ is `NULL`.
4048-
* {CL_INVALID_VALUE} if _origin_ or _region_ is `NULL`.
4049-
* {CL_INVALID_VALUE} if the region being filled as specified by _origin_ and
4050-
_region_ is out of bounds.
4051-
* {CL_INVALID_VALUE} if values in _origin_ and _region_ do not follow rules
4052-
described in the argument description for _origin_ and _region_.
4053-
* {CL_INVALID_EVENT_WAIT_LIST} if _event_wait_list_ is `NULL` and
4054-
_num_events_in_wait_list_ > 0, or _event_wait_list_ is not `NULL` and
4055-
_num_events_in_wait_list_ is 0, or if event objects in _event_wait_list_
4056-
are not valid events.
4057-
* {CL_INVALID_IMAGE_SIZE} if image dimensions (image width, height,
4058-
specified or compute row and/or slice pitch) for _image_ are not
4059-
supported by device associated with _queue_.
4060-
* {CL_IMAGE_FORMAT_NOT_SUPPORTED} if image format (image channel order and
4061-
data type) for _image_ are not supported by device associated with
4062-
_queue_.
4063-
* {CL_MEM_OBJECT_ALLOCATION_FAILURE} if there is a failure to allocate
4064-
memory for data store associated with _image_.
4065-
* {CL_OUT_OF_RESOURCES} if there is a failure to allocate resources required
4066-
by the OpenCL implementation on the device.
4067-
* {CL_OUT_OF_HOST_MEMORY} if there is a failure to allocate resources
4068-
required by the OpenCL implementation on the host.
4041+
* {CL_INVALID_COMMAND_QUEUE}
4042+
** if _command_queue_ is not a valid host command-queue
4043+
* {CL_INVALID_CONTEXT}
4044+
** if the context associated with _command_queue_ and _image_ are not the same
4045+
** if the context associated with _command_queue_ and events in _event_wait_list_ are not the same
4046+
* {CL_INVALID_MEM_OBJECT}
4047+
** if _image_ is not a valid image object
4048+
* {CL_INVALID_VALUE}
4049+
** if _fill_color_ is `NULL`
4050+
** if _origin_ is `NULL`
4051+
** if _region_ is `NULL`
4052+
** if the region being filled specified by _origin_ and _region_ is out of bounds
4053+
** if values in _origin_ and _region_ do not follow the rules described in the argument description for _origin_ and _region_
40694054
ifdef::cl_khr_mipmap_image[]
4070-
* {CL_INVALID_MIP_LEVEL} if the {cl_khr_mipmap_image_EXT} extension is
4071-
supported, and the mip level specified in _origin_ is not a valid level
4072-
for _image_,
4055+
* {CL_INVALID_MIP_LEVEL}
4056+
** if the {cl_khr_mipmap_image_EXT} extension is supported and the mip level specified in _origin_ is not a valid level for _image_
40734057
endif::cl_khr_mipmap_image[]
4058+
* {CL_INVALID_EVENT_WAIT_LIST}
4059+
** if _event_wait_list_ is `NULL` and _num_events_in_wait_list_ greater than zero
4060+
** if _event_wait_list_ is not `NULL` and _num_events_in_wait_list_ is zero
4061+
** if event objects in _event_wait_list_ are not valid events
4062+
* {CL_INVALID_IMAGE_SIZE}
4063+
** if the dimensions for _image_, such as the image width or image height,
4064+
are not supported by the device associated with _command_queue_
4065+
* {CL_IMAGE_FORMAT_NOT_SUPPORTED}
4066+
** if the format for _image_, such as the image channel order or image
4067+
channel data type, are not supported by the device associated with
4068+
_command_queue_
4069+
* {CL_MEM_OBJECT_ALLOCATION_FAILURE}
4070+
** if there is a failure to allocate memory for data store associated with _image_
40744071
ifdef::cl_ext_immutable_memory_objects[]
4075-
* {CL_INVALID_OPERATION} if _image_ was created with {CL_MEM_IMMUTABLE_EXT}.
4072+
* {CL_INVALID_OPERATION}
4073+
** if _image_ was created with {CL_MEM_IMMUTABLE_EXT}
40764074
endif::cl_ext_immutable_memory_objects[]
4075+
* {CL_OUT_OF_RESOURCES}
4076+
** if there is a failure to allocate resources required by the OpenCL
4077+
implementation on the device
4078+
* {CL_OUT_OF_HOST_MEMORY}
4079+
** if there is a failure to allocate resources required by the OpenCL
4080+
implementation on the host
40774081
--
40784082

40794083

0 commit comments

Comments
 (0)