upstream-doc/man3/xhtml/glCheckFramebufferStatus.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>glCheckFramebufferStatus - OpenGL 3.3 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="glCheckFramebufferStatus"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glCheckFramebufferStatus — check the completeness status of a framebuffer</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">GLenum <b class="fsfunc">glCheckFramebufferStatus</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</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                     Specify the target of the framebuffer completeness check.
   6                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
   7             <code class="function">glCheckFramebufferStatus</code> queries the completeness status of the framebuffer object currently bound to <em class="parameter"><code>target</code></em>.
   8             <em class="parameter"><code>target</code></em> must be <code class="constant">GL_DRAW_FRAMEBUFFER</code>, <code class="constant">GL_READ_FRAMEBUFFER</code> or <code class="constant">GL_FRAMEBUFFER</code>.
   9             <code class="constant">GL_FRAMEBUFFER</code> is equivalent to <code class="constant">GL_DRAW_FRAMEBUFFER</code>.
  10         </p><p>
  11             The return value is <code class="constant">GL_FRAMEBUFFER_COMPLETE</code> if the framebuffer bound to <em class="parameter"><code>target</code></em> is complete. Otherwise,
  12             the return value is determined as follows:
  13             </p><div class="itemizedlist"><ul type="disc"><li><p>
  14                         <code class="constant">GL_FRAMEBUFFER_UNDEFINED</code> is returned if <em class="parameter"><code>target</code></em> is the default framebuffer, but the default framebuffer does not exist.
  15                     </p></li><li><p>
  16                         <code class="constant">GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT</code> is returned if any of the framebuffer attachment points are framebuffer incomplete.
  17                     </p></li><li><p>
  18                         <code class="constant">GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT</code> is returned if the framebuffer does not have at least one image attached to it.
  19                     </p></li><li><p>
  20                         <code class="constant">GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER</code> is returned if the value of <code class="constant">GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE</code>
  21                          is <code class="constant">GL_NONE</code> for any color attachment point(s) named by <code class="constant">GL_DRAW_BUFFERi</code>.
  22                     </p></li><li><p>
  23                         <code class="constant">GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER</code> is returned if <code class="constant">GL_READ_BUFFER</code> is not <code class="constant">GL_NONE</code>
  24                         and the value of <code class="constant">GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE</code> is <code class="constant">GL_NONE</code> for the color attachment point named
  25                         by <code class="constant">GL_READ_BUFFER</code>.
  26                     </p></li><li><p>
  27                         <code class="constant">GL_FRAMEBUFFER_UNSUPPORTED</code> is returned if the combination of internal formats of the attached images violates
  28                         an implementation-dependent set of restrictions.
  29                     </p></li><li><p>
  30                         <code class="constant">GL_FRAMEBUFFER_INCOMPLETE_MULTISAMPLE</code> is returned if the value of <code class="constant">GL_RENDERBUFFER_SAMPLES</code> is not the same
  31                         for all attached renderbuffers; if the value of <code class="constant">GL_TEXTURE_SAMPLES</code> is the not same for all attached textures; or, if the attached
  32                         images are a mix of renderbuffers and textures, the value of <code class="constant">GL_RENDERBUFFER_SAMPLES</code> does not match the value of
  33                         <code class="constant">GL_TEXTURE_SAMPLES</code>.
  34                     </p></li><li><p>
  35                         <code class="constant">GL_FRAMEBUFFER_INCOMPLETE_MULTISAMPLE</code> is also returned if the value of <code class="constant">GL_TEXTURE_FIXED_SAMPLE_LOCATIONS</code> is
  36                         not the same for all attached textures; or, if the attached images are a mix of renderbuffers and textures, the value of <code class="constant">GL_TEXTURE_FIXED_SAMPLE_LOCATIONS</code>
  37                         is not <code class="constant">GL_TRUE</code> for all attached textures.
  38                     </p></li><li><p>
  39                         <code class="constant">GL_FRAMEBUFFER_INCOMPLETE_LAYER_TARGETS</code> is returned if any framebuffer attachment is layered, and any populated attachment is not layered,
  40                         or if all populated color attachments are not from textures of the same target.
  41                     </p></li></ul></div><p>
  42         </p><p>
  43             Additionally, if an error occurs, zero is returned.
  44         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  45             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not <code class="constant">GL_DRAW_FRAMEBUFFER</code>,
  46             <code class="constant">GL_READ_FRAMEBUFFER</code> or <code class="constant">GL_FRAMEBUFFER</code>.
  47         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  48             <a href="glGenFramebuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenFramebuffers</span></span></a>,
  49             <a href="glDeleteFramebuffers.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteFramebuffers</span></span></a>
  50             <a href="glBindFramebuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindFramebuffer</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>