Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

glcheckframebufferstatus(3g) [mojave man page]

GLCHECKFRAMEBUFFERST(3G)					    OpenGL 3.3						  GLCHECKFRAMEBUFFERST(3G)

NAME

       glCheckFramebufferStatus - check the completeness status of a framebuffer

C SPECIFICATION

       GLenum glCheckFramebufferStatus(GLenum target);

PARAMETERS

       target
	   Specify the target of the framebuffer completeness check.

DESCRIPTION

       glCheckFramebufferStatus queries the completeness status of the framebuffer object currently bound to target.  target must be
       GL_DRAW_FRAMEBUFFER, GL_READ_FRAMEBUFFER or GL_FRAMEBUFFER.  GL_FRAMEBUFFER is equivalent to GL_DRAW_FRAMEBUFFER.

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

       o    GL_FRAMEBUFFER_UNDEFINED is returned if target is the default framebuffer, but the default framebuffer does not exist.

       o    GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT is returned if any of the framebuffer attachment points are framebuffer incomplete.

       o    GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT is returned if the framebuffer does not have at least one image attached to it.

       o    GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER is returned if the value of GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE is GL_NONE for any color
	   attachment point(s) named by GL_DRAWBUFFERi.

       o    GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER is returned if GL_READ_BUFFER is not GL_NONE and the value of
	   GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE is GL_NONE for the color attachment point named by GL_READ_BUFFER.

       o    GL_FRAMEBUFFER_UNSUPPORTED is returned if the combination of internal formats of the attached images violates an
	   implementation-dependent set of restrictions.

       o    GL_FRAMEBUFFER_INCOMPLETE_MULTISAMPLE is returned if the value of GL_RENDERBUFFER_SAMPLES is not the same for all attached
	   renderbuffers; if the value of GL_TEXTURE_SAMPLES is the not same for all attached textures; or, if the attached images are a mix of
	   renderbuffers and textures, the value of GL_RENDERBUFFER_SAMPLES does not match the value of GL_TEXTURE_SAMPLES.

       o    GL_FRAMEBUFFER_INCOMPLETE_MULTISAMPLE is also returned if the value of GL_TEXTURE_FIXED_SAMPLE_LOCATIONS is not the same for all
	   attached textures; or, if the attached images are a mix of renderbuffers and textures, the value of GL_TEXTURE_FIXED_SAMPLE_LOCATIONS
	   is not GL_TRUE for all attached textures.

       o    GL_FRAMEBUFFER_INCOMPLETE_LAYER_TARGETS is returned if any framebuffer attachment is layered, and any populated attachment is not
	   layered, or if all populated color attachments are not from textures of the same target.

       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.

SEE ALSO

       glGenFramebuffers(), glDeleteFramebuffers() glBindFramebuffer()

COPYRIGHT

       Copyright (C) 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/.

OpenGL 3.3							    03/08/2011						  GLCHECKFRAMEBUFFERST(3G)

Check Out this Related Man Page

GLFRAMEBUFFERRENDERB(3G)					    OpenGL 3.3						  GLFRAMEBUFFERRENDERB(3G)

NAME

       glFramebufferRenderbuffer - attach a renderbuffer as a logical buffer to the currently bound framebuffer object

C SPECIFICATION

       GLsync glFramebufferRenderbuffer(GLenum target, GLenum attachment, GLenum renderbuffertarget, GLuint renderbuffer);

PARAMETERS

       target
	   Specifies the framebuffer target.  target must be GL_DRAW_FRAMEBUFFER, GL_READ_FRAMEBUFFER, or GL_FRAMEBUFFER.  GL_FRAMEBUFFER is
	   equivalent to GL_DRAW_FRAMEBUFFER.

       attachment
	   Specifies the attachment point of the framebuffer.

       renderbuffertarget
	   Specifies the renderbuffer target and must be GL_RENDERBUFFER.

       renderbuffer
	   Specifies the name of an existing renderbuffer object of type renderbuffertarget to attach.

DESCRIPTION

       glFramebufferRenderbuffer attaches a renderbuffer as one of the logical buffers of the currently bound framebuffer object.  renderbuffer is
       the name of the renderbuffer object to attach and must be either zero, or the name of an existing renderbuffer object of type
       renderbuffertarget. If renderbuffer is not zero and if glFramebufferRenderbuffer is successful, then the renderbuffer name renderbuffer
       will be used as the logical buffer identified by attachment of the framebuffer currently bound to target.

       The value of GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE for the specified attachment point is set to GL_RENDERBUFFER and the value of
       GL_FRAMEBUFFER_ATTACHMENT_OBJECT_NAME is set to renderbuffer. All other state values of the attachment point specified by attachment are
       set to their default values. No change is made to the state of the renderbuuffer object and any previous attachment to the attachment
       logical buffer of the framebuffer target is broken.

       Calling glFramebufferRenderbuffer with the renderbuffer name zero will detach the image, if any, identified by attachment, in the
       framebuffer currently bound to target. All state values of the attachment point specified by attachment in the object bound to target are
       set to their default values.

       Setting attachment to the value GL_DEPTH_STENCIL_ATTACHMENT is a special case causing both the depth and stencil attachments of the
       framebuffer object to be set to renderbuffer, which should have the base internal format GL_DEPTH_STENCIL.

ERRORS

       GL_INVALID_ENUM is generated if target is not one of the accepted tokens.

       GL_INVALID_ENUM is generated if renderbuffertarget is not GL_RENDERBUFFER.

       GL_INVALID_OPERATION is generated if zero is bound to target.

SEE ALSO

       glGenFramebuffers(), glBindFramebuffer(), glGenRenderbuffers(), glFramebufferTexture(), glFramebufferTexture1D(), glFramebufferTexture2D(),
       glFramebufferTexture3D()

COPYRIGHT

       Copyright (C) 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/.

OpenGL 3.3							    03/08/2011						  GLFRAMEBUFFERRENDERB(3G)
Man Page