Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

glGetShader function pointer does not exist, glGetShaderiv redirecting to glGetShader #136

Open
hunterashner opened this issue Jul 11, 2023 · 4 comments

Comments

@hunterashner
Copy link

image

glGetShaderiv is redirecting to glGetShader, but it seems there is no actual glGetShader function pointer the exists.
Try navigating to glGetShaderiv from docs.gl and you will end up on the glGetShader page.

If I am not crazy and this is actually a mixup/typo I would be happy to fix the page and get my first pull request! Thanks guys!

@BSVino
Copy link
Owner

BSVino commented Jul 12, 2023

Certainly, I’d be happy to pull a PR :)

@hunterashner
Copy link
Author

hunterashner commented Jul 13, 2023

I tried adding an new .xhtml file with glGetShaderiv, and running the build script again to compile, thinking it would then pickup on this file from the opengl SDK, but I think the issue actually lies with khronos groups documentation. I have attached a picture for reference, the glGetShaderiv function and glGetShader function are both present in their navigation bar, but upon clicking each of these links, both take you to the /html/glGetShader.xhtml endpoint.

image

I actually think they need to fix their documentation and remove glGetShader for glGetShaderiv (looks like a typo maybe), so your compile script will pickup on the correct function.

will definitely try to contribute somewhere else in the project, I am assuming you do not want to manually add a separate html file for this function after compilation?

@BSVino
Copy link
Owner

BSVino commented Aug 30, 2023

It's been a while since I applied my brain to docs.gl so I'll lean on you a bit for this one:

What are our options for fixing it on our side? Can we just rename glGetShader.xhtml to glGetShaderiv.xhtml or will we break links? Can we also update all the links? I see that the gles versions already have glGetShaderiv.xhtml so it can't be that bad?

@ForeverZer0
Copy link

I am not certain this is something that should ever be fixed, as it is following the same convention as the rest of the API. Whether it be g;GetUniformXXX, glGetVertexAttribXXX, glGetSamplerParameterXXX, or anything else, the suffix is dropped and there is a single page with the base name that documents all variations together.

The only difference here is that shaders objects (currently) only have a single "get" function, and do not have -ui or -f suffixed variants, in which case it would be more obvious.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants