GLAPI/glDeleteFramebuffers: Difference between revisions

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


   void '''glDeleteFramebuffers'''(GLsizei ''n'', GLuint *''framebuffers'');
   void '''glDeleteFramebuffers'''(GLsizei {{param|n}}, GLuint *{{param|framebuffers}});


; n
; n
: Specifies the number of framebuffer objects to be deleted.
: Specifies the number of framebuffer objects to be deleted.
; framebuffers
; framebuffers
: A pointer to an array containing ''n'' framebuffer objects to be deleted.
: A pointer to an array containing {{param|n}} framebuffer objects to be deleted.


== Description ==
== Description ==


'''glDeleteFramebuffers''' deletes the ''n'' framebuffer objects whose names are stored in the array addressed by ''framebuffers''. The name zero is reserved by the GL and is silently ignored, should it occur in ''framebuffers'', as are other unused names. Once a framebuffer object is deleted, its name is again unused and it has no attachments. If a framebuffer that is currently bound to one or more of the targets {{code|GL_DRAW_FRAMEBUFFER}} or {{code|GL_READ_FRAMEBUFFER}} is deleted, it is as though [[GLAPI/glBindFramebuffer|glBindFramebuffer]] had been executed with the corresponding ''target'' and ''framebuffer'' zero.
'''glDeleteFramebuffers''' deletes the {{param|n}} framebuffer objects whose names are stored in the array addressed by {{param|framebuffers}}. The name zero is reserved by the GL and is silently ignored, should it occur in {{param|framebuffers}}, as are other unused names. Once a framebuffer object is deleted, its name is again unused and it has no attachments. If a framebuffer that is currently bound to one or more of the targets {{enum|GL_DRAW_FRAMEBUFFER}} or {{enum|GL_READ_FRAMEBUFFER}} is deleted, it is as though {{apifunc|glBindFramebuffer}} had been executed with the corresponding {{param|target}} and {{param|framebuffer}} zero.


== Errors ==
== Errors ==


{{code|GL_INVALID_VALUE}} is generated if ''n'' is negative.
{{enum|GL_INVALID_VALUE}} is generated if {{param|n}} is negative.


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


[[GLAPI/glGenFramebuffers|glGenFramebuffers]], [[GLAPI/glBindFramebuffer|glBindFramebuffer]], [[GLAPI/glCheckFramebufferStatus|glCheckFramebufferStatus]]
{{apifunc|glGenFramebuffers}}, {{apifunc|glBindFramebuffer}}, {{apifunc|glIsFramebuffer}}


== Copyright ==
== Copyright ==
Line 31: Line 31:
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/ http://opencontent.org/openpub/].
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/ http://opencontent.org/openpub/].


[[Category:API Reference 4|DeleteFramebuffers]]
[[Category:Core API Ref Framebuffer Objects|DeleteFramebuffers]]
[[Category:Core API Ref Framebuffer Objects|DeleteFramebuffers]]
[[Category:Core API Reference|DeleteFramebuffers]]

Latest revision as of 01:42, 27 September 2012

glDeleteFramebuffers
Core in version 4.6
Core since version 3.0

glDeleteFramebuffers: delete framebuffer objects

Function Definition

 void glDeleteFramebuffers(GLsizei n​, GLuint *framebuffers​);
n
Specifies the number of framebuffer objects to be deleted.
framebuffers
A pointer to an array containing n​ framebuffer objects to be deleted.

Description

glDeleteFramebuffers deletes the n​ framebuffer objects whose names are stored in the array addressed by framebuffers​. The name zero is reserved by the GL and is silently ignored, should it occur in framebuffers​, as are other unused names. Once a framebuffer object is deleted, its name is again unused and it has no attachments. If a framebuffer that is currently bound to one or more of the targets GL_DRAW_FRAMEBUFFER or GL_READ_FRAMEBUFFER is deleted, it is as though glBindFramebuffer had been executed with the corresponding target​ and framebuffer​ zero.

Errors

GL_INVALID_VALUE is generated if n​ is negative.

See Also

glGenFramebuffers, glBindFramebuffer, glIsFramebuffer

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/.