KhronosGroup / KhronosGroup/OpenGL-Refpages

glDebugMessageInsert() GL_INVALID_VALUE claim does not match specification

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

Description

https://registry.khronos.org/OpenGL-Refpages/gl4/html/glDebugMessageInsert.xhtml says:

> GL_INVALID_VALUE is generated if the length of the message is greater than the value of GL_MAX_DEBUG_MESSAGE_LENGTH

Specification says:

> An INVALID_VALUE error is generated if the number of characters in buf, excluding the null terminator when length is negative, is not less than the value of MAX_DEBUG_MESSAGE_LENGTH.

My interpretation of specification is that when length is not negative, INVALID_VALUE should not happen.

For reference, https://registry.khronos.org/OpenGL-Refpages/gl4/html/glPushDebugGroup.xhtml says:

> GL_INVALID_VALUE is generated if length is negative and the number of characters in message, excluding the null-terminator, is not less than the value of GL_MAX_DEBUG_MESSAGE_LENGTH.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the glDebugMessageInsert() reference page linked in the issue and compare its GL_INVALID_VALUE wording with the OpenGL specification and the glPushDebugGroup() reference page. Locate the source for the affected reference text, update the condition to match the specification, and regenerate or verify the HTML so the published wording is consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.