]> git.tdb.fi Git - libs/gl.git/blob - source/buffer.h
Fix filename handling in the Blender exporter on Windows
[libs/gl.git] / source / buffer.h
1 #ifndef MSP_GL_BUFFER_H_
2 #define MSP_GL_BUFFER_H_
3
4 #include <stdexcept>
5 #include <string>
6 #include <vector>
7 #include <msp/core/attributes.h>
8 #include "gl.h"
9 #include <msp/gl/extensions/arb_pixel_buffer_object.h>
10 #include <msp/gl/extensions/arb_vertex_buffer_object.h>
11 #include <msp/gl/extensions/arb_uniform_buffer_object.h>
12 #include <msp/gl/extensions/oes_mapbuffer.h>
13
14 namespace Msp {
15 namespace GL {
16
17 class buffer_too_small: public std::logic_error
18 {
19 public:
20         buffer_too_small(const std::string &w): std::logic_error(w) { }
21         virtual ~buffer_too_small() throw() { }
22 };
23
24 enum BufferType
25 {
26         ARRAY_BUFFER         = GL_ARRAY_BUFFER,
27         ELEMENT_ARRAY_BUFFER = GL_ELEMENT_ARRAY_BUFFER,
28         PIXEL_PACK_BUFFER    = GL_PIXEL_PACK_BUFFER,
29         PIXEL_UNPACK_BUFFER  = GL_PIXEL_UNPACK_BUFFER,
30         UNIFORM_BUFFER       = GL_UNIFORM_BUFFER
31 };
32
33 enum BufferUsage
34 {
35         STREAM_DRAW  = GL_STREAM_DRAW,
36         STREAM_READ  = GL_STREAM_READ,
37         STREAM_COPY  = GL_STREAM_COPY,
38         STATIC_DRAW  = GL_STATIC_DRAW,
39         STATIC_READ  = GL_STATIC_READ,
40         STATIC_COPY  = GL_STATIC_COPY,
41         DYNAMIC_DRAW = GL_DYNAMIC_DRAW,
42         DYNAMIC_READ = GL_DYNAMIC_READ,
43         DYNAMIC_COPY = GL_DYNAMIC_COPY
44 };
45
46 enum BufferAccess
47 {
48         READ_ONLY = GL_READ_ONLY,
49         WRITE_ONLY = GL_WRITE_ONLY,
50         READ_WRITE = GL_READ_WRITE
51 };
52
53 class BufferRange;
54
55 /**
56 A buffer for storing data in GL memory.  Putting vertex and index data in
57 buffers can improve rendering performance.  The VertexArray, Mesh and
58 UniformBlock classes contain built-in support for buffers.
59 */
60 class Buffer
61 {
62         friend class BufferRange;
63
64 private:
65         BufferType type;
66         unsigned id;
67         unsigned size;
68
69         static const Buffer *bound[5];
70
71 public:
72         Buffer(BufferType);
73         ~Buffer();
74
75 private:
76         static void require_buffer_type(BufferType);
77
78 public:
79         /** Returns the OpenGL ID of the buffer.  For internal use only. */
80         unsigned get_id() const { return id; }
81
82         /** Returns the default binding type for the buffer. */
83         BufferType get_type() const { return type; }
84
85         /** Defines the storage size of the buffer.  Must be called before data can
86         be uploaded.  Storage cannot be changed once set. */
87         void storage(unsigned);
88
89         /** Sets the usage hint of the buffer.  It will take effect the next time
90         the buffer's contents are defined. */
91         DEPRECATED void set_usage(BufferUsage);
92
93         /** Uploads data into the buffer, completely replacing any previous
94         contents.  Storage must be defined beforehand.  The data must have size
95         matching the defined storage. */
96         void data(const void *);
97
98         DEPRECATED void data(unsigned, const void *);
99
100         /** Overwrites part of the buffer data with new data.  Storage must be
101         defined beforehand. */
102         void sub_data(unsigned, unsigned, const void *);
103
104         unsigned get_size() const { return size; }
105
106         void require_size(unsigned) const;
107
108         BufferRange *create_range(unsigned, unsigned);
109
110         void *map();
111         DEPRECATED void *map(BufferAccess) { return map(); }
112         bool unmap();
113
114         /** Binds the buffer in its default slot. */
115         void bind() const { bind_to(type); }
116
117         /** Binds the buffer in an alternate slot. */
118         void bind_to(BufferType) const;
119
120         /** Unbinds the buffer from its default slot. */
121         void unbind() const { unbind_from(type); }
122
123         static const Buffer *current(BufferType);
124         static void unbind_from(BufferType);
125 private:
126         static const Buffer *&binding(BufferType);
127         static bool set_current(BufferType, const Buffer *);
128 };
129
130
131 /**
132 A proxy for a subset of a buffer.  Can be bound for use with uniform blocks.
133 */
134 class BufferRange
135 {
136 private:
137         Buffer &buffer;
138         unsigned offset;
139         unsigned size;
140
141         static std::vector<const BufferRange *> bound_uniform;
142
143 public:
144         BufferRange(Buffer &, unsigned, unsigned);
145         ~BufferRange();
146
147         void data(const void *);
148
149         void bind_to(BufferType, unsigned);
150
151         static const BufferRange *current(BufferType t, unsigned i) { return binding(t, i); }
152         static void unbind_from(BufferType, unsigned);
153 private:
154         static const BufferRange *&binding(BufferType, unsigned);
155         static bool set_current(BufferType, unsigned, const BufferRange *);
156
157 public:
158         static unsigned get_n_uniform_buffer_bindings();
159         static unsigned get_uniform_buffer_alignment();
160 };
161
162 } // namespace GL
163 } // namespace Msp
164
165 #endif