KhronosGroup / KhronosGroup/OpenGL-Refpages

Discrepancy between `glGetInternalformat` documentation and `ARB_internalformat_query2` one

Open
#157 6 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
492
Forks
146
PR merge metrics
No merged PRs in 30d

Description

Hi! A discrepancy in OpenGL documentation was discovered:

The `glGetInternalformat` reference page says that it should return either `GL_TRUE` or `GL_FALSE` when queried for `GL_FRAMEBUFFER_BLEND`, but the `ARB_internalformat_query2` extension page says it should return either `GL_FULL_SUPPORT`, `GL_CAVEAT_SUPPORT`, or `GL_NONE`.

> If _pname_ is `GL_FRAMEBUFFER_BLEND`, _params_ is set to `GL_TRUE` to indicate that the internal format is supported for blending operations when attached to a framebuffer, and to `GL_FALSE` otherwise.
> -- https://registry.khronos.org/OpenGL-Refpages/gl4/html/glGetInternalformat.xhtml

> `FRAMEBUFFER_BLEND`: The support for rendering to the resource via framebuffer attachment when blending is enabled is returned in _params_. Possible values returned are `FULL_SUPPORT`, `CAVEAT_SUPPORT`, or `NONE`. If the resource is unsupported, `NONE` is returned.
> -- https://registry.khronos.org/OpenGL/extensions/ARB/ARB_internalformat_query2.txt

While `GL_FALSE` and `GL_NONE` are equal (`0`), `GL_FULL_SUPPORT` (`33463`) and `GL_TRUE` (`1`) are not.

Contributor guide

No contributing guide indexed for this repository

Research direction

Compare the glGetInternalformat reference page with the ARB_internalformat_query2 extension text linked in the issue, focusing on GL_FRAMEBUFFER_BLEND and its returned values. Reconcile the documentation so both sources describe the same valid results, then verify the affected generated reference content.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.