OpenGL API Documentation • Hacker News Board

Re: OpenGL API Documentation

#41

Post by BSVino » Fri, Jun 19, 2015, 9:52 PM UTC

vitd wrote: post #39

This looks useful as a quick reference and it's very nicely laid out. Nice work! I'm a little disappointed that the text is essentially the same as the man pages, which means all the same failings. It would be great if there was actually useful text in there. For example, this little zinger: "glBindTexture lets you create or use a named texture." It mentions in this single sentence that it lets you create a texture,…

Hello, dev of docs.gl here.

The entire site is here: https://github.com/BSVino/docs.gl

I would love for people help improve the language, which I agree is terrible in places. I don't consider myself an OpenGL expert so I haven't tried to improve the language except in places I know very well. That's why I went for including examples instead of reworking the language. But I would be thrilled if some good writers helped clean it up and expand and clarify etc.

Thank you for the feedback. :)

Re: OpenGL API Documentation

#42

Post by BSVino » Fri, Jun 19, 2015, 9:58 PM UTC

blindside wrote: post #3

Looks nice, but for example this: http://docs.gl/es3/glBindImageTexture has less error codes than this: https://www.khronos.org/opengles/sdk/docs/man31/html/glBindI... Is this generated from khronos itself or some other sneaky way?

Hello, dev of web.gl here.

I scraped the docs from the Khronos website when I started the project, about ten months ago. They may be getting out of date by now. At some point I intend to check out all of the changes that Khronos has made since them and apply them to docs.gl. Help maintaining it would be much appreciated :)

I went to add the additional error code and I noticed that Khronos says the invalid operation error should be thrown if texture is NOT the name of an immutable texture object. Is it me or is that not a copy paste error that shouldn't be there?

Re: OpenGL API Documentation

#43

Post by BSVino » Fri, Jun 19, 2015, 9:59 PM UTC

ronjouch wrote: post #16

As a complete newcomer to OpenGL, my first thought was "where's the WebGL column?" Now, that makes probably no sense; can someone clarify what these versions mean (apart from API availability described by this table, obviously), and if there's a relationship to the WebGL subset (it is a subset, right?).

Hello, dev of docs.gl here. I would be happy to support WebGL but I don't use it myself so I've not prioritized adding it. I'm happy to work with any enterprising person who wants to help add it :)

Re: OpenGL API Documentation

#44

Post by BSVino » Fri, Jun 19, 2015, 10:01 PM UTC

DanAndersen wrote: post #37

One suggestion: see if there's a way to preserve the "dark" background between page loads. If you select Dark, then go to another page, it initially loads in Light before flashing to Dark. I imagine that this would be unwanted if using Dark at night.

Hello, dev of web.gl here. It should be preserving automatically. If it doesn't, that's a bug. What browser/OS are you on?