Fix glGetString documentation for GL_VERSION and GL_SHADING_LANGUAGE_…

…VERSION. Fix KhronosGroup#136
NogginBops · Mar 17, 2024 · e7b4c59 · e7b4c59
1 parent f50027c
commit e7b4c59
Show file tree

Hide file tree

Showing 11 changed files with 115 additions and 43 deletions.
diff --git a/es3.0/glGetString.xml b/es3.0/glGetString.xml
@@ -133,13 +133,16 @@
             by platform-recognition algorithms.
         </para>
         <para>
-            The <constant>GL_VERSION</constant> and <constant>GL_SHADING_LANGUAGE_VERSION</constant> strings begin with a version number.
-            The version number uses one
-            of these forms:
+            The <constant>GL_VERSION</constant> string is laid out as follows:
+            <blockquote><emphasis>OpenGL ES N.M vendor-specific information</emphasis></blockquote>
+            The <constant>GL_SHADING_LANGUAGE_VERSION</constant> string is laid out as follows:
+            <blockquote><emphasis>OpenGL ES GLSL ES N.M vendor-specific information</emphasis></blockquote>
         </para>
         <para>
-            <emphasis>major_number.minor_number</emphasis>
-            <emphasis>major_number.minor_number.release_number</emphasis>
+            The version number is either of the form <emphasis>major_number.minor_number</emphasis> or
+            <emphasis>major_number.minor_number.release_number</emphasis>, where the numbers all have one or more digits.
+            The minor number for SHADING_LANGUAGE_VERSION is always two digits, 
+            matching the OpenGL ES Shading Language Specification release number.
         </para>
         <para>
             Vendor-specific information may follow the version

diff --git a/es3.0/html/glGetString.xhtml b/es3.0/html/glGetString.xhtml
@@ -178,13 +178,32 @@
             by platform-recognition algorithms.
         </p>
         <p>
-            The <code class="constant">GL_VERSION</code> and <code class="constant">GL_SHADING_LANGUAGE_VERSION</code> strings begin with a version number.
-            The version number uses one
-            of these forms:
+            The <code class="constant">GL_VERSION</code> string is laid out as follows:
+            </p>
+        <div class="blockquote">
+          <blockquote class="blockquote">
+            <span class="emphasis">
+              <em>OpenGL ES N.M vendor-specific information</em>
+            </span>
+          </blockquote>
+        </div>
+        <p>
+            The <code class="constant">GL_SHADING_LANGUAGE_VERSION</code> string is laid out as follows:
+            </p>
+        <div class="blockquote">
+          <blockquote class="blockquote">
+            <span class="emphasis">
+              <em>OpenGL ES GLSL ES N.M vendor-specific information</em>
+            </span>
+          </blockquote>
+        </div>
+        <p>
         </p>
         <p>
-            <span class="emphasis"><em>major_number.minor_number</em></span>
-            <span class="emphasis"><em>major_number.minor_number.release_number</em></span>
+            The version number is either of the form <span class="emphasis"><em>major_number.minor_number</em></span> or
+            <span class="emphasis"><em>major_number.minor_number.release_number</em></span>, where the numbers all have one or more digits.
+            The minor number for SHADING_LANGUAGE_VERSION is always two digits, 
+            matching the OpenGL ES Shading Language Specification release number.
         </p>
         <p>
             Vendor-specific information may follow the version

diff --git a/es3.1/glGetString.xml b/es3.1/glGetString.xml
@@ -134,13 +134,16 @@
             by platform-recognition algorithms.
         </para>
         <para>
-            The <constant>GL_VERSION</constant> and <constant>GL_SHADING_LANGUAGE_VERSION</constant> strings begin with a version number.
-            The version number uses one
-            of these forms:
+            The <constant>GL_VERSION</constant> string is laid out as follows:
+            <blockquote><emphasis>OpenGL ES N.M vendor-specific information</emphasis></blockquote>
+            The <constant>GL_SHADING_LANGUAGE_VERSION</constant> string is laid out as follows:
+            <blockquote><emphasis>OpenGL ES GLSL ES N.M vendor-specific information</emphasis></blockquote>
         </para>
         <para>
-            <emphasis>major_number.minor_number</emphasis>
-            <emphasis>major_number.minor_number.release_number</emphasis>
+            The version number is either of the form <emphasis>major_number.minor_number</emphasis> or
+            <emphasis>major_number.minor_number.release_number</emphasis>, where the numbers all have one or more digits.
+            The minor number for SHADING_LANGUAGE_VERSION is always two digits, 
+            matching the OpenGL ES Shading Language Specification release number.
         </para>
         <para>
             Vendor-specific information may follow the version

diff --git a/es3.1/html/glGetString.xhtml b/es3.1/html/glGetString.xhtml
@@ -178,13 +178,32 @@
             by platform-recognition algorithms.
         </p>
         <p>
-            The <code class="constant">GL_VERSION</code> and <code class="constant">GL_SHADING_LANGUAGE_VERSION</code> strings begin with a version number.
-            The version number uses one
-            of these forms:
+            The <code class="constant">GL_VERSION</code> string is laid out as follows:
+            </p>
+        <div class="blockquote">
+          <blockquote class="blockquote">
+            <span class="emphasis">
+              <em>OpenGL ES N.M vendor-specific information</em>
+            </span>
+          </blockquote>
+        </div>
+        <p>
+            The <code class="constant">GL_SHADING_LANGUAGE_VERSION</code> string is laid out as follows:
+            </p>
+        <div class="blockquote">
+          <blockquote class="blockquote">
+            <span class="emphasis">
+              <em>OpenGL ES GLSL ES N.M vendor-specific information</em>
+            </span>
+          </blockquote>
+        </div>
+        <p>
         </p>
         <p>
-            <span class="emphasis"><em>major_number.minor_number</em></span>
-            <span class="emphasis"><em>major_number.minor_number.release_number</em></span>
+            The version number is either of the form <span class="emphasis"><em>major_number.minor_number</em></span> or
+            <span class="emphasis"><em>major_number.minor_number.release_number</em></span>, where the numbers all have one or more digits.
+            The minor number for SHADING_LANGUAGE_VERSION is always two digits, 
+            matching the OpenGL ES Shading Language Specification release number.
         </p>
         <p>
             Vendor-specific information may follow the version

diff --git a/es3.1/html/indexflat.php b/es3.1/html/indexflat.php
@@ -365,8 +365,8 @@
                 <li><a href="glMapBufferRange.xhtml" target="pagedisplay">glMapBufferRange</a></li>
                 <li><a href="matrixCompMult.xhtml" target="pagedisplay">matrixCompMult</a></li>
                 <li><a href="max.xhtml" target="pagedisplay">max</a></li>
-                <li><a href="memoryBarrier.xhtml" target="pagedisplay">memoryBarrier</a></li>
                 <li><a href="glMemoryBarrier.xhtml" target="pagedisplay">glMemoryBarrier</a></li>
+                <li><a href="memoryBarrier.xhtml" target="pagedisplay">memoryBarrier</a></li>
                 <li><a href="memoryBarrierAtomicCounter.xhtml" target="pagedisplay">memoryBarrierAtomicCounter</a></li>
                 <li><a href="memoryBarrierBuffer.xhtml" target="pagedisplay">memoryBarrierBuffer</a></li>
                 <li><a href="glMemoryBarrier.xhtml" target="pagedisplay">glMemoryBarrierByRegion</a></li>

diff --git a/es3/glGetString.xml b/es3/glGetString.xml
@@ -134,13 +134,16 @@
             by platform-recognition algorithms.
         </para>
         <para>
-            The <constant>GL_VERSION</constant> and <constant>GL_SHADING_LANGUAGE_VERSION</constant> strings begin with a version number.
-            The version number uses one
-            of these forms:
+            The <constant>GL_VERSION</constant> string is laid out as follows:
+            <blockquote><emphasis>OpenGL ES N.M vendor-specific information</emphasis></blockquote>
+            The <constant>GL_SHADING_LANGUAGE_VERSION</constant> string is laid out as follows:
+            <blockquote><emphasis>OpenGL ES GLSL ES N.M vendor-specific information</emphasis></blockquote>
         </para>
         <para>
-            <emphasis>major_number.minor_number</emphasis>
-            <emphasis>major_number.minor_number.release_number</emphasis>
+            The version number is either of the form <emphasis>major_number.minor_number</emphasis> or
+            <emphasis>major_number.minor_number.release_number</emphasis>, where the numbers all have one or more digits.
+            The minor number for SHADING_LANGUAGE_VERSION is always two digits, 
+            matching the OpenGL ES Shading Language Specification release number.
         </para>
         <para>
             Vendor-specific information may follow the version

diff --git a/es3/html/glGetString.xhtml b/es3/html/glGetString.xhtml
@@ -178,13 +178,32 @@
             by platform-recognition algorithms.
         </p>
         <p>
-            The <code class="constant">GL_VERSION</code> and <code class="constant">GL_SHADING_LANGUAGE_VERSION</code> strings begin with a version number.
-            The version number uses one
-            of these forms:
+            The <code class="constant">GL_VERSION</code> string is laid out as follows:
+            </p>
+        <div class="blockquote">
+          <blockquote class="blockquote">
+            <span class="emphasis">
+              <em>OpenGL ES N.M vendor-specific information</em>
+            </span>
+          </blockquote>
+        </div>
+        <p>
+            The <code class="constant">GL_SHADING_LANGUAGE_VERSION</code> string is laid out as follows:
+            </p>
+        <div class="blockquote">
+          <blockquote class="blockquote">
+            <span class="emphasis">
+              <em>OpenGL ES GLSL ES N.M vendor-specific information</em>
+            </span>
+          </blockquote>
+        </div>
+        <p>
         </p>
         <p>
-            <span class="emphasis"><em>major_number.minor_number</em></span>
-            <span class="emphasis"><em>major_number.minor_number.release_number</em></span>
+            The version number is either of the form <span class="emphasis"><em>major_number.minor_number</em></span> or
+            <span class="emphasis"><em>major_number.minor_number.release_number</em></span>, where the numbers all have one or more digits.
+            The minor number for SHADING_LANGUAGE_VERSION is always two digits, 
+            matching the OpenGL ES Shading Language Specification release number.
         </p>
         <p>
             Vendor-specific information may follow the version

diff --git a/es3/html/indexflat.php b/es3/html/indexflat.php
@@ -422,8 +422,8 @@
                 <li><a href="glMapBufferRange.xhtml" target="pagedisplay">glMapBufferRange</a></li>
                 <li><a href="matrixCompMult.xhtml" target="pagedisplay">matrixCompMult</a></li>
                 <li><a href="max.xhtml" target="pagedisplay">max</a></li>
-                <li><a href="memoryBarrier.xhtml" target="pagedisplay">memoryBarrier</a></li>
                 <li><a href="glMemoryBarrier.xhtml" target="pagedisplay">glMemoryBarrier</a></li>
+                <li><a href="memoryBarrier.xhtml" target="pagedisplay">memoryBarrier</a></li>
                 <li><a href="memoryBarrierAtomicCounter.xhtml" target="pagedisplay">memoryBarrierAtomicCounter</a></li>
                 <li><a href="memoryBarrierBuffer.xhtml" target="pagedisplay">memoryBarrierBuffer</a></li>
                 <li><a href="glMemoryBarrier.xhtml" target="pagedisplay">glMemoryBarrierByRegion</a></li>

diff --git a/gl4/glGetString.xml b/gl4/glGetString.xml
@@ -125,13 +125,14 @@
             by platform-recognition algorithms.
         </para>
         <para>
-            The <constant>GL_VERSION</constant> and <constant>GL_SHADING_LANGUAGE_VERSION</constant> strings begin with a version number.
-            The version number uses one
-            of these forms:
+            The <constant>GL_VERSION</constant> and <constant>GL_SHADING_LANGUAGE_VERSION</constant> strings are laid out as follows:
+            <blockquote><emphasis>&lt;version number&gt;&lt;space&gt;&lt;vendor-specific information&gt;</emphasis></blockquote>
         </para>
         <para>
-            <emphasis>major_number.minor_number</emphasis>
-            <emphasis>major_number.minor_number.release_number</emphasis>
+            The version number is either of the form <emphasis>major_number.minor_number</emphasis> or
+            <emphasis>major_number.minor_number.release_number</emphasis>, where the numbers all have one or more digits.
+            The minor number for SHADING_LANGUAGE_VERSION is always two digits, 
+            matching the OpenGL ES Shading Language Specification release number.
         </para>
         <para>
             Vendor-specific information may follow the version

diff --git a/gl4/html/glGetString.xhtml b/gl4/html/glGetString.xhtml
@@ -168,13 +168,18 @@
             by platform-recognition algorithms.
         </p>
         <p>
-            The <code class="constant">GL_VERSION</code> and <code class="constant">GL_SHADING_LANGUAGE_VERSION</code> strings begin with a version number.
-            The version number uses one
-            of these forms:
+            The <code class="constant">GL_VERSION</code> and <code class="constant">GL_SHADING_LANGUAGE_VERSION</code> strings are laid out as follows:
+            </p>
+        <div class="blockquote">
+          <blockquote class="blockquote">&lt;version number&gt;&lt;space&gt;&lt;vendor-specific information&gt;</blockquote>
+        </div>
+        <p>
         </p>
         <p>
-            <span class="emphasis"><em>major_number.minor_number</em></span>
-            <span class="emphasis"><em>major_number.minor_number.release_number</em></span>
+            The version number is either of the form <span class="emphasis"><em>major_number.minor_number</em></span> or
+            <span class="emphasis"><em>major_number.minor_number.release_number</em></span>, where the numbers all have one or more digits.
+            The minor number for SHADING_LANGUAGE_VERSION is always two digits, 
+            matching the OpenGL ES Shading Language Specification release number.
         </p>
         <p>
             Vendor-specific information may follow the version

diff --git a/gl4/html/indexflat.php b/gl4/html/indexflat.php
@@ -582,8 +582,8 @@
                 <li><a href="glMapBufferRange.xhtml" target="pagedisplay">glMapNamedBufferRange</a></li>
                 <li><a href="matrixCompMult.xhtml" target="pagedisplay">matrixCompMult</a></li>
                 <li><a href="max.xhtml" target="pagedisplay">max</a></li>
-                <li><a href="memoryBarrier.xhtml" target="pagedisplay">memoryBarrier</a></li>
                 <li><a href="glMemoryBarrier.xhtml" target="pagedisplay">glMemoryBarrier</a></li>
+                <li><a href="memoryBarrier.xhtml" target="pagedisplay">memoryBarrier</a></li>
                 <li><a href="memoryBarrierAtomicCounter.xhtml" target="pagedisplay">memoryBarrierAtomicCounter</a></li>
                 <li><a href="memoryBarrierBuffer.xhtml" target="pagedisplay">memoryBarrierBuffer</a></li>
                 <li><a href="glMemoryBarrier.xhtml" target="pagedisplay">glMemoryBarrierByRegion</a></li>