]> git.tdb.fi Git - libs/gl.git/blob - source/buffer.cpp
Deprecate some Buffer features which don't translate to Vulkan
[libs/gl.git] / source / buffer.cpp
1 #include <stdexcept>
2 #include <msp/gl/extensions/arb_direct_state_access.h>
3 #include <msp/gl/extensions/arb_map_buffer_range.h>
4 #include <msp/strings/format.h>
5 #include "buffer.h"
6 #include "error.h"
7 #include "misc.h"
8 #include "vertexsetup.h"
9
10 using namespace std;
11
12 namespace Msp {
13 namespace GL {
14
15 const Buffer *Buffer::bound[5] = { 0, 0, 0, 0, 0 };
16 BufferType buffer_types[] = { ARRAY_BUFFER, ELEMENT_ARRAY_BUFFER, PIXEL_PACK_BUFFER, PIXEL_UNPACK_BUFFER, UNIFORM_BUFFER };
17
18 Buffer::Buffer(BufferType t):
19         type(t),
20         usage(STATIC_DRAW),
21         size(0)
22 {
23         require_buffer_type(type);
24
25         if(ARB_direct_state_access)
26                 glCreateBuffers(1, &id);
27         else
28                 glGenBuffers(1, &id);
29 }
30
31 Buffer::~Buffer()
32 {
33         for(unsigned i=0; i<5; ++i)
34                 if(bound[i]==this)
35                         unbind_from(buffer_types[i]);
36         glDeleteBuffers(1, &id);
37 }
38
39 void Buffer::require_buffer_type(BufferType type)
40 {
41         static Require _req_vbo(ARB_vertex_buffer_object);
42         if(type==PIXEL_PACK_BUFFER || type==PIXEL_UNPACK_BUFFER)
43                 static Require _req_pbo(ARB_pixel_buffer_object);
44         else if(type==UNIFORM_BUFFER)
45                 static Require _req_ubo(ARB_uniform_buffer_object);
46 }
47
48 void Buffer::set_usage(BufferUsage u)
49 {
50         // TODO OpenGL ES 2.0 doesn't support read or copy usages
51         usage = u;
52 }
53
54 void Buffer::data(unsigned sz, const void *d)
55 {
56         if(ARB_direct_state_access)
57                 glNamedBufferData(id, sz, d, usage);
58         else
59         {
60                 BindRestore _bind(this, type);
61                 glBufferData(type, sz, d, usage);
62         }
63         size = sz;
64 }
65
66 void Buffer::sub_data(unsigned off, unsigned sz, const void *d)
67 {
68         if(ARB_direct_state_access)
69                 glNamedBufferSubData(id, off, sz, d);
70         else
71         {
72                 BindRestore _bind(this, type);
73                 glBufferSubData(type, off, sz, d);
74         }
75 }
76
77 void Buffer::require_size(unsigned req_sz) const
78 {
79         if(size<req_sz)
80                 throw buffer_too_small(format("buffer has %d bytes; %d required", size, req_sz));
81 }
82
83 BufferRange *Buffer::create_range(unsigned s, unsigned o)
84 {
85         return new BufferRange(*this, s, o);
86 }
87
88 void *Buffer::map()
89 {
90         if(ARB_map_buffer_range)
91         {
92                 if(ARB_direct_state_access)
93                         return glMapNamedBufferRange(id, 0, size, GL_MAP_READ_BIT|GL_MAP_WRITE_BIT);
94                 else
95                 {
96                         BindRestore _bind(this, type);
97                         return glMapBufferRange(type, 0, size, GL_MAP_READ_BIT|GL_MAP_WRITE_BIT);
98                 }
99         }
100         else if(ARB_direct_state_access)
101                 return glMapNamedBuffer(id, GL_READ_WRITE);
102         else if(OES_mapbuffer)
103         {
104                 BindRestore _bind(this, type);
105                 return glMapBuffer(type, GL_READ_WRITE);
106         }
107         else
108                 throw invalid_operation("Buffer::map");
109 }
110
111 bool Buffer::unmap()
112 {
113         // TODO check if it's mapped
114         if(ARB_direct_state_access)
115                 return glUnmapNamedBuffer(id);
116         else if(OES_mapbuffer)
117         {
118                 BindRestore _bind(this, type);
119                 return glUnmapBuffer(type);
120         }
121         else
122                 return true;
123 }
124
125 void Buffer::bind_to(BufferType t) const
126 {
127         if(t!=type)
128                 require_buffer_type(t);
129         if(t==ELEMENT_ARRAY_BUFFER)
130                 if(const VertexSetup *vs = VertexSetup::current())
131                 {
132                         // Don't change the binding in a vertex array object
133                         if(this==vs->get_index_buffer())
134                                 return;
135                         throw invalid_operation("Buffer::bind_to(ELEMENT_ARRAY_BUFFER)");
136                 }
137         if(set_current(t, this))
138                 glBindBuffer(t, id);
139 }
140
141 const Buffer *Buffer::current(BufferType t)
142 {
143         if(t==ELEMENT_ARRAY_BUFFER)
144                 if(const VertexSetup *vs = VertexSetup::current())
145                         return vs->get_index_buffer();
146         return binding(t);
147 }
148
149 void Buffer::unbind_from(BufferType type)
150 {
151         if(type==ELEMENT_ARRAY_BUFFER && VertexSetup::current())
152                 throw invalid_operation("Buffer::unbind_from(ELEMENT_ARRAY_BUFFER)");
153         if(set_current(type, 0))
154                 glBindBuffer(type, 0);
155 }
156
157 const Buffer *&Buffer::binding(BufferType type)
158 {
159         switch(type)
160         {
161         case ARRAY_BUFFER:         return bound[0];
162         case ELEMENT_ARRAY_BUFFER: return bound[1];
163         case PIXEL_PACK_BUFFER:    return bound[2];
164         case PIXEL_UNPACK_BUFFER:  return bound[3];
165         case UNIFORM_BUFFER:       return bound[4];
166         default: throw invalid_argument("Buffer::binding");
167         }
168 }
169
170 bool Buffer::set_current(BufferType type, const Buffer *buf)
171 {
172         const Buffer *&ptr = binding(type);
173         if(ptr==buf)
174                 return false;
175
176         ptr = buf;
177         return true;
178 }
179
180
181 vector<const BufferRange *> BufferRange::bound_uniform;
182
183 BufferRange::BufferRange(Buffer &b, unsigned o, unsigned s):
184         buffer(b),
185         offset(o),
186         size(s)
187 {
188         if(o>buffer.get_size() || o+s>buffer.get_size())
189                 throw out_of_range("BufferRange::BufferRange");
190 }
191
192 BufferRange::~BufferRange()
193 {
194         for(unsigned i=0; i<bound_uniform.size(); ++i)
195                 if(bound_uniform[i]==this)
196                         unbind_from(UNIFORM_BUFFER, i);
197 }
198
199 void BufferRange::data(const void *d)
200 {
201         buffer.sub_data(offset, size, d);
202 }
203
204 void BufferRange::bind_to(BufferType t, unsigned i)
205 {
206         if(t!=buffer.type)
207                 Buffer::require_buffer_type(t);
208         if(set_current(t, i, this))
209         {
210                 // The buffer gets bound as a side effect
211                 Buffer::set_current(t, &buffer);
212                 glBindBufferRange(t, i, buffer.id, offset, size);
213         }
214 }
215
216 void BufferRange::unbind_from(BufferType t, unsigned i)
217 {
218         if(set_current(t, i, 0))
219         {
220                 Buffer::set_current(t, 0);
221                 glBindBufferBase(t, i, 0);
222         }
223 }
224
225 const BufferRange *&BufferRange::binding(BufferType type, unsigned index)
226 {
227         if(type==UNIFORM_BUFFER)
228         {
229                 if(index>=get_n_uniform_buffer_bindings())
230                         throw out_of_range("BufferRange::binding");
231                 if(bound_uniform.size()<=index)
232                         bound_uniform.resize(index+1);
233                 return bound_uniform[index];
234         }
235         else
236                 throw invalid_argument("BufferRange::binding");
237 }
238
239 bool BufferRange::set_current(BufferType type, unsigned index, const BufferRange *buf)
240 {
241         const BufferRange *&ptr = binding(type, index);
242         if(ptr==buf)
243                 return false;
244
245         ptr = buf;
246         return true;
247 }
248
249 unsigned BufferRange::get_n_uniform_buffer_bindings()
250 {
251         static unsigned count = get_i(GL_MAX_UNIFORM_BUFFER_BINDINGS);
252         return count;
253 }
254
255 unsigned BufferRange::get_uniform_buffer_alignment()
256 {
257         static unsigned align = get_i(GL_UNIFORM_BUFFER_OFFSET_ALIGNMENT);
258         return align;
259 }
260
261 } // namespace GL
262 } // namespace Msp