HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> | |
| 3 | <!-- saved from url=(0013)about:internet --> | |
| 4 | <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glScissorArray - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glScissorArray"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glScissorArray — define the scissor box for multiple viewports</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glScissorArrayv</b>(</code></td><td>GLuint </td><td><var class="pdparam">first</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">count</var>, </td></tr><tr><td> </td><td>const GLint * </td><td><var class="pdparam">v</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>first</code></em></span></dt><dd><p> | |
| 5 | Specifies the index of the first viewport whose scissor box to modify. | |
| 6 | </p></dd><dt><span class="term"><em class="parameter"><code>count</code></em></span></dt><dd><p> | |
| 7 | Specifies the number of scissor boxes to modify. | |
| 8 | </p></dd><dt><span class="term"><em class="parameter"><code>v</code></em></span></dt><dd><p> | |
| 9 | Specifies the address of an array containing the left, bottom, width and height of each | |
| 10 | scissor box, in that order. | |
| 11 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
| 12 | <code class="function">glScissorArrayv</code> defines rectangles, called scissor boxes, | |
| 13 | in window coordinates for each viewport. | |
| 14 | <em class="parameter"><code>first</code></em> specifies the index of the first scissor box to modify and | |
| 15 | <em class="parameter"><code>count</code></em> specifies the number of scissor boxes to modify. <em class="parameter"><code>first</code></em> | |
| 16 | must be less than the value of <code class="constant">GL_MAX_VIEWPORTS</code>, and <em class="parameter"><code>first</code></em> + | |
| 17 | <em class="parameter"><code>count</code></em> must be less than or equal to the value of <code class="constant">GL_MAX_VIEWPORTS</code>. | |
| 18 | <em class="parameter"><code>v</code></em> specifies the address of an array containing integers specifying the | |
| 19 | lower left corner of the scissor boxes, and the width and height of the scissor boxes, in that order. | |
| 20 | </p><p> | |
| 21 | To enable and disable the scissor test, call | |
| 22 | <a href="glEnable.xml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a> and <a href="glDisable.xml"><span class="citerefentry"><span class="refentrytitle">glDisable</span></span></a> with argument | |
| 23 | <code class="constant">GL_SCISSOR_TEST</code>. The test is initially disabled for all viewports. | |
| 24 | While the test is enabled, only pixels that lie within the scissor box | |
| 25 | can be modified by drawing commands. | |
| 26 | Window coordinates have integer values at the shared corners of | |
| 27 | frame buffer pixels. | |
| 28 | <code class="code">glScissor(0,0,1,1)</code> allows modification of only the lower left | |
| 29 | pixel in the window, and <code class="code">glScissor(0,0,0,0)</code> doesn't allow | |
| 30 | modification of any pixels in the window. | |
| 31 | </p><p> | |
| 32 | When the scissor test is disabled, | |
| 33 | it is as though the scissor box includes the entire window. | |
| 34 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
| 35 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>first</code></em> is greater than or equal to | |
| 36 | the value of <code class="constant">GL_MAX_VIEWPORTS</code>. | |
| 37 | </p><p> | |
| 38 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>first</code></em> + <em class="parameter"><code>count</code></em> | |
| 39 | is greater than or equal to the value of <code class="constant">GL_MAX_VIEWPORTS</code>. | |
| 40 | </p><p> | |
| 41 | <code class="constant">GL_INVALID_VALUE</code> is generated if any width or height specified in the array <em class="parameter"><code>v</code></em> is negative. | |
| 42 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> | |
| 43 | <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_SCISSOR_BOX</code> | |
| 44 | </p><p> | |
| 45 | <a href="glIsEnabled.xml"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a> with argument <code class="constant">GL_SCISSOR_TEST</code> | |
| 46 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
| 47 | <a href="glEnable.xml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a>, | |
| 48 | <a href="glViewport.xml"><span class="citerefentry"><span class="refentrytitle">glViewport</span></span></a>, | |
| 49 | <a href="glViewportIndexed.xml"><span class="citerefentry"><span class="refentrytitle">glViewportIndexed</span></span></a>, | |
| 50 | <a href="glViewportArray.xml"><span class="citerefentry"><span class="refentrytitle">glViewportArray</span></span></a> | |
| 51 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
| 52 | Copyright <span class="trademark"></span>© 2010 Khronos Group. | |
| 53 | This material may be distributed subject to the terms and conditions set forth in | |
| 54 | the Open Publication License, v 1.0, 8 June 1999. | |
| 55 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
| 56 | </p></div></div></body></html> |