struct glw::FrameBuffer::Settings — HIRO 0.7.0 documentation

# struct glw::FrameBuffer::Settings

## Overview

Settings defining frame buffer properties. More…

    #include <FrameBuffer.h>

    struct Settings {
        // fields

        uint32_t width { 0 };
        uint32_t height { 0 };
        bool multisample_enabled { false };
        uint32_t multisample_samples { 4 };
        DepthBufferType depth_buffer_type { DepthBufferType::hidden };
        DepthDataFormat depth_format { DepthDataFormat::uint24_norm };
        std::vector<gl::GLenum> color_format;

        // construction

        Settings();
    };

## Detailed Documentation

Settings defining frame buffer properties.

### Fields

    uint32_t width { 0 }

Horizontal frame buffer resolution.

    uint32_t height { 0 }

Vertical frame buffer resolution.

    bool multisample_enabled { false }

Whether frame buffer should use multi-sampled attachments.

    uint32_t multisample_samples { 4 }

Number of samples. Used only when multi-sample enabled.

    DepthBufferType depth_buffer_type { DepthBufferType::hidden }

Type of depth buffer.

    DepthDataFormat depth_format { DepthDataFormat::uint24_norm }

Data format of depth buffer. Used when depth buffer type is not DepthBufferType::none.

    std::vector<gl::GLenum> color_format

Color format for every color attachment. Vector size defines number of attachments.