Magnum::GL::DefaultFramebuffer class

Usage

When you are using only the default framebuffer, the usage is simple. You must ensure that it is properly resized when window surface is resized. In case you're using one of the Platform::Application classes, pass the new size in your viewportEvent() implementation, for example:

void viewportEvent(const Vector2i& size) override {
    GL::defaultFramebuffer.setViewport({{}, size});

    // ...
}

Next thing you probably want is to clear all used buffers before performing any drawing. Again, in case you're using one of the Platform::Application classes, do it in your drawEvent() implementation, for example:

void drawEvent() override {
    GL::defaultFramebuffer.clear(GL::FramebufferClear::Color|GL::FramebufferClear::Depth);

    // ...
}

See documentation of particular functions and Framebuffer documentation for more involved usage, usage of non-default or multiple framebuffers.

Performance optimizations

See also relevant section in AbstractFramebuffer.

If either ARB_direct_state_access (part of OpenGL 4.5) or EXT_direct_state_access desktop extension is available, functions checkStatus(), mapForDraw(), mapForRead() and invalidate() use DSA to avoid unnecessary calls to glBindFramebuffer(). See their respective documentation for more information.

Base classes

class AbstractFramebuffer

Base for default and named framebuffers.

Public types

enum class Status: GLenum { Complete = GL_FRAMEBUFFER_COMPLETE, Undefined = GL_FRAMEBUFFER_UNDEFINED }

Status.

enum class DrawAttachment: GLenum { None = GL_NONE, FrontLeft = GL_FRONT_LEFT, FrontRight = GL_FRONT_RIGHT, BackLeft = GL_BACK_LEFT, BackRight = GL_BACK_RIGHT, Back = GL_BACK_LEFT }

Draw attachment.

enum class ReadAttachment: GLenum { None = GL_NONE, FrontLeft = GL_FRONT_LEFT, FrontRight = GL_FRONT_RIGHT, BackLeft = GL_BACK_LEFT, BackRight = GL_BACK_RIGHT, Left = GL_LEFT, Right = GL_RIGHT, Back = GL_BACK, Front = GL_FRONT, FrontAndBack = GL_FRONT_AND_BACK }

Read attachment.

enum class InvalidationAttachment: GLenum { FrontLeft = GL_FRONT_LEFT, FrontRight = GL_FRONT_RIGHT, BackLeft = GL_BACK_LEFT, BackRight = GL_BACK_RIGHT, Color = GL_COLOR, Depth = GL_DEPTH, Stencil = GL_STENCIL }

Invalidation attachment.

Constructors, destructors, conversion operators

DefaultFramebuffer(const DefaultFramebuffer&) deleted

Copying is not allowed.

DefaultFramebuffer(DefaultFramebuffer&&) deleted

Moving is not allowed.

Public functions

auto operator=(const DefaultFramebuffer&) -> DefaultFramebuffer& deleted

Copying is not allowed.

auto operator=(DefaultFramebuffer&& other) -> DefaultFramebuffer& deleted

Moving is not allowed.

auto checkStatus(FramebufferTarget target) -> Status

Check framebuffer status.

auto clearColor(const Color4& color) -> DefaultFramebuffer&

Clear color buffer to specified value.

auto clearColor(const Vector4i& color) -> DefaultFramebuffer&

auto clearColor(const Vector4ui& color) -> DefaultFramebuffer&

auto mapForDraw(std::initializer_list<std::pair<UnsignedInt, DrawAttachment>> attachments) -> DefaultFramebuffer&

Map shader outputs to buffer attachment.

auto mapForDraw(DrawAttachment attachment) -> DefaultFramebuffer&

Map shader output to buffer attachment.

auto mapForRead(ReadAttachment attachment) -> DefaultFramebuffer&

Map given attachment for reading.

void invalidate(std::initializer_list<InvalidationAttachment> attachments)

Invalidate framebuffer.

void invalidate(std::initializer_list<InvalidationAttachment> attachments, const Range2Di& rectangle)

Invalidate framebuffer rectangle.

Related

auto operator<<(Debug& debug, DefaultFramebuffer::Status value) -> Debug&

Debug output operator.

Enum documentation

Function documentation

GL::defaultFramebuffer.mapForDraw({
    {MyShader::ColorOutput, GL::DefaultFramebuffer::DrawAttachment::Back},
    {MyShader::NormalOutput, GL::DefaultFramebuffer::DrawAttachment::None}});