include/core/framebuffer.hpp

   1 #ifndef _framebuffer__hpp__included__
   2 #define _framebuffer__hpp__included__
   3
   4 #include "core/render.hpp"
   5
   6 /**
   7  * The main framebuffer.
   8  */
   9 extern lcscreen framebuffer;
  10 /**
  11  * Special screen: "NO SIGNAL".
  12  */
  13 extern lcscreen screen_nosignal;
  14 /**
  15  * Special screen: "SYSTEM STATE CORRUPT".
  16  */
  17 extern lcscreen screen_corrupt;
  18 /**
  19  * The main screen to draw on.
  20  */
  21 extern screen<false> main_screen;
  22 /**
  23  * Initialize special screens.
  24  *
  25  * throws std::bad_alloc: Not enough memory.
  26  */
  27 void init_special_screens() throw(std::bad_alloc);
  28 /**
  29  * Copy framebuffer to backing store, running Lua hooks if any.
  30  */
  31 void redraw_framebuffer(lcscreen& torender, bool no_lua = false);
  32 /**
  33  * Redraw the framebuffer, reusing contents from last redraw. Runs lua hooks if last redraw ran them.
  34  */
  35 void redraw_framebuffer();
  36 /**
  37  * Return last complete framebuffer.
  38  */
  39 lcscreen get_framebuffer() throw(std::bad_alloc);
  40 /**
  41  * Render framebuffer to main screen.
  42  */
  43 void render_framebuffer();
  44 /**
  45  * Get the size of current framebuffer.
  46  */
  47 std::pair<uint32_t, uint32_t> get_framebuffer_size();
  48 /**
  49  * Take a screenshot to specified file.
  50  */
  51 void take_screenshot(const std::string& file) throw(std::bad_alloc, std::runtime_error);
  52 /**
  53  * Get scale factors.
  54  */
  55 std::pair<uint32_t, uint32_t> get_scale_factors(uint32_t width, uint32_t height);
  56
  57 #endif