-/* $Id$
-
-This file is part of libmspgl
-Copyright © 2007 Mikko Rasa, Mikkosoft Productions
-Distributed under the LGPL
-*/
-
#ifndef MSP_GL_BUFFER_H_
#define MSP_GL_BUFFER_H_
+#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>
namespace Msp {
namespace GL {
+class buffer_too_small: public std::logic_error
+{
+public:
+ buffer_too_small(const std::string &w): std::logic_error(w) { }
+ virtual ~buffer_too_small() throw() { }
+};
+
enum BufferType
{
- ARRAY_BUFFER = GL_ARRAY_BUFFER_ARB,
- ELEMENT_ARRAY_BUFFER = GL_ELEMENT_ARRAY_BUFFER_ARB,
- PIXEL_PACK_BUFFER = GL_PIXEL_PACK_BUFFER_ARB,
- PIXEL_UNPACK_BUFFER = GL_PIXEL_UNPACK_BUFFER_ARB
+ ARRAY_BUFFER = GL_ARRAY_BUFFER,
+ ELEMENT_ARRAY_BUFFER = GL_ELEMENT_ARRAY_BUFFER,
+ PIXEL_PACK_BUFFER = GL_PIXEL_PACK_BUFFER,
+ PIXEL_UNPACK_BUFFER = GL_PIXEL_UNPACK_BUFFER,
+ UNIFORM_BUFFER = GL_UNIFORM_BUFFER
};
enum BufferUsage
{
- STREAM_DRAW = GL_STREAM_DRAW_ARB,
- STREAM_READ = GL_STREAM_READ_ARB,
- STREAM_COPY = GL_STREAM_COPY_ARB,
- STATIC_DRAW = GL_STATIC_DRAW_ARB,
- STATIC_READ = GL_STATIC_READ_ARB,
- STATIC_COPY = GL_STATIC_COPY_ARB,
- DYNAMIC_DRAW = GL_DYNAMIC_DRAW_ARB,
- DYNAMIC_READ = GL_DYNAMIC_READ_ARB,
- DYNAMIC_COPY = GL_DYNAMIC_COPY_ARB
+ 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
+};
+
+enum BufferAccess
+{
+ READ_ONLY = GL_READ_ONLY,
+ WRITE_ONLY = GL_WRITE_ONLY,
+ READ_WRITE = GL_READ_WRITE
};
+class BufferRange;
+
/**
A buffer for storing data in GL memory. Putting vertex and index data in
-buffers can improve rendering performance. The VertexArray and Mesh classes
-contain built-in support for buffers.
+buffers can improve rendering performance. The VertexArray, Mesh and
+UniformBlock classes contain built-in support for buffers.
*/
class Buffer
{
+ friend class BufferRange;
+
private:
BufferType type;
BufferUsage usage;
unsigned id;
+ unsigned size;
- static const Buffer *bound[4];
+ static const Buffer *bound[5];
public:
Buffer(BufferType);
~Buffer();
- /** Binds the buffer in its default slot. */
- void bind() const { bind(type); }
-
- /** Binds the buffer in an alternate slot. */
- void bind(BufferType) const;
-
private:
- void maybe_bind() const;
+ static void require_buffer_type(BufferType);
public:
- /** Unbinds the buffer from its default slot. */
- void unbind() const { unbind(type); }
+ /** Returns the OpenGL ID of the buffer. For internal use only. */
+ unsigned get_id() const { return id; }
+
+ /** Returns the default binding type for the buffer. */
+ BufferType get_type() const { return type; }
+
+ /** Defines the storage size of the buffer. Must be called before data can
+ be uploaded. Storage cannot be changed once set. */
+ void storage(unsigned);
/** Sets the usage hint of the buffer. It will take effect the next time
the buffer's contents are defined. */
- void set_usage(BufferUsage);
+ DEPRECATED void set_usage(BufferUsage);
/** Uploads data into the buffer, completely replacing any previous
- contents. */
- void data(unsigned, const void *);
+ contents. Storage must be defined beforehand. The data must have size
+ matching the defined storage. */
+ void data(const void *);
+
+ DEPRECATED void data(unsigned, const void *);
- /** Overwrites part of the buffer data with new data. The buffer size can
- not be changed with this call. */
+ /** Overwrites part of the buffer data with new data. Storage must be
+ defined beforehand. */
void sub_data(unsigned, unsigned, const void *);
- static void unbind(BufferType);
+ unsigned get_size() const { return size; }
+
+ void require_size(unsigned) const;
+
+ BufferRange *create_range(unsigned, unsigned);
+
+ void *map();
+ DEPRECATED void *map(BufferAccess) { return map(); }
+ bool unmap();
+
+ /** Binds the buffer in its default slot. */
+ void bind() const { bind_to(type); }
+
+ /** Binds the buffer in an alternate slot. */
+ void bind_to(BufferType) const;
+
+ /** Unbinds the buffer from its default slot. */
+ void unbind() const { unbind_from(type); }
+
+ static const Buffer *current(BufferType);
+ static void unbind_from(BufferType);
private:
static const Buffer *&binding(BufferType);
+ static bool set_current(BufferType, const Buffer *);
+};
+
+
+/**
+A proxy for a subset of a buffer. Can be bound for use with uniform blocks.
+*/
+class BufferRange
+{
+private:
+ Buffer &buffer;
+ unsigned offset;
+ unsigned size;
+
+ static std::vector<const BufferRange *> bound_uniform;
+
+public:
+ BufferRange(Buffer &, unsigned, unsigned);
+ ~BufferRange();
+
+ void data(const void *);
+
+ void bind_to(BufferType, unsigned);
+
+ static const BufferRange *current(BufferType t, unsigned i) { return binding(t, i); }
+ static void unbind_from(BufferType, unsigned);
+private:
+ static const BufferRange *&binding(BufferType, unsigned);
+ static bool set_current(BufferType, unsigned, const BufferRange *);
+
+public:
+ static unsigned get_n_uniform_buffer_bindings();
+ static unsigned get_uniform_buffer_alignment();
};
} // namespace GL