glCheckFramebufferStatus.3G man page

glCheckFramebufferStatus, glCheckNamedFramebufferStatus — check the completeness status of a framebuffer

C Specification

GLenum glCheckFramebufferStatus(GLenum target);

GLenum glCheckNamedFramebufferStatus(GLuint framebuffer, GLenum target);

Parameters

target

Specify the target to which the framebuffer is bound for glCheckFramebufferStatus, and the target against which framebuffer completeness of framebuffer is checked for glCheckNamedFramebufferStatus.

framebuffer

Specifies the name of the framebuffer object for glCheckNamedFramebufferStatus

Description

glCheckFramebufferStatus and glCheckNamedFramebufferStatus return the completeness status of a framebuffer object when treated as a read or draw framebuffer, depending on the value of target.

For glCheckFramebufferStatus, the framebuffer checked is that bound to target, which must be GL_DRAW_FRAMEBUFFER, GL_READ_FRAMEBUFFER or GL_FRAMEBUFFER. GL_FRAMEBUFFER is equivalent to GL_DRAW_FRAMEBUFFER.

For glCheckNamedFramebufferStatus, framebuffer is zero or the name of the framebuffer object to check. If framebuffer is zero, then the status of the default read or draw framebuffer, as determined by target, is returned.

The return value is GL_FRAMEBUFFER_COMPLETE if the specified framebuffer is complete. Otherwise, the return value is determined as follows:

Additionally, if an error occurs, zero is returned.

Errors

GL_INVALID_ENUM is generated if target is not GL_DRAW_FRAMEBUFFER, GL_READ_FRAMEBUFFER or GL_FRAMEBUFFER.

GL_INVALID_OPERATION is generated by glCheckNamedFramebufferStatus if framebuffer is not zero or the name of an existing framebuffer object.

Version Support

OpenGL Version
Function / Feature Name 2.0 2.1 3.0 3.1 3.2 3.3 4.0 4.1 4.2 4.3 4.4 4.5
glCheckFramebufferStatus - -
glCheckNamedFramebufferStatus - - - - - - - - - - -

See Also

glGenFramebuffers(), glDeleteFramebuffers() glBindFramebuffer()

Referenced By

The man page glCheckNamedFramebufferStatus.3G(3) is an alias of glCheckFramebufferStatus.3G(3).

07/26/2017 [FIXME: source] [FIXME: manual]