upstream-man-pages/man4/xhtml/glInvalidateSubFramebuffer.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>glInvalidateSubFramebuffer - 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="glInvalidateSubFramebuffer"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glInvalidateSubFramebuffer — invalidate the content of a region of some or all of a framebuffer object's attachments</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">glInvalidateSubFramebuffer</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">numAttachments</var>, </td></tr><tr><td> </td><td>const GLenum *  </td><td><var class="pdparam">attachments</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">x</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">y</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">width</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">height</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>target</code></em></span></dt><dd><p>
   5                     The target to which the framebuffer is attached. <em class="parameter"><code>target</code></em> must be
   6                     <code class="constant">GL_FRAMEBUFFER</code>, <code class="constant">GL_DRAW_FRAMEBUFFER</code>, or <code class="constant">GL_READ_FRAMEBUFFER</code>.
   7                 </p></dd><dt><span class="term"><em class="parameter"><code>numAttachments</code></em></span></dt><dd><p>
   8                     The number of entries in the <em class="parameter"><code>attachments</code></em> array.
   9                 </p></dd><dt><span class="term"><em class="parameter"><code>attachments</code></em></span></dt><dd><p>
  10                     The address of an array identifying the attachments to be invalidated.
  11                 </p></dd><dt><span class="term"><em class="parameter"><code>x</code></em></span></dt><dd><p>
  12                     The X offset of the region to be invalidated.
  13                 </p></dd><dt><span class="term"><em class="parameter"><code>y</code></em></span></dt><dd><p>
  14                     The Y offset of the region to be invalidated.
  15                 </p></dd><dt><span class="term"><em class="parameter"><code>width</code></em></span></dt><dd><p>
  16                     The width of the region to be invalidated.
  17                 </p></dd><dt><span class="term"><em class="parameter"><code>height</code></em></span></dt><dd><p>
  18                     The height of the region to be invalidated.
  19                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  20             <code class="function">glInvalidateSubFramebuffer</code> invalidates the content of a region
  21             of a specified set of attachments of a framebuffer. The framebuffer
  22             whose content to invalidate is indicated by setting <em class="parameter"><code>target</code></em>
  23             to the target to which it is bound. <em class="parameter"><code>target</code></em> may be
  24             <code class="constant">GL_FRAMEBUFFER</code>, <code class="constant">GL_READ_FRAMEBUFFER</code> or
  25             <code class="constant">GL_DRAW_FRAMEBUFFER</code>. <code class="constant">GL_FRAMEBUFFER</code>
  26             is treated as if it were <code class="constant">GL_DRAW_FRAMEBUFFER</code>.
  27         </p><p>
  28             A region within a subset of the framebuffer's attachments may be invalidated.
  29             This set of attachments are specified in an array whose address is given
  30             by <em class="parameter"><code>attachments</code></em> and which contains <em class="parameter"><code>numAttachments</code></em>
  31             elements. The elements of <em class="parameter"><code>attachments</code></em> must be
  32             <code class="constant">GL_DEPTH_ATTACHMENT</code>, <code class="constant">GL_STENCIL_ATTACHMENT</code>
  33             <code class="constant">GL_DEPTH_STENCIL_ATTACHMENT</code>, or <code class="constant">GL_COLOR_ATTACHMENT<span class="emphasis"><em>i</em></span></code>,
  34             where <span class="emphasis"><em>i</em></span> is between zero and the value of <code class="constant">GL_MAX_FRAMEBUFFER_ATTACHMENTS</code> minus one.
  35             Furthermore, if the default framebuffer is bound to <em class="parameter"><code>target</code></em>, then
  36             <em class="parameter"><code>attachments</code></em> may contain <code class="constant">GL_FRONT_LEFT</code>,
  37             <code class="constant">GL_FRONT_RIGHT</code>, <code class="constant">GL_BACK_LEFT</code>, <code class="constant">GL_BACK_RIGHT</code>,
  38             <code class="constant">GL_AUX<span class="emphasis"><em>i</em></span></code>, <code class="constant">GL_ACCUM</code>,
  39             <code class="constant">GL_COLOR</code>, <code class="constant">GL_DEPTH</code>, or <code class="constant">GL_STENCIL</code>, identifying that specific buffer.
  40             <code class="constant">GL_COLOR</code>, is treated as <code class="constant">GL_BACK_LEFT</code> for a double-buffered context and
  41             <code class="constant">GL_FRONT_LEFT</code> for a single-buffered context.
  42         </p><p>
  43             The region of the framebuffer attachments to be invalidated is specified
  44             by <em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>, <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em>
  45             where <em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em> give the offset from the origin (with
  46             lower-left corner at (0, 0)) and <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em>
  47             give the size. Any pixels lying outside of the window allocated
  48             to the current GL context, or outside of the attachments of the currently
  49             bound framebuffer object, are ignored.
  50             After <code class="function">glInvalidateFramebuffer</code> is executed, the contents
  51             of the specified region of the specified attachments become undefined.
  52         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  53             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not one of the
  54             accepted framebuffer target tokens.
  55         </p><p>
  56             <code class="constant">GL_INVALID_ENUM</code> is generated if any element of <em class="parameter"><code>attachments</code></em> is
  57             not one of the accepted framebuffer attachment tokens.
  58         </p><p>
  59             <code class="constant">GL_INVALID_OPERATION</code> is generated if element of <em class="parameter"><code>attachments</code></em> is
  60             <code class="constant">GL_COLOR_ATTACHMENT<span class="emphasis"><em>i</em></span></code> where <span class="emphasis"><em>i</em></span> is greater than or equal
  61             to the value of <code class="constant">GL_MAX_COLOR_ATTACHMENTS</code>.
  62         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  63             <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_COLOR_ATTACHMENTS</code>
  64         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  65             <a href="glInvalidateTexSubImage.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateTexSubImage</span></span></a>,
  66             <a href="glInvalidateTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateTexImage</span></span></a>,
  67             <a href="glInvalidateBufferSubData.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateBufferSubData</span></span></a>,
  68             <a href="glInvalidateBufferData.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateBufferData</span></span></a>,
  69             <a href="glInvalidateFramebuffer.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateFramebuffer</span></span></a>.
  70         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  71             Copyright <span class="trademark"></span>© 2012 Khronos Group.
  72             This material may be distributed subject to the terms and conditions set forth in
  73             the Open Publication License, v 1.0, 8 June 1999.
  74             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  75         </p></div></div></body></html>