Skip to content

Commit 47a785f

Browse files
committed
more error consistency for memory objects
1 parent a42a212 commit 47a785f

1 file changed

Lines changed: 52 additions & 36 deletions

File tree

api/opencl_runtime_layer.asciidoc

Lines changed: 52 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -486,7 +486,7 @@ Otherwise, it returns one of the following errors:
486486
** if _command_queue_ is not a valid command-queue for _param_name_
487487
* {CL_INVALID_VALUE}
488488
** if _param_name_ is not one of the supported values
489-
** if the size in bytes specified by _param_value_size_ is less than size of
489+
** if the size in bytes specified by _param_value_size_ is less than the size of
490490
the return type specified in the
491491
<<command-queue-info-table, Command-Queue Queries>>
492492
table and _param_value_ is not `NULL`
@@ -4713,7 +4713,7 @@ Otherwise, it returns one of the following errors:
47134713
** if _image_ is a not a valid image object
47144714
* {CL_INVALID_VALUE}
47154715
** if _param_name_ is not one of the supported values
4716-
** if the size in bytes specified by _param_value_size_ is less than size of
4716+
** if the size in bytes specified by _param_value_size_ is less than the size of
47174717
the return type specified in the
47184718
<<image-info-table, Image Object Queries>>
47194719
table and _param_value_ is not `NULL`
@@ -5647,23 +5647,30 @@ endif::cl_ext_image_from_buffer[]
56475647
successfully.
56485648
Otherwise, it returns one of the following errors:
56495649

5650-
* {CL_INVALID_CONTEXT} if _context_ if not a valid context.
5651-
* {CL_INVALID_PROPERTY} if a property name in properties is not a supported
5652-
property name, if the value specified for a supported property name is not
5653-
valid, or if the same property name is specified more than once.
5654-
* {CL_INVALID_VALUE} if values specified in _flags_ are not valid.
5655-
* {CL_INVALID_IMAGE_FORMAT_DESCRIPTOR} if values specified in _image_format_
5656-
are not valid.
5657-
* {CL_INVALID_IMAGE_DESCRIPTOR} if values specified in _image_desc_
5658-
are not valid.
5659-
* {CL_INVALID_VALUE} if _param_name_ is not valid, or if size in bytes
5660-
specified by _param_value_size_ is < size of return type as described in
5661-
the <<image-requirements-info-table,Image Requirements Queries>> table and
5662-
_param_value_ is not `NULL`.
5663-
* {CL_OUT_OF_RESOURCES} if there is a failure to allocate resources required
5664-
by the OpenCL implementation on the device.
5665-
* {CL_OUT_OF_HOST_MEMORY} if there is a failure to allocate resources
5666-
required by the OpenCL implementation on the host.
5650+
* {CL_INVALID_CONTEXT}
5651+
** if _context_ if not a valid context
5652+
* {CL_INVALID_PROPERTY}
5653+
** if a property name in _properties_ is not a supported property name
5654+
** if the value specified for a supported property name is not valid
5655+
** if the same property name is specified more than once
5656+
* {CL_INVALID_VALUE}
5657+
** if values specified in _flags_ are not valid
5658+
* {CL_INVALID_IMAGE_FORMAT_DESCRIPTOR}
5659+
** if values specified in _image_format_ are not valid
5660+
* {CL_INVALID_IMAGE_DESCRIPTOR}
5661+
** if values specified in _image_desc_ are not valid
5662+
* {CL_INVALID_VALUE}
5663+
** if _param_name_ is not valid
5664+
** if size in bytes specified by _param_value_size_ is less than the size of
5665+
the return type specified in the
5666+
<<image-requirements-info-table,Image Requirements Queries>>
5667+
table and _param_value_ is not `NULL`
5668+
* {CL_OUT_OF_RESOURCES}
5669+
** if there is a failure to allocate resources required by the OpenCL
5670+
implementation on the device
5671+
* {CL_OUT_OF_HOST_MEMORY}
5672+
** if there is a failure to allocate resources required by the OpenCL
5673+
implementation on the host
56675674
--
56685675
endif::cl_ext_image_requirements_info[]
56695676

@@ -5852,12 +5859,14 @@ The _memobj_ reference count is incremented.
58525859
successfully.
58535860
Otherwise, it returns one of the following errors:
58545861

5855-
* {CL_INVALID_MEM_OBJECT} if _memobj_ is not a valid memory object (buffer
5856-
or image object).
5857-
* {CL_OUT_OF_RESOURCES} if there is a failure to allocate resources required
5858-
by the OpenCL implementation on the device.
5859-
* {CL_OUT_OF_HOST_MEMORY} if there is a failure to allocate resources
5860-
required by the OpenCL implementation on the host.
5862+
* {CL_INVALID_MEM_OBJECT}
5863+
** if _memobj_ is not a valid memory object
5864+
* {CL_OUT_OF_RESOURCES}
5865+
** if there is a failure to allocate resources required by the OpenCL
5866+
implementation on the device
5867+
* {CL_OUT_OF_HOST_MEMORY}
5868+
** if there is a failure to allocate resources required by the OpenCL
5869+
implementation on the host
58615870

58625871
{clCreateBuffer}, {clCreateBufferWithProperties}, {clCreateSubBuffer},
58635872
{clCreateImage}, {clCreateImageWithProperties}, {clCreateImage2D},
@@ -5881,11 +5890,14 @@ The _memobj_ reference count is decremented.
58815890
successfully.
58825891
Otherwise, it returns one of the following errors:
58835892

5884-
* {CL_INVALID_MEM_OBJECT} if _memobj_ is not a valid memory object.
5885-
* {CL_OUT_OF_RESOURCES} if there is a failure to allocate resources required
5886-
by the OpenCL implementation on the device.
5887-
* {CL_OUT_OF_HOST_MEMORY} if there is a failure to allocate resources
5888-
required by the OpenCL implementation on the host.
5893+
* {CL_INVALID_MEM_OBJECT}
5894+
** if _memobj_ is not a valid memory object
5895+
* {CL_OUT_OF_RESOURCES}
5896+
** if there is a failure to allocate resources required by the OpenCL
5897+
implementation on the device
5898+
* {CL_OUT_OF_HOST_MEMORY}
5899+
** if there is a failure to allocate resources required by the OpenCL
5900+
implementation on the host
58895901

58905902
After the _memobj_ reference count becomes zero and commands queued for
58915903
execution on a command-queue(s) that use _memobj_ have finished, the memory
@@ -5936,12 +5948,16 @@ _memobj_ was created and used as the storage bits for the memory object.
59365948
executed successfully.
59375949
Otherwise, it returns one of the following errors:
59385950

5939-
* {CL_INVALID_MEM_OBJECT} if _memobj_ is not a valid memory object.
5940-
* {CL_INVALID_VALUE} if _pfn_notify_ is `NULL`.
5941-
* {CL_OUT_OF_RESOURCES} if there is a failure to allocate resources required
5942-
by the OpenCL implementation on the device.
5943-
* {CL_OUT_OF_HOST_MEMORY} if there is a failure to allocate resources
5944-
required by the OpenCL implementation on the host.
5951+
* {CL_INVALID_MEM_OBJECT}
5952+
** if _memobj_ is not a valid memory object
5953+
* {CL_INVALID_VALUE}
5954+
** if _pfn_notify_ is `NULL`
5955+
* {CL_OUT_OF_RESOURCES}
5956+
** if there is a failure to allocate resources required by the OpenCL
5957+
implementation on the device
5958+
* {CL_OUT_OF_HOST_MEMORY}
5959+
** if there is a failure to allocate resources required by the OpenCL
5960+
implementation on the host
59455961

59465962
[[callback-functions]]
59475963
[NOTE]

0 commit comments

Comments
 (0)