GLAPI/glIsFramebuffer: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
m Renaming category: 'API Reference 4' to 'Core API Reference'.
m Bot: Adding better formatting.
 
(2 intermediate revisions by the same user not shown)
Line 8: Line 8:
== Function Definition ==
== Function Definition ==


   GLboolean '''glIsFramebuffer'''(GLuint ''framebuffer'');
   GLboolean '''glIsFramebuffer'''(GLuint {{param|framebuffer}});


; framebuffer
; framebuffer
Line 15: Line 15:
== Description ==
== Description ==


'''glIsFramebuffer''' returns {{code|GL_TRUE}} if ''framebuffer'' is currently the name of a framebuffer object. If ''framebuffer'' is zero, or if {{code|framebuffer}} is not the name of a framebuffer object, or if an error occurs, '''glIsFramebuffer''' returns {{code|GL_FALSE}}. If ''framebuffer'' is a name returned by [[GLAPI/glGenFramebuffers|glGenFramebuffers]], by that has not yet been bound through a call to [[GLAPI/glBindFramebuffer|glBindFramebuffer]], then the name is not a framebuffer object and '''glIsFramebuffer''' returns {{code|GL_FALSE}}.
'''glIsFramebuffer''' returns {{enum|GL_TRUE}} if {{param|framebuffer}} is currently the name of a framebuffer object. If {{param|framebuffer}} is zero, or if {{param|framebuffer}} is not the name of a framebuffer object, or if an error occurs, '''glIsFramebuffer''' returns {{enum|GL_FALSE}}. If {{param|framebuffer}} is a name returned by {{apifunc|glGenFramebuffers}}, by that has not yet been bound through a call to {{apifunc|glBindFramebuffer}}, then the name is not a framebuffer object and '''glIsFramebuffer''' returns {{enum|GL_FALSE}}.


== See Also ==
== See Also ==


[[GLAPI/glGenFramebuffers|glGenFramebuffers]], [[GLAPI/glBindFramebuffer|glBindFramebuffer]], [[GLAPI/glDeleteFramebuffers|glDeleteFramebuffers]]
{{apifunc|glGenFramebuffers}}, {{apifunc|glBindFramebuffer}}, {{apifunc|glDeleteFramebuffers}}


== Copyright ==
== Copyright ==

Latest revision as of 08:30, 13 August 2012

glIsFramebuffer
Core in version 4.6
Core since version 3.0

glIsFramebuffer: determine if a name corresponds to a framebuffer object

Function Definition

 GLboolean glIsFramebuffer(GLuint framebuffer​);
framebuffer
Specifies a value that may be the name of a framebuffer object.

Description

glIsFramebuffer returns GL_TRUE if framebuffer​ is currently the name of a framebuffer object. If framebuffer​ is zero, or if framebuffer​ is not the name of a framebuffer object, or if an error occurs, glIsFramebuffer returns GL_FALSE. If framebuffer​ is a name returned by glGenFramebuffers, by that has not yet been bound through a call to glBindFramebuffer, then the name is not a framebuffer object and glIsFramebuffer returns GL_FALSE.

See Also

glGenFramebuffers, glBindFramebuffer, glDeleteFramebuffers

Copyright

Copyright © 2010 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.