source/core/buffer.h

   1 #ifndef MSP_GL_BUFFER_H_
   2 #define MSP_GL_BUFFER_H_
   3
   4 #include <stdexcept>
   5 #include <string>
   6 #include "buffer_backend.h"
   7
   8 namespace Msp {
   9 namespace GL {
  10
  11 class buffer_too_small: public std::logic_error
  12 {
  13 public:
  14         buffer_too_small(const std::string &w): std::logic_error(w) { }
  15         virtual ~buffer_too_small() throw() { }
  16 };
  17
  18 enum BufferUsage
  19 {
  20         STATIC,
  21         STREAMING
  22 };
  23
  24 /**
  25 Stores data in GPU memory.
  26
  27 Memory must be allocated for the buffer by calling storage().  Contents can
  28 then be modified either synchronously with the data() and sub_data() functions,
  29 or asynchronously by memory-mapping the buffer.
  30
  31 Buffers can have a static or streaming usage pattern.  Streaming buffers can be
  32 memory mapped for less update overhead, but memory space is more limited.  If
  33 the buffer is updated only rarely, static is recommended.
  34
  35 Applications normally don't need to deal with Buffers directly.  They're
  36 managed by other classes such as Mesh and ProgramData.
  37 */
  38 class Buffer: public BufferBackend
  39 {
  40         friend BufferBackend;
  41
  42 private:
  43         std::size_t size = 0;
  44         BufferUsage usage = STATIC;
  45         bool mapped = false;
  46
  47 public:
  48         /** Sets storage size and usage pattern and allocates memory for the buffer.
  49         Size and usage cannot be changed once set. */
  50         void storage(std::size_t, BufferUsage);
  51
  52         /** Replaces contents of the entire buffer.  Allocated storage must exist.
  53         The data must have size matching the defined storage. */
  54         void data(const void *);
  55
  56         /** Replaces a range of bytes in the buffer.  Allocated storage must exist.
  57         The range must be fully inside the buffer. */
  58         void sub_data(std::size_t, std::size_t, const void *);
  59
  60         std::size_t get_size() const { return size; }
  61         BufferUsage get_usage() const { return usage; }
  62
  63         void require_size(std::size_t) const;
  64
  65         void *map();
  66         bool unmap();
  67
  68         using BufferBackend::set_debug_name;
  69 };
  70
  71 } // namespace GL
  72 } // namespace Msp
  73
  74 #endif