X-Git-Url: http://git.tdb.fi/?p=libs%2Fgl.git;a=blobdiff_plain;f=source%2Fcore%2Fbuffer.h;h=b642738e0e96ef370a5e748701be071998e2de54;hp=0d656131dd331b75ec3af57ff81581c9e2b2a3a5;hb=959efbf61663efd7879070ce0447e02c8a447ce0;hpb=6065f6622cc275dc0b20baaf7c267e71169d18f3 diff --git a/source/core/buffer.h b/source/core/buffer.h index 0d656131..b642738e 100644 --- a/source/core/buffer.h +++ b/source/core/buffer.h @@ -3,8 +3,7 @@ #include #include -#include -#include "gl.h" +#include "buffer_backend.h" namespace Msp { namespace GL { @@ -16,59 +15,44 @@ public: virtual ~buffer_too_small() throw() { } }; -class BufferRange; - /** -A buffer for storing data in GL memory. Putting vertex and index data in -buffers can improve rendering performance. The VertexArray, Mesh and -UniformBlock classes contain built-in support for buffers. +Stores data in GPU memory. + +Memory must be allocated for the buffer by calling storage(). Contents can +then be modified either synchronously with the data() and sub_data() functions, +or asynchronously by memory-mapping the buffer. + +Applications normally don't need to deal with Buffers directly. They're +managed by other classes such as Mesh and ProgramData. */ -class Buffer +class Buffer: public BufferBackend { -private: - unsigned id; - unsigned size; - bool allocated; + friend BufferBackend; - static Buffer *scratch_binding; +private: + std::size_t size = 0; public: - Buffer(); - ~Buffer(); - - /** Returns the OpenGL ID of the buffer. For internal use only. */ - unsigned get_id() const { return id; } + /** Sets the storage size and allocates memory for the buffer. Size cannot + be changed once set. */ + void storage(std::size_t); - /** Defines the storage size of the buffer. Must be called before data can - be uploaded. Storage cannot be changed once set. */ - void storage(unsigned); - - /** Allocates storage for the buffer. The contents are initially undefined. - If storage has already been allocated, does nothing. */ - void allocate(); - - /** Uploads data into the buffer, completely replacing any previous - contents. Storage must be defined beforehand. The data must have size - matching the defined storage. */ + /** Replaces contents of the entire buffer. Allocated storage must exist. + The data must have size matching the defined storage. */ void data(const void *); - /** Overwrites part of the buffer data with new data. Storage must be - defined beforehand. */ - void sub_data(unsigned, unsigned, const void *); - - unsigned get_size() const { return size; } + /** Replaces a range of bytes in the buffer. Allocated storage must exist. + The range must be fully inside the buffer. */ + void sub_data(std::size_t, std::size_t, const void *); - void require_size(unsigned) const; + std::size_t get_size() const { return size; } - void *map(); - bool unmap(); + void require_size(std::size_t) const; - void set_debug_name(const std::string &); + using BufferBackend::map; + using BufferBackend::unmap; -private: - void bind_scratch(); -public: - static void unbind_scratch(); + using BufferBackend::set_debug_name; }; } // namespace GL