GLAPI/glDeleteRenderbuffers: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
m Bot: Adding better formatting.
m Bot: Adding better formatting.
Line 17: Line 17:
== Description ==
== Description ==


'''glDeleteRenderbuffers''' deletes the {{param|n}} renderbuffer objects whose names are stored in the array addressed by {{param|renderbuffers}}. The name zero is reserved by the GL and is silently ignored, should it occur in {{param|renderbuffers}}, as are other unused names. Once a renderbuffer object is deleted, its name is again unused and it has no contents. If a renderbuffer that is currently bound to the target {{code|GL_RENDERBUFFER}} is deleted, it is as though {{apifunc|glBindRenderbuffer}} had been executed with a {{param|target}} of {{code|GL_RENDERBUFFER}} and a {{param|name}} of zero.
'''glDeleteRenderbuffers''' deletes the {{param|n}} renderbuffer objects whose names are stored in the array addressed by {{param|renderbuffers}}. The name zero is reserved by the GL and is silently ignored, should it occur in {{param|renderbuffers}}, as are other unused names. Once a renderbuffer object is deleted, its name is again unused and it has no contents. If a renderbuffer that is currently bound to the target {{enum|GL_RENDERBUFFER}} is deleted, it is as though {{apifunc|glBindRenderbuffer}} had been executed with a {{param|target}} of {{enum|GL_RENDERBUFFER}} and a {{param|name}} of zero.


If a renderbuffer object is attached to one or more attachment points in the currently bound framebuffer, then it as if {{apifunc|glFramebufferRenderbuffer}} had been called, with a {{param|renderbuffer}} of zero for each attachment point to which this image was attached in the currently bound framebuffer. In other words, this renderbuffer object is first detached from all attachment ponits in the currently bound framebuffer. Note that the renderbuffer image is specifically ''not'' detached from any non-bound framebuffers.
If a renderbuffer object is attached to one or more attachment points in the currently bound framebuffer, then it as if {{apifunc|glFramebufferRenderbuffer}} had been called, with a {{param|renderbuffer}} of zero for each attachment point to which this image was attached in the currently bound framebuffer. In other words, this renderbuffer object is first detached from all attachment ponits in the currently bound framebuffer. Note that the renderbuffer image is specifically ''not'' detached from any non-bound framebuffers.
Line 23: Line 23:
== Errors ==
== Errors ==


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


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

Revision as of 17:19, 29 April 2012

glDeleteRenderbuffers
Core in version 4.6
Core since version 3.0

glDeleteRenderbuffers: delete renderbuffer objects

Function Definition

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

Description

glDeleteRenderbuffers deletes the n​ renderbuffer objects whose names are stored in the array addressed by renderbuffers​. The name zero is reserved by the GL and is silently ignored, should it occur in renderbuffers​, as are other unused names. Once a renderbuffer object is deleted, its name is again unused and it has no contents. If a renderbuffer that is currently bound to the target GL_RENDERBUFFER is deleted, it is as though glBindRenderbuffer had been executed with a target​ of GL_RENDERBUFFER and a name​ of zero.

If a renderbuffer object is attached to one or more attachment points in the currently bound framebuffer, then it as if glFramebufferRenderbuffer had been called, with a renderbuffer​ of zero for each attachment point to which this image was attached in the currently bound framebuffer. In other words, this renderbuffer object is first detached from all attachment ponits in the currently bound framebuffer. Note that the renderbuffer image is specifically not detached from any non-bound framebuffers.

Errors

GL_INVALID_VALUE is generated if n​ is negative.

See Also

glGenRenderbuffers, glFramebufferRenderbuffer, glRenderbufferStorage, glRenderbufferStorageMultisample

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