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

Fixed gl*Draw*Indirect indirect parameter documentation for gl4 #148

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion es3.1/html/indexflat.php
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion es3/html/indexflat.php
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 4 additions & 2 deletions gl4/glDrawArraysIndirect.xml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@
<term><parameter>indirect</parameter></term>
<listitem>
<para>
Specifies the address of a structure containing the draw parameters.
Specifies a byte offset (cast to a pointer type) into the buffer bound to <constant>GL_DRAW_INDIRECT_BUFFER</constant>
to start reading indirect draw parameters from.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -85,7 +86,8 @@
If a buffer is bound to the <constant>GL_DRAW_INDIRECT_BUFFER</constant> binding at the time
of a call to <function>glDrawArraysIndirect</function>, <parameter>indirect</parameter>
is interpreted as an offset, in basic machine units, into that buffer and the parameter
data is read from the buffer rather than from client memory.
data is read from the buffer. If no buffer is bound to the
<constant>GL_ELEMENT_ARRAY_BUFFER</constant> binding, an error will be generated.
</para>
<para>
In contrast to <citerefentry><refentrytitle>glDrawArraysInstancedBaseInstance</refentrytitle></citerefentry>,
Expand Down
8 changes: 3 additions & 5 deletions gl4/glDrawElementsIndirect.xml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@
<term><parameter>indirect</parameter></term>
<listitem>
<para>
Specifies the address of a structure containing the draw parameters.
Specifies a byte offset (cast to a pointer type) into the buffer bound to <constant>GL_DRAW_INDIRECT_BUFFER</constant>
to start reading indirect draw parameters from.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -108,10 +109,7 @@
If a buffer is bound to the <constant>GL_DRAW_INDIRECT_BUFFER</constant> binding at the time
of a call to <function>glDrawElementsIndirect</function>, <parameter>indirect</parameter>
is interpreted as an offset, in basic machine units, into that buffer and the parameter
data is read from the buffer rather than from client memory.
</para>
<para>
Note that indices stored in client memory are not supported. If no buffer is bound to the
data is read from the buffer. If no buffer is bound to the
<constant>GL_ELEMENT_ARRAY_BUFFER</constant> binding, an error will be generated.
</para>
<para>
Expand Down
6 changes: 4 additions & 2 deletions gl4/glMultiDrawArraysIndirect.xml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@
<term><parameter>indirect</parameter></term>
<listitem>
<para>
Specifies the address of an array of structures containing the draw parameters.
Specifies a byte offset (cast to a pointer type) into the buffer bound to <constant>GL_DRAW_INDIRECT_BUFFER</constant>
to start reading indirect draw parameters from.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -117,7 +118,8 @@
If a buffer is bound to the <constant>GL_DRAW_INDIRECT_BUFFER</constant> binding at the time
of a call to <function>glMultiDrawArraysIndirect</function>, <parameter>indirect</parameter>
is interpreted as an offset, in basic machine units, into that buffer and the parameter
data is read from the buffer rather than from client memory.
data is read from the buffer. If no buffer is bound to the
<constant>GL_ELEMENT_ARRAY_BUFFER</constant> binding, an error will be generated.
</para>
<para>
In contrast to <citerefentry><refentrytitle>glDrawArraysInstancedBaseInstance</refentrytitle></citerefentry>,
Expand Down
8 changes: 3 additions & 5 deletions gl4/glMultiDrawElementsIndirect.xml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@
<term><parameter>indirect</parameter></term>
<listitem>
<para>
Specifies the address of a structure containing an array of draw parameters.
Specifies a byte offset (cast to a pointer type) into the buffer bound to <constant>GL_DRAW_INDIRECT_BUFFER</constant>
to start reading indirect draw parameters from.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -133,10 +134,7 @@
If a buffer is bound to the <constant>GL_DRAW_INDIRECT_BUFFER</constant> binding at the time
of a call to <function>glDrawElementsIndirect</function>, <parameter>indirect</parameter>
is interpreted as an offset, in basic machine units, into that buffer and the parameter
data is read from the buffer rather than from client memory.
</para>
<para>
Note that indices stored in client memory are not supported. If no buffer is bound to the
data is read from the buffer. If no buffer is bound to the
<constant>GL_ELEMENT_ARRAY_BUFFER</constant> binding, an error will be generated.
</para>
<para>
Expand Down
6 changes: 4 additions & 2 deletions gl4/html/glDrawArraysIndirect.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,8 @@
</dt>
<dd>
<p>
Specifies the address of a structure containing the draw parameters.
Specifies a byte offset (cast to a pointer type) into the buffer bound to <code class="constant">GL_DRAW_INDIRECT_BUFFER</code>
to start reading indirect draw parameters from.
</p>
</dd>
</dl>
Expand Down Expand Up @@ -115,7 +116,8 @@
If a buffer is bound to the <code class="constant">GL_DRAW_INDIRECT_BUFFER</code> binding at the time
of a call to <code class="function">glDrawArraysIndirect</code>, <em class="parameter"><code>indirect</code></em>
is interpreted as an offset, in basic machine units, into that buffer and the parameter
data is read from the buffer rather than from client memory.
data is read from the buffer. If no buffer is bound to the
<code class="constant">GL_ELEMENT_ARRAY_BUFFER</code> binding, an error will be generated.
</p>
<p>
In contrast to <a class="citerefentry" href="glDrawArraysInstancedBaseInstance.xhtml"><span class="citerefentry"><span class="refentrytitle">glDrawArraysInstancedBaseInstance</span></span></a>,
Expand Down
8 changes: 3 additions & 5 deletions gl4/html/glDrawElementsIndirect.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,8 @@
</dt>
<dd>
<p>
Specifies the address of a structure containing the draw parameters.
Specifies a byte offset (cast to a pointer type) into the buffer bound to <code class="constant">GL_DRAW_INDIRECT_BUFFER</code>
to start reading indirect draw parameters from.
</p>
</dd>
</dl>
Expand Down Expand Up @@ -144,10 +145,7 @@
If a buffer is bound to the <code class="constant">GL_DRAW_INDIRECT_BUFFER</code> binding at the time
of a call to <code class="function">glDrawElementsIndirect</code>, <em class="parameter"><code>indirect</code></em>
is interpreted as an offset, in basic machine units, into that buffer and the parameter
data is read from the buffer rather than from client memory.
</p>
<p>
Note that indices stored in client memory are not supported. If no buffer is bound to the
data is read from the buffer. If no buffer is bound to the
<code class="constant">GL_ELEMENT_ARRAY_BUFFER</code> binding, an error will be generated.
</p>
<p>
Expand Down
6 changes: 4 additions & 2 deletions gl4/html/glMultiDrawArraysIndirect.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,8 @@
</dt>
<dd>
<p>
Specifies the address of an array of structures containing the draw parameters.
Specifies a byte offset (cast to a pointer type) into the buffer bound to <code class="constant">GL_DRAW_INDIRECT_BUFFER</code>
to start reading indirect draw parameters from.
</p>
</dd>
<dt>
Expand Down Expand Up @@ -163,7 +164,8 @@
If a buffer is bound to the <code class="constant">GL_DRAW_INDIRECT_BUFFER</code> binding at the time
of a call to <code class="function">glMultiDrawArraysIndirect</code>, <em class="parameter"><code>indirect</code></em>
is interpreted as an offset, in basic machine units, into that buffer and the parameter
data is read from the buffer rather than from client memory.
data is read from the buffer. If no buffer is bound to the
<code class="constant">GL_ELEMENT_ARRAY_BUFFER</code> binding, an error will be generated.
</p>
<p>
In contrast to <a class="citerefentry" href="glDrawArraysInstancedBaseInstance.xhtml"><span class="citerefentry"><span class="refentrytitle">glDrawArraysInstancedBaseInstance</span></span></a>,
Expand Down
8 changes: 3 additions & 5 deletions gl4/html/glMultiDrawElementsIndirect.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@
</dt>
<dd>
<p>
Specifies the address of a structure containing an array of draw parameters.
Specifies a byte offset (cast to a pointer type) into the buffer bound to <code class="constant">GL_DRAW_INDIRECT_BUFFER</code>
to start reading indirect draw parameters from.
</p>
</dd>
<dt>
Expand Down Expand Up @@ -186,10 +187,7 @@
If a buffer is bound to the <code class="constant">GL_DRAW_INDIRECT_BUFFER</code> binding at the time
of a call to <code class="function">glDrawElementsIndirect</code>, <em class="parameter"><code>indirect</code></em>
is interpreted as an offset, in basic machine units, into that buffer and the parameter
data is read from the buffer rather than from client memory.
</p>
<p>
Note that indices stored in client memory are not supported. If no buffer is bound to the
data is read from the buffer. If no buffer is bound to the
<code class="constant">GL_ELEMENT_ARRAY_BUFFER</code> binding, an error will be generated.
</p>
<p>
Expand Down
2 changes: 1 addition & 1 deletion gl4/html/indexflat.php
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down