bsvino / docs.gl Goto Github PK

As titled

http://docs.gl/gl4/glGetTextureParameter

or http://docs.gl/gl4/glGetTextureParameteri

Hey, seems like on the glTex[Sub]Image* pages, for the format parameter, it lists:

GL_RED, GL_RG, GL_RGB, GL_BGR, GL_RGBA, and GL_BGRA

but does not include the _INTEGER variants, which seem to be required for using integer internalFormats (such as GL_R16UI).

Maybe other pages are affected too, not sure. Those are just the ones I noticed (when trying to figure out why using GL_R16UI and GL_RED didn't work).

It doesn't look so nice with the default 'Times New Roman' fallback.

Great job, btw!

I was wondering. As Vulkan specs are now released, is there any hope to have the same documentation layout used for docs.gl but for vulkan, like docs.vk?

docs.gl is my number one OpenGL reference for many reasons and I would love to have the same for Vulkan.

Keep the good work.

The documentation for this function is missing, i could find anything about it.

Like, how do I know which version support Pixel Buffer Object ?

i realize WebGL is 'based on' OpenGL ES 2.0, and is maybe more of an API than a language specification, but i think some mention should be made. Ideally it would have it's tab, but with browser and device support as tags. thank you!

http://docs.gl/gl3/glUnmapBuffer automatically redirects to http://docs.gl/gl3/glMapBuffer.

Hello,

the domain name docs.gl no longer seems to resolve DNS requests.

Exhibit A:

nitrix@s1:~$ dig docs.gl ANY

; <<>> DiG 9.11.3-1ubuntu1.14-Ubuntu <<>> docs.gl ANY
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 12024
;; flags: qr rd ra; QUERY: 1, ANSWER: 0, AUTHORITY: 0, ADDITIONAL: 1

;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 4096
; COOKIE: d7d1cf3dda11220d75e3de2460510f90cc1472701131a13c (good)
;; QUESTION SECTION:
;docs.gl.                       IN      ANY

;; Query time: 424 msec
;; SERVER: 127.0.0.1#53(127.0.0.1)
;; WHEN: Tue Mar 16 20:05:36 UTC 2021
;; MSG SIZE  rcvd: 64

Exhibit B:

nitrix@s1:~$ dig @1.1.1.1 docs.gl ANY

; <<>> DiG 9.11.3-1ubuntu1.14-Ubuntu <<>> @1.1.1.1 docs.gl ANY
; (1 server found)
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOTIMP, id: 32031
;; flags: qr rd ra; QUERY: 1, ANSWER: 0, AUTHORITY: 0, ADDITIONAL: 1

;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 1232
;; QUESTION SECTION:
;docs.gl.                       IN      ANY

;; Query time: 13 msec
;; SERVER: 1.1.1.1#53(1.1.1.1)
;; WHEN: Tue Mar 16 20:10:52 UTC 2021
;; MSG SIZE  rcvd: 36

Exhibit C:
https://docs.gl/

hello! the document at http://docs.gl/el3/smoothstep says Results are undefined if edge0 ≥ edge1. i have been working with shaders in max/msp/jitter in GLSL #version 330 and find that if `edge0 > edge1', the result is not undefined, rather the behavior is simply inverted. i am not sure whether this is an error in your documentation or just an eccentricity/enhancement of cycling 74's implementation, but i figured i would report in nonetheless!

As title, is this official OpenGL documentation approved by Khronos?

http://docs.gl/gl4/glClipControl

Presumably those should each render as a mathematical formula.

I work with C# and P/Invoke directly into OpenGL (i.e. not using something like OpenTK). I regularly have to look up the values of enums such as GL_MAX_VERTEX_ATTRIBS. It would be quite helpful if there was a page where the values of the enums were listed.

Thank you very much for your work.

Hi there,
We're interested in using docs.gl as a basis for the documentation site for our project. Just wanted to give you a heads up, and to double check that so long as all the GL documentation is purged, that should be okay, with the Javascript and HTML, etc.

Sorry for clogging up your issues, seemed like the easiest way to ask.

docs.gl is down.

If you go for example to http://docs.gl/gl4/glBufferStorage and search for some command and select it, you still have to press Go button to redirect to that page.

The alternative as per http://stackoverflow.com/questions/25952401/declaring-xml-namespaces-for-mathml/25968000?iemail=1&noredirect=1#25968000 is to convert the entire site into xhtml.

My browser's font size is configured to be slightly larger than usual. docs.gl does not respect that setting because it uses absolute px values for font sizing. Consider changing font-size values to rem so that it more closely aligns with the reader's desires.

As titled, all the params are explained except GL_TEXTURE_LOD_BIAS

With SSL/TLS certificates being available for free and minimal impact with regard to performance (if any), it would be nice if docs.gl was hosted over https instead of http.

From discussion on #13 -

For aliased functions (like glUniform3f -> glUniform or glEnablei -> glEnable) it would be useful to have search results match when they are entered, and return the target of the alias function in the search results instead of nothing.

On top of that, if there is a 404 page for when an invalid page is specified (e.g. http://docs.gl/gl4/glNotFound) this page should check to see if the page is an alias source, and if so redirect to the alias target.

Currently I'm trying to create Qt help files for OpenGL using your documentation (and it's fantastic)! But qhelpgenerator, the tool that creates help archives for Qt Creator seems to omit HTML files without extension.
I use Python to convert all links to .html and rename all files appropriately but it does not seem like a good solution.
(for anyone interested it's there: https://github.com/pashazz/docsgl-qt)

Would pretty useful if main search box was automatically focused on $(document).ready.

Just a suggestion, I personally would find better wgl documentation quite useful, as the existing wgl documentation is quite poor.

It appears that the HTTPS certificate for docs.gl expired on 19 August. Users visiting https://docs.gl will see a message similar to this:

Issue occurs for myself on the following browsers with Windows 10 x64;
Google Chrome 48.0.2564.97 m
Internet Explorer 11.63.10586.0

Steps to reproduce;
Navigate to any doc and the command_categories on the left-side will remain closed, although the expansion arrow will indicate that the category should be open.

Clicking the category title twice will reshow the contents - indicating that the state is correctly set as 'expanded' but the contents are displayed as 'hidden'.

Chrome;

Internet Explorer 11;

Firefox (Expected result);

Safari, Chrome and Firefox for OS X also get the expected result (Issue seems to occur only on Windows).

Going to http://www.docs.gl gives the same 5 for $5 bundle content as going to http://www.buygamesnotsocks.com. The actual content is only served on http://docs.gl.

Presumably some kind of server misconfiguration, as it seems like both of those sites are hosted on the same IP.

Reported on the LWJGL slack originally.

Not sure on feasibility, but I can ask for the moon right?

It would be nice in the toggle at the top to define intersections of apis like ES 2 and GL 4

If I'm in the page http://docs.gl/gl3/glDrawArrays, and search for glBindVertexBuffer I am probably looking for the gl3 version.

I think it'd be a good idea to show that at the top.

When transitioning from one page to another I can see white background for an instant.
It's a bit hard on the eyes to see this abrupt white flash.
It looks like the flash is more apparent in Firefox. In Chrome is not noticeable most of the times but happens as well sometimes.
I'm not sure if this is an easy thing to fix or it's a browser issue.

See:

glEndList()
glNewList()

I'm not sure how feasible is this, but I'm requesting anyway:
Documentation for GLSL just as for GL.

There's a small typo in the documentation for glFramebufferTexture in the paragraph that begins with

If texture is non-zero, the specified level of the texture object...

where it says "framebfufer" instead of "framebuffer".

Hi Rodriguez or whoever is maintaining this...

I thought it would be useful if one could hover over the search results and with a small delay, show a mini view of the docs of the function in a popover. For example, if I quickly wanted to lookup clamp and I searched for it and hovered over the glsl4 link, I would be able to see something like what the quick documentation of intelliJ shows. I've attached a picture to give a quick and dirty idea of what I mean.

Let me know if you think it's a good idea.

The offline version downloaded from About cannot be used normally without internet.

The Problem:

• Without internet, the left sidebar links, search and MathJax rendering, etc are completely not functional.

Temporary Solutions:

• I just batch replace all the external links to jquery.min.js, jquery-ui.min.js from every file to links to local disk versions of these files, and it seems works out fine. (MathJax is not working of course)
• And batch replace the all the home logo links on top left to href="../index.html".

Maybe we can do these at the build process?

Noticed on es3/glDrawArrays, The vertex array example, https://github.com/BSVino/docs.gl/blob/master/html/examples/vertexarray_draw.htm#L11
calls:

glDrawArrays(GL_TRIANGLES, 0, vertex_data);

but also states that // vertex_data is a float*, 3 per vertex, where as far as I can tell this function always takes a GLint - so it should probably be a count of the vertex data instead. (I do not know the context of the examples, so cannot give a precise suggestion, assuming that this is a real error).

hey, great initiative with docs.gl. I have downloaded bundle for offline use. It appears to be a set of files, one per each gl function. I see that it's in fact html code inside...

Is there's an easy way to include docs.gl into VSCode for verbose feedback of OpenGL functions?
I am looking for particular implementation: when working with WebGL canvas API context in js and ts files and I think it would be really helpful. I guess it would require some kind of lookup of the function name in the folder with docs and then outputting it in vscode intellisense/hint window. Has someone tried that? It would be great use case for docs.gl.

I know that the official refpages don't list the compressed formats for the glTexStorage* formats, but they're perfectly valid, so it might be a nice addition if they showed up in the docs.gl pages as well.

Although this might be pushing it, but it would be cool if (even though they're extensions) the S3TC formats showed up there as well, since they're so common and pretty much universally supported, as per this page.

This happens for me using Google Chrome 44 (full version name 44.0.2403.125 m) on Windows 8.1. As far as I know the "autofocus" attribute, which exists on the search field tag, should work on this version of Chrome.

The website says this:

vec4(Sample_i0_j1(P, base).comp,
     Sample_i1_j1(P, base).comp,
     Sample_i1_j0(P, base).comp,
     Sample_i0_j1(P, base).comp);

But the GLSL specification says this:

vec4(Sample_i0_j1(P, base).comp,
     Sample_i1_j1(P, base).comp,
     Sample_i1_j0(P, base).comp,
     Sample_i0_j0(P, base).comp);

Note the last one, with the 0,0 i,j value.

This mistake is also in the textureGatherOffset and textureGatherOffsets functions.

OpenGL ES in does exist in github repo, https://github.com/BSVino/docs.gl/blob/master/es1, but failed to query in docs.gl.
e.g. http://docs.gl/es1/glMaterial

It would appear that the signature for glClearNamedFramebufferfi on page http://docs.gl/gl4/glClearBuffer is missing a parameter. According to https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/glClearBuffer.xhtml the parameter drawBuffer should be included.

The signature should be:

void glClearNamedFramebufferfi(GLuint framebuffer, GLenum buffer, GLint drawbuffer, GLfloat depth, GLint stencil);

Tested in Chrome 46.0.2486.0-dev (Mac OS X 10.10.5).

On the OpenGL ES2, OpenGL 2, and OpenGL 3 versions of the glBufferData docs page, the following snippet appears under the "notes" section:

(Some other text actually briefly appears on the page after refreshing. No errors appear in the Chrome inspector console log.)

Hi! 😄

On the page for glGetInternalformativ(), GL_TEXTURE_2D_MULTISAMPLE is mentioned, which is correct for GLES 3.1, but not for GLES 3.0, which can only accept GL_RENDERBUFFER as a target.

References:
GLES 3.0: https://www.khronos.org/opengles/sdk/docs/man3/html/glGetInternalformativ.xhtml
GLES 3.1: https://www.khronos.org/opengles/sdk/docs/man31/html/glGetInternalformativ.xhtml

The script that I used to add {$examples} must have failed somehow for some pages.

This is an excellent OpenGL resource - however, on first load, the site seems to animate opening all the categories in the sidebar and then immediately closing them again. After they are closed, the currently selected category is opened. It makes it quite to annoying to browse around. Switching API version or pressing the 'Hide Unavailable' button also seems to open+close the menus.

It would be really great to show fallback implementation examples via extensions, i.e. if a certain function can be used in older versions of OpenGL via an extension that should be shown.

glDrawArrays can fail (GL_INVALID_OPERATION) if there is no Vertex Array Object bound (core profile only). This is not currently specified. (I believe that similar issues may be present for other glDraw* commands but I am not sure).

The "Edit this page" link at the very bottom of each docs.gl page links to the master branch, but the main an most up-to-date branch on the repo seems to be mainline. I don't know if it's intentional or just an oversight, but just opening an issue in case.