1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
use std::marker::PhantomData;
use std::collections::hash_map::{HashMap, Entry};
use std::borrow::BorrowMut;
use gl;
use gl::types::*;
use context::{AContext, BaseContext, ContextOf};
use framebuffer::Framebuffer;
use renderbuffer::{Renderbuffer, RenderbufferTarget};
use texture::{Texture, TextureType, ImageTargetType,
Texture2d, Tx2dImageTarget};
use types::{BufferBits, GLError, GLObject, GLFramebufferError};
pub trait ContextFramebufferExt: BaseContext {
unsafe fn gen_framebuffer(&self) -> Framebuffer {
let mut id : GLuint = 0;
gl::GenFramebuffers(1, &mut id as *mut GLuint);
dbg_gl_sanity_check! {
GLError::InvalidValue => "`n` is negative",
_ => "Unknown error"
}
Framebuffer::from_raw(id)
}
fn check_framebuffer_status(&self, gl_fbo: &FramebufferBinding)
-> Option<GLFramebufferError>
{
unsafe {
match gl::CheckFramebufferStatus(gl_fbo.target().gl_enum()) {
gl::FRAMEBUFFER_INCOMPLETE_ATTACHMENT => {
Some(GLFramebufferError::IncompleteAttachment)
},
gl::FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT => {
Some(GLFramebufferError::IncompleteMissingAttachment)
},
gl::FRAMEBUFFER_UNSUPPORTED => {
Some(GLFramebufferError::Unsupported)
},
_ => { None }
}
}
}
fn framebuffer_renderbuffer(&self,
gl_fbo: &mut FramebufferBinding,
attachment: FramebufferAttachment,
renderbuffer: &mut Renderbuffer)
{
let renderbuffer_target = RenderbufferTarget::Renderbuffer;
unsafe {
gl::FramebufferRenderbuffer(gl_fbo.target().gl_enum(),
attachment.gl_enum(),
renderbuffer_target.gl_enum(),
renderbuffer.id());
dbg_gl_sanity_check! {
GLError::InvalidEnum => "`target` is not `GL_FRAMEBUFFER`, `attachment` is not a valid attachment point, or `renderbuffer` is not `GL_RENDERBUFFER` and `renderbuffer` is not 0",
GLError::InvalidOperation => "Framebuffer 0 is bound, or `renderbuffer` is neither 0 nor the name of an existing renderbuffer object",
_ => "Unknown error"
}
}
}
fn framebuffer_texture_2d<I, T>(&self,
gl_fbo: &mut FramebufferBinding,
attachment: FramebufferAttachment,
tex_target: I,
texture: &mut Texture<T>,
level: i32)
where I: Into<T::ImageTargetType>,
T: TextureType,
{
debug_assert!(level == 0);
unsafe {
gl::FramebufferTexture2D(gl_fbo.target().gl_enum(),
attachment.gl_enum(),
tex_target.into().gl_enum(),
texture.id(),
level as GLint);
dbg_gl_sanity_check! {
GLError::InvalidEnum => "`target` is not `GL_FRAMEBUFFER`, `attachment` is not an accepted attachment point, or `textarget` is not an accepted texture target and texture is not 0",
GLError::InvalidValue => "`level` is not 0 and `texture` is not 0",
GLError::InvalidOperation => "Framebuffer object 0 is bound, `texture` is neither 0 nor the name of an existing texture object, or `textarget` is not a valid target for `texture`",
_ => "Unknown error"
}
}
}
fn clear(&self, buffers: BufferBits) {
unsafe {
gl::Clear(buffers.bits());
dbg_gl_sanity_check! {
GLError::InvalidValue => "`mask` includes a bit other than an allowed value",
_ => "Unkown error"
}
}
}
}
impl<C: BaseContext> ContextFramebufferExt for C {
}
enum BuilderAttachment<'a> {
Texture2d(&'a mut Texture2d, i32),
Renderbuffer(&'a mut Renderbuffer)
}
pub struct FramebufferBuilder<'a, C>
where C: FramebufferContext
{
gl: C,
attachments: HashMap<FramebufferAttachment, BuilderAttachment<'a>>
}
impl<'a, C> FramebufferBuilder<'a, C>
where C: FramebufferContext
{
fn new(gl: C) -> Self {
FramebufferBuilder {
gl: gl,
attachments: HashMap::new()
}
}
pub fn texture_2d(mut self,
attachment: FramebufferAttachment,
texture: &'a mut Texture2d,
level: i32)
-> Self
{
let attached = BuilderAttachment::Texture2d(texture, level);
match self.attachments.entry(attachment) {
Entry::Occupied(mut e) => { e.insert(attached); },
Entry::Vacant(e) => { e.insert(attached); }
};
self
}
pub fn renderbuffer(mut self,
attachment: FramebufferAttachment,
renderbuffer: &'a mut Renderbuffer)
-> Self
{
let attached = BuilderAttachment::Renderbuffer(renderbuffer);
match self.attachments.entry(attachment) {
Entry::Occupied(mut e) => { e.insert(attached); },
Entry::Vacant(e) => { e.insert(attached); }
};
self
}
pub fn try_unwrap(self) -> Result<Framebuffer, GLError> {
let gl = self.gl;
let mut fbo = unsafe { gl.gen_framebuffer() };
let fbo_status = {
let (mut gl_fbo, gl) = gl.bind_framebuffer(&mut fbo);
for (attachment, attached) in self.attachments.into_iter() {
match attached {
BuilderAttachment::Texture2d(texture, level) => {
gl.framebuffer_texture_2d(&mut gl_fbo,
attachment,
Tx2dImageTarget::Texture2d,
texture,
level);
},
BuilderAttachment::Renderbuffer(renderbuffer) => {
gl.framebuffer_renderbuffer(&mut gl_fbo,
attachment,
renderbuffer);
}
}
}
gl.check_framebuffer_status(&mut gl_fbo)
};
match fbo_status {
Some(err) => { Err(err.into()) },
None => { Ok(fbo) }
}
}
pub fn unwrap(self) -> Framebuffer {
self.try_unwrap().unwrap()
}
}
pub trait ContextFramebufferBuilderExt: FramebufferContext + Sized {
fn build_framebuffer<'a>(self) -> FramebufferBuilder<'a, Self> {
FramebufferBuilder::new(self)
}
}
impl<'b, C: 'b> ContextFramebufferBuilderExt for &'b mut C
where &'b mut C: FramebufferContext
{
}
gl_enum! {
pub gl_enum FramebufferTarget {
pub const Framebuffer as FRAMEBUFFER = gl::FRAMEBUFFER
}
}
gl_enum! {
pub gl_enum FramebufferAttachment {
pub const ColorAttachment0 as COLOR_ATTACHMENT0 =
gl::COLOR_ATTACHMENT0,
pub const DepthAttachment as DEPTH_ATTACHMENT =
gl::DEPTH_ATTACHMENT,
pub const StencilAttachment as STENCIL_ATTACHMENT =
gl::STENCIL_ATTACHMENT
}
}
pub trait FramebufferContext: AContext {
type Binder: BorrowMut<FramebufferBinder>;
type Rest: AContext;
fn split_framebuffer(self) -> (Self::Binder, Self::Rest);
fn bind_framebuffer<'a>(self, fbo: &'a mut Framebuffer)
-> (FramebufferBinding<'a>, Self::Rest)
where Self: Sized
{
let (mut binder, rest) = self.split_framebuffer();
(binder.borrow_mut().bind(fbo), rest)
}
}
impl<B, F, P, R, T> FramebufferContext for ContextOf<B, F, P, R, T>
where F: BorrowMut<FramebufferBinder>
{
type Binder = F;
type Rest = ContextOf<B, (), P, R, T>;
fn split_framebuffer(self) -> (Self::Binder, Self::Rest) {
self.swap_framebuffer(())
}
}
impl<'a, B, F, P, R, T> FramebufferContext for &'a mut ContextOf<B, F, P, R, T>
where F: BorrowMut<FramebufferBinder>
{
type Binder = &'a mut FramebufferBinder;
type Rest = ContextOf<&'a mut B, (), &'a mut P, &'a mut R, &'a mut T>;
fn split_framebuffer(self) -> (Self::Binder, Self::Rest) {
let gl = self.borrowed_mut();
gl.swap_framebuffer(())
}
}
pub struct FramebufferBinding<'a> {
_phantom_ref: PhantomData<&'a mut Framebuffer>,
_phantom_ptr: PhantomData<*mut ()>
}
impl<'a> FramebufferBinding<'a> {
fn target(&self) -> FramebufferTarget {
FramebufferTarget::Framebuffer
}
}
pub struct FramebufferBinder {
_phantom: PhantomData<*mut ()>
}
impl FramebufferBinder {
pub unsafe fn current() -> Self {
FramebufferBinder {
_phantom: PhantomData
}
}
pub unsafe fn current_binding(&mut self) -> FramebufferBinding {
FramebufferBinding {
_phantom_ref: PhantomData,
_phantom_ptr: PhantomData
}
}
pub fn bind<'a>(&mut self, fbo: &'a mut Framebuffer)
-> FramebufferBinding<'a>
{
let binding = FramebufferBinding {
_phantom_ref: PhantomData,
_phantom_ptr: PhantomData
};
unsafe {
gl::BindFramebuffer(binding.target().gl_enum(), fbo.id());
dbg_gl_sanity_check! {
GLError::InvalidEnum => "`target` is not `GL_FRAMEBUFFER`",
_ => "Unknown error"
}
}
binding
}
}