upstream-man-pages/man4/xhtml/glScissorIndexed.xml

   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>glScissorIndexed - 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="glScissorIndexed"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glScissorIndexed — define the scissor box for a specific viewport</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">void <b class="fsfunc">glScissorIndexed</b>(</code></td><td>GLuint  </td><td><var class="pdparam">index</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">left</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">bottom</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">width</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">height</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glScissorIndexedv</b>(</code></td><td>GLuint  </td><td><var class="pdparam">index</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>index</code></em></span></dt><dd><p>
   5                 Specifies the index of the viewport whose scissor box to modify.
   6             </p></dd><dt><span class="term"><em class="parameter"><code>left</code></em>, </span><span class="term"><em class="parameter"><code>bottom</code></em></span></dt><dd><p>
   7                 Specify the coordinate of the bottom left corner of the scissor box, in pixels.
   8             </p></dd><dt><span class="term"><em class="parameter"><code>width</code></em>, </span><span class="term"><em class="parameter"><code>height</code></em></span></dt><dd><p>
   9                 Specify ths dimensions of the scissor box, in pixels.
  10             </p></dd><dt><span class="term"><em class="parameter"><code>v</code></em></span></dt><dd><p>
  11                 For <code class="function">glScissorIndexedv</code>, specifies the address of an array containing the left, bottom, width and height of each
  12                 scissor box, in that order.
  13             </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  14             <code class="function">glScissorIndexed</code> defines the scissor box for a specified viewport.
  15             <em class="parameter"><code>index</code></em> specifies the index of scissor box to modify.
  16             <em class="parameter"><code>index</code></em> must be less than the value of <code class="constant">GL_MAX_VIEWPORTS</code>.
  17             For <code class="function">glScissorIndexed</code>, <em class="parameter"><code>left</code></em>, <em class="parameter"><code>bottom</code></em>,
  18             <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em> specify the left, bottom, width
  19             and height of the scissor box, in pixels, respectively.
  20             For <code class="function">glScissorIndexedv</code>, <em class="parameter"><code>v</code></em> specifies the address of an
  21             array containing integers specifying the lower left corner of the scissor box, and the width and
  22             height of the scissor box, in that order.
  23         </p><p>
  24             To enable and disable the scissor test, call
  25             <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
  26             <code class="constant">GL_SCISSOR_TEST</code>. The test is initially disabled for all viewports.
  27             While the test is enabled, only pixels that lie within the scissor box
  28             can be modified by drawing commands.
  29             Window coordinates have integer values at the shared corners of
  30             frame buffer pixels.
  31             <code class="code">glScissor(0,0,1,1)</code> allows modification of only the lower left
  32             pixel in the window, and <code class="code">glScissor(0,0,0,0)</code> doesn't allow
  33             modification of any pixels in the window.
  34         </p><p>
  35             When the scissor test is disabled,
  36             it is as though the scissor box includes the entire window.
  37         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  38             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>index</code></em> is greater than or equal to
  39             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="glScissor.xml"><span class="citerefentry"><span class="refentrytitle">glScissor</span></span></a>,
  49             <a href="glScissorArray.xml"><span class="citerefentry"><span class="refentrytitle">glScissorArray</span></span></a>
  50         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  51             Copyright <span class="trademark"></span>© 2010 Khronos Group.
  52             This material may be distributed subject to the terms and conditions set forth in
  53             the Open Publication License, v 1.0, 8 June 1999.
  54             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  55         </p></div></div></body></html>