KhronosGroup / KhronosGroup/OpenCL-Docs
CL_INVALID_IMAGE_FORMAT_DESCRIPTOR error condition
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 421
- Forks
- 132
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 11
Description
Found while refactoring the error conditions for clCreateImageWithProperties:
There is currently an error condition that is specified to return CL_INVALID_IMAGE_FORMAT_DESCRIPTOR:
if an image is created from a buffer and the row pitch, or slice pitch, if the cl_ext_image_from_buffer extension is supported, or base address alignment do not follow the rules described for creating an image from a buffer.
None of the values described in this error condition are part of the image format descriptor (cl_image_format), though. Should this error condition be CL_INVALID_IMAGE_DESCRIPTOR instead?
Originally posted by @bashbaug in https://github.com/KhronosGroup/OpenCL-Docs/pull/1367#discussion_r2124490694
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the clCreateImageWithProperties error conditions alongside the cl_ext_image_from_buffer specification linked in the issue. Confirm whether row pitch, slice pitch, and base address alignment belong to the image descriptor terminology, then update the specification to use the appropriate error condition and verify the surrounding wording remains consistent.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100