Difference between revisions of "GLAPI/glGenFramebuffers"

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 ==
  
   void '''glGenFramebuffers'''(GLsizei ''n'', GLuint *''ids'');
+
   void '''glGenFramebuffers'''(GLsizei {{param|n}}, GLuint *{{param|ids}});
  
 
; n
 
; n
Line 17: Line 17:
 
== Description ==
 
== Description ==
  
'''glGenFramebuffers''' returns ''n'' framebuffer object names in ''ids''. There is no guarantee that the names form a contiguous set of integers; however, it is guaranteed that none of the returned names was in use immediately before the call to '''glGenFramebuffers'''.
+
'''glGenFramebuffers''' returns {{param|n}} framebuffer object names in {{param|ids}}. There is no guarantee that the names form a contiguous set of integers; however, it is guaranteed that none of the returned names was in use immediately before the call to '''glGenFramebuffers'''.
  
Framebuffer object names returned by a call to '''glGenFramebuffers''' are not returned by subsequent calls, unless they are first deleted with [[GLAPI/glDeleteFramebuffers|glDeleteFramebuffers]].
+
Framebuffer object names returned by a call to '''glGenFramebuffers''' are not returned by subsequent calls, unless they are first deleted with {{apifunc|glDeleteFramebuffers}}.
  
The names returned in ''ids'' are marked as used, for the purposes of '''glGenFramebuffers''' only, but they acquire state and type only when they are first bound.
+
The names returned in {{param|ids}} are marked as used, for the purposes of '''glGenFramebuffers''' only, but they acquire state and type only when they are first bound.
  
 
== 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/glBindFramebuffer|glBindFramebuffer]], [[GLAPI/glDeleteFramebuffers|glDeleteFramebuffers]]
+
{{apifunc|glBindFramebuffer}}, {{apifunc|glIsFramebuffer}}, {{apifunc|glDeleteFramebuffers}}
  
 
== Copyright ==
 
== Copyright ==

Latest revision as of 01:45, 27 September 2012

glGenFramebuffers
Core in version 4.6
Core since version 3.0

glGenFramebuffers: generate framebuffer object names

Function Definition

 void glGenFramebuffers(GLsizei n​, GLuint *ids​);
n
Specifies the number of framebuffer object names to generate.
ids
Specifies an array in which the generated framebuffer object names are stored.

Description

glGenFramebuffers returns n​ framebuffer object names in ids​. There is no guarantee that the names form a contiguous set of integers; however, it is guaranteed that none of the returned names was in use immediately before the call to glGenFramebuffers.

Framebuffer object names returned by a call to glGenFramebuffers are not returned by subsequent calls, unless they are first deleted with glDeleteFramebuffers.

The names returned in ids​ are marked as used, for the purposes of glGenFramebuffers only, but they acquire state and type only when they are first bound.

Errors

GL_INVALID_VALUE is generated if n​ is negative.

See Also

glBindFramebuffer, glIsFramebuffer, 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/.