KhronosGroup / KhronosGroup/OpenCL-Docs
clCreateFromGLTexture2D and clCreateFromGLTexture3D are not described
- Dominant language
- Python
- Stars
- 420
- Forks
- 131
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 11
Description
`clCreateFromGLTexture2D` and `clCreateFromGLTexture3D` are not documented anywhere. This is because they were deprecated in favor of `clCreateFromGLTexture` alongside OpenCL 1.2.
The descriptions of their image counterparts were re-added as the API specification was unified, but these were missed. I think these are the only parts of an extension that have ever been deprecated -- though other entire extensions have been deprecated.
The extension specification has never actually been unified, in almost all regards it was always version independent with extensions describing specific dependencies. So it's not necessarily a problem that these are missing.
Contributor guide
Research direction
Start by locating the extension specification and the existing descriptions of the image counterparts, then compare how deprecated APIs are represented. Check the entries for clCreateFromGLTexture2D and clCreateFromGLTexture3D. Done means both APIs have documentation consistent with the corresponding image functions and the unified API specification.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100