graphics_context.h

Go to the documentation of this file.

#pragma once
 
#include <liboscar/graphics/anti_aliasing_level.h>
#include <liboscar/graphics/color.h>
#include <liboscar/graphics/texture2d.h>
 
#include <future>
#include <string>
 
struct SDL_Window;
 
namespace osc
{
    // graphics context
    //
    // should be initialized exactly once by the application
    class GraphicsContext final {
    public:
        explicit GraphicsContext(SDL_Window&);
        GraphicsContext(const GraphicsContext&) = delete;
        GraphicsContext(GraphicsContext&&) noexcept = delete;
        GraphicsContext& operator=(const GraphicsContext&) = delete;
        GraphicsContext& operator=(GraphicsContext&&) noexcept = delete;
        ~GraphicsContext() noexcept;
 
        AntiAliasingLevel max_antialiasing_level() const;
 
        bool vsync_enabled() const;
        void set_vsync_enabled(bool);
 
        bool debug_mode() const;
        void set_debug_mode(bool);
 
        void main_window_clear(const Color&);
 
        // Returns a future that asynchronously yields a complete screenshot
        // of the next frame once it has been rendered.
        //
        // - Completion of the future depends on the main thread continuing to
        //   draw/pump stuff, so you can't `get()` this future from the main
        //   thread (it's a deadlock or, at least, an exception, to do so).
        std::future<Texture2D> request_screenshot();
 
        // execute the "swap chain" operation, which makes the current backbuffer the frontbuffer and
        // the frontbuffer the backbuffer
        void swap_buffers(SDL_Window&);
 
        // human-readable identifier strings: useful for printouts/debugging
        std::string backend_vendor_string() const;
        std::string backend_renderer_string() const;
        std::string backend_version_string() const;
        std::string backend_shading_language_version_string() const;
 
        class Impl;
    private:
        // no data - it uses globals (you can only have one of these, globally)
    };
}