Gambas Documentation - /comp/gb.opengl/gl/checkframebufferstatusext

/comp/gb.opengl/gl/checkframebufferstatusext

# Gl.CheckFramebufferStatusEXT (gb.opengl)

Static Function CheckFramebufferStatusEXT ( Target As Integer ) As Integer

Check the completeness status of a framebuffer.

### Parameters

target

  Specify the target of the framebuffer completeness check.

### Description

Gl.CheckFramebufferStatus 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:

- Gl.FRAMEBUFFER_UNDEFINED is returned if target is the default framebuffer, but the default framebuffer does not exist.

- Gl.FRAMEBUFFER_INCOMPLETE_ATTACHMENT is returned if any of the framebuffer attachment points are framebuffer incomplete.

- Gl.FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT is returned if the framebuffer does not have at least one image attached to it.

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

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

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

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

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

- 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

Gl.GenFramebuffers, Gl.DeleteFramebuffers Gl.BindFramebuffer

See original documentation on OpenGL website