framebuffer.hpp

Go to the documentation of this file.

/**
 * @file framebuffer.cpp
 * @author Keeton Feavel ([email protected])
 * @brief
 * @version 0.1
 * @date 2021-06-11
 *
 * @copyright Copyright the Xyris Contributors (c) 2021
 *
 */
#pragma once
#include <stdint.h>
 
namespace Graphics {
 
enum FramebufferMemoryModel {
    Undefined_FBMM = 0,
    RGB_FBMM = 1,
};
 
class Framebuffer {
public:
    // Constructors
    Framebuffer();
    Framebuffer(uint32_t width, uint32_t height, uint16_t depth, uint32_t pitch, void* addr);
    Framebuffer(uint32_t width, uint32_t height,
                    uint16_t depth, uint32_t pitch,
                    void* addr, FramebufferMemoryModel model,
                    uint8_t redMaskSize, uint8_t redMaskShift,
                    uint8_t greenMaskSize, uint8_t greenMaskShift,
                    uint8_t blueMaskSize, uint8_t blueMaskShift);
    // Getters
    [[gnu::always_inline]] void* getAddress()                          { return _addr; }
    [[gnu::always_inline]] uint32_t getWidth()                         { return _width; }
    [[gnu::always_inline]] uint32_t getHeight()                        { return _height; }
    [[gnu::always_inline]] uint16_t getDepth()                         { return _depth; }
    [[gnu::always_inline]] uint32_t getPitch()                         { return _pitch; }
    [[gnu::always_inline]] uint8_t getRedMaskSize()                    { return _redMaskSize; }
    [[gnu::always_inline]] uint8_t getRedMaskShift()                   { return _redMaskShift; }
    [[gnu::always_inline]] uint8_t getGreenMaskSize()                  { return _greenMaskSize; }
    [[gnu::always_inline]] uint8_t getGreenMaskShift()                 { return _greenMaskShift; }
    [[gnu::always_inline]] uint8_t getBlueMaskSize()                   { return _blueMaskSize; }
    [[gnu::always_inline]] uint8_t getBlueMaskShift()                  { return _blueMaskShift; }
    [[gnu::always_inline]] uint8_t getPixelWidth()                     { return _depth / 8; }
    [[gnu::always_inline]] FramebufferMemoryModel getModel()           { return _memoryModel; }
    // Setters
    [[gnu::always_inline]] void setWidth(uint16_t val)                 { _width = val; }
    [[gnu::always_inline]] void setHeight(uint16_t val)                { _height = val; }
    [[gnu::always_inline]] void setDepth(uint16_t val)                 { _depth = val; }
    [[gnu::always_inline]] void setPitch(uint16_t val)                 { _pitch = val; }
    [[gnu::always_inline]] void setRedMaskSize(uint8_t val)            { _redMaskSize = val; }
    [[gnu::always_inline]] void setRedMaskShift(uint8_t val)           { _redMaskShift = val; }
    [[gnu::always_inline]] void setGreenMaskSize(uint8_t val)          { _greenMaskSize = val; }
    [[gnu::always_inline]] void setGreenMaskShift(uint8_t val)         { _greenMaskShift = val; }
    [[gnu::always_inline]] void setBlueMaskSize(uint8_t val)           { _blueMaskSize = val; }
    [[gnu::always_inline]] void setBlueMaskShift(uint8_t val)          { _blueMaskShift = val; }
    [[gnu::always_inline]] void setModel(FramebufferMemoryModel val)   { _memoryModel = val; }
 
private:
    void* _addr;                                // physical framebuffer address
    uint32_t _width;                            // number pixels on a horizontal line
    uint32_t _height;                           // number horizontal lines present
    uint16_t _depth;                            // color depth (same as bits per pixel)
    uint32_t _pitch;                            // number bytes of VRAM in each line
    uint8_t _redMaskSize;
    uint8_t _redMaskShift;
    uint8_t _greenMaskSize;
    uint8_t _greenMaskShift;
    uint8_t _blueMaskSize;
    uint8_t _blueMaskShift;
    FramebufferMemoryModel _memoryModel;
};
 
/**
 * @brief Get a pointer to the active framebuffer
 *
 * @return Framebuffer* Pointer to active framebuffer
 */
Framebuffer* getFramebuffer();
 
}; // !namespace graphics