GLINVALIDATEFRAMEBUF(3G)

    .SH "NAME" glInvalidateFramebuffer - Invalidate the contents of attachments within a framebuffer
    .SH "C SPECIFICATION"

            .HP u void glInvalidateFramebuffer(GLenum target, GLsizei numAttachments, const GLenum *attachments);

    .SH "PARAMETERS"

        .PP target

                    Specifies the target of the invalidate operation.

            .RE
            .PP numAttachments

                        Specifies how many attachments are supplied in the attachments list.

                .RE
                .PP attachments

                            A list of numAttachments attachments to invalidate.

                    .RE

                .SH "DESCRIPTION"
                    .PP glInvalidateFramebuffer signals to the GL that it need not preserve all pixels of the framebuffer bound to target. target must be GL_READ_FRAMEBFUFFER, GL_DRAW_FRAMEBUFFER or GL_FRAMEBUFFER. The token GL_FRAMEBUFFER is treated as GL_DRAW_FRAMEBUFFER. attachments contains a list of numAttachments to be invalidated. If an attachment is specified that does not exist in the bound framebuffer, it is ignored.
                    .PP If a framebuffer object is bound, then attachments may contain GL_COLOR_ATTACHMENTi, GL_DEPTH_ATTACHMENT, GL_STENCIL_ATTACHMENT, and/or GL_DEPTH_STENCIL_ATTACHMENT. If the framebuffer object is not complete, glInvalidateFramebuffer may be ignored.
                    .PP If the default framebuffer is bound, then attachments may contain GL_COLOR, identifying the color buffer; GL_DEPTH, identifying the depth buffer; and/or GL_STENCIL, identifying the stencil buffer.

                .SH "NOTES"
                    .PP The intention of this function is to provide a hint to the GL implementation that there is no longer a need to preserve the contents of particular attachments of a framebuffer object, or the default framebuffer. It is possible, for example, to signal the intention that depth and or stencil data is no longer needed at the end of a scene, or that multisample color buffer data is no longer needed after a resolve through glBlitFramebuffer().

                .SH "ERRORS"
                    .PP GL_INVALID_ENUM is generated if target is not GL_DRAW_FRAMEBUFFER, GL_READ_FRAMEBUFFER, or GL_FRAMEBUFFER.
                    .PP GL_INVALID_OPERATION is generated if attachments contains GL_COLOR_ATTACHMENTm and m is greater than or equal to the value of GL_MAX_COLOR_ATTACHMENTS.

                .SH "API VERSION SUPPORT"

                    .TS allbox tab(:); l l l l l. T{ glInvalidateFramebuffer T}:T{ T}:T{ T}:T{ T}:T{ T}

                .SH "SEE ALSO"
                    .PP glBindFramebuffer(), glBlitFramebuffer() glFramebufferRenderbuffer(), glFramebufferTexture2D(), glFramebufferTextureLayer(), glInvalidateSubFramebuffer()

                .SH "COPYRIGHT"
                    .PP Copyright © 2014-2015 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/.

COPYRIGHT
Copyright © 2012-2015 Khronos Group