#include <stdexcept>
#include <string>
-#include <vector>
-#include <msp/core/attributes.h>
-#include "gl.h"
-#include <msp/gl/extensions/arb_pixel_buffer_object.h>
-#include <msp/gl/extensions/arb_vertex_buffer_object.h>
-#include <msp/gl/extensions/arb_uniform_buffer_object.h>
-#include <msp/gl/extensions/oes_mapbuffer.h>
+#include "buffer_backend.h"
namespace Msp {
namespace GL {
enum BufferUsage
{
- STREAM_DRAW = GL_STREAM_DRAW,
- STREAM_READ = GL_STREAM_READ,
- STREAM_COPY = GL_STREAM_COPY,
- STATIC_DRAW = GL_STATIC_DRAW,
- STATIC_READ = GL_STATIC_READ,
- STATIC_COPY = GL_STATIC_COPY,
- DYNAMIC_DRAW = GL_DYNAMIC_DRAW,
- DYNAMIC_READ = GL_DYNAMIC_READ,
- DYNAMIC_COPY = GL_DYNAMIC_COPY
+ STATIC,
+ STREAMING
};
-enum BufferAccess
-{
- READ_ONLY = GL_READ_ONLY,
- WRITE_ONLY = GL_WRITE_ONLY,
- READ_WRITE = GL_READ_WRITE
-};
+/**
+Stores data in GPU memory.
-class BufferRange;
+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.
-/**
-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.
+Buffers can have a static or streaming usage pattern. Streaming buffers can be
+memory mapped for less update overhead, but memory space is more limited. If
+the buffer is updated only rarely, static is recommended.
+
+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
{
- friend class BufferRange;
-
-private:
- unsigned id;
- unsigned size;
- bool allocated;
+ friend BufferBackend;
public:
- Buffer();
- ~Buffer();
+ /**
+ An RAII handle for asynchronously writing data into a buffer.
+ */
+ class AsyncTransfer: public NonCopyable
+ {
+ friend BufferBackend;
+ friend class Buffer;
+
+ private:
+ Buffer *buffer = 0;
+ std::size_t offset = 0;
+ std::size_t size = 0;
+ void *dest_addr = 0;
+
+ AsyncTransfer(Buffer &, std::size_t, std::size_t);
+ public:
+ AsyncTransfer() = default;
+ AsyncTransfer(AsyncTransfer &&);
+ AsyncTransfer &operator=(AsyncTransfer &&);
+ ~AsyncTransfer();
+
+ private:
+ void allocate();
+ void finalize();
+
+ public:
+ /** Returns an address for writing the data. It should not be used
+ beyond the lifetime of the object. */
+ void *get_address() { return dest_addr; }
+ };
- /** Returns the OpenGL ID of the buffer. For internal use only. */
- unsigned get_id() const { return id; }
-
- /** 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();
+private:
+ std::size_t size = 0;
+ BufferUsage usage = STATIC;
+ bool mapped = false;
- /** Sets the usage hint of the buffer. It will take effect the next time
- the buffer's contents are defined. */
- DEPRECATED void set_usage(BufferUsage);
+public:
+ /** Sets storage size and usage pattern and allocates memory for the buffer.
+ Size and usage cannot be changed once set. */
+ void storage(std::size_t, BufferUsage);
- /** 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 *);
- DEPRECATED void data(unsigned, const void *);
+ /** 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 *);
- /** Overwrites part of the buffer data with new data. Storage must be
- defined beforehand. */
- void sub_data(unsigned, unsigned, const void *);
+ /** Creates an asynchronous transfer for writing data to a range of bytes in
+ the buffer. While the transfer is pending, the state of the buffer region
+ is indeterminate. */
+ AsyncTransfer sub_data_async(std::size_t, std::size_t);
- unsigned get_size() const { return size; }
+private:
+ void check_sub_data(std::size_t, std::size_t, const char *);
+
+public:
+ std::size_t get_size() const { return size; }
+ using BufferBackend::get_multiplicity;
+ std::size_t get_total_size() const { return size*get_multiplicity(); }
+ BufferUsage get_usage() const { return usage; }
- void require_size(unsigned) const;
+ void require_size(std::size_t) const;
void *map();
- DEPRECATED void *map(BufferAccess) { return map(); }
bool unmap();
- void set_debug_name(const std::string &);
+ using BufferBackend::set_debug_name;
};
} // namespace GL
projects / libs / gl.git / blobdiff