FrameBuffer.hpp

Go to the documentation of this file.

// Copyright 2012-2026 Jan Niklas Hasse <jhasse@bixense.com>
// For conditions of distribution and use, see copyright notice in LICENSE.txt
#pragma once
 
#include "Mat3.hpp"
#include "Pixels.hpp"
#include "Rgba.hpp"
#include "ShaderProgram.hpp"
#include "Vec2.hpp"
#include "Vertex.hpp"
 
#include <functional>
#include "TextureFilter.hpp"
 
#include <memory>
#include <vector>
 
namespace jngl {
 
class ShaderProgram;
 
class FrameBuffer {
public:
    FrameBuffer(Pixels width, Pixels height, bool hdr = false, bool antiAliased = false);
 
    FrameBuffer(ScaleablePixels width, ScaleablePixels height, bool hdr = false,
                bool antiAliased = false);
 
    explicit FrameBuffer(std::array<Pixels, 2> size, bool hdr = false, bool antiAliased = false);
 
    FrameBuffer(const FrameBuffer&) = delete;
    FrameBuffer& operator=(const FrameBuffer&) = delete;
    FrameBuffer(FrameBuffer&&) noexcept;
    FrameBuffer& operator=(FrameBuffer&&) noexcept;
    ~FrameBuffer();
 
    struct Context {
        explicit Context(std::function<void()> resetCallback);
        Context(const Context&) = delete;
        Context& operator=(const Context&) = delete;
        Context(Context&&) noexcept;
        Context& operator=(Context&&) noexcept;
        ~Context();
 
        void clear();
 
        void clear(Rgb color);
 
        void clear(Rgba color);
 
    private:
        std::function<void()> resetCallback;
    };
 
#if __cplusplus >= 201703L
    [[nodiscard]]
#endif
    Context use() const;
 
    void draw(Vec2 position, const ShaderProgram* = nullptr) const;
    void draw(double x, double y) const;
 
    void draw(Mat3 modelview, const ShaderProgram* = nullptr) const;
 
    void draw(Mat3 modelview, TextureFilter textureFilter, const ShaderProgram* = nullptr) const;
 
    void drawMesh(const std::vector<Vertex>& vertexes, const ShaderProgram* = nullptr) const;
 
    void drawMesh(const Mat3& modelview, const std::vector<Vertex>& vertexes,
                  const ShaderProgram* shaderProgram = nullptr) const;
    void drawMesh(const Mat3& modelview, const std::vector<Vertex>& vertexes, Rgba color,
                  const ShaderProgram* = nullptr) const;
 
    [[deprecated("use jngl::FrameBuffer::Context::clear(Color) instead")]]
    static void clear();
 
    Vec2 getSize() const;
 
    Pixels getPixelWidth() const;
    Pixels getPixelHeight() const;
 
    [[deprecated("There's no OpenGL texture with other rendering backends, draw the FrameBuffer "
                 "with draw() instead")]]
    uint32_t getTextureID() const;
 
private:
    struct Impl;
    std::unique_ptr<Impl> impl;
};
 
} // namespace jngl