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
use super::framebuffer::*;
use super::texture::*;
use super::pipeline::*;
use super::buffer::*;
use super::raw::*;
use vertex_array_object::*;
use compute_program::ComputeProgram;

use std;
use glutin;

mod errors {
    error_chain! {
        errors {
        }
    }
}

use self::errors::*;

#[derive(Copy, Clone)]
pub struct BufferObjectTargetLocation<'a> {
    pub target: BufferBaseTarget,
    pub index: BlockIndex,
    pub buffer: &'a Buffer,
}

impl<'a> std::fmt::Debug for BufferObjectTargetLocation<'a> {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(
            f,
            "BufferObjectTargetLocation {{ target: {:?}, index: {:?}, buffer id: {:?} }}",
            self.target,
            self.index,
            self.buffer.get_id()
        )
    }
}

pub struct Renderer<'a, C: glutin::GlContext + 'a> {
    context: &'a C,
    state: FramebufferState,
    vertex_array_object: VertexArrayObjectId,
    default_framebuffer: DefaultFramebuffer,
}

impl<'a, C: glutin::GlContext> Renderer<'a, C> {
    pub fn new(context: &'a C) -> Result<Renderer<'a, C>> {
        unsafe {
            context
                .make_current()
                .chain_err(|| "Unable to make Renderer context current")?;
        }

        gl::load_with(|symbol| context.get_proc_address(symbol) as *const _);

        // Create empty VAO to satisfy OpenGL Core requirement
        let vao;
        unsafe {
            vao = create_vertex_array();
            bind_vertex_array(vao);
        }

        Ok(Renderer {
            context: context,
            state: FramebufferState::default(),
            vertex_array_object: vao,
            default_framebuffer: DefaultFramebuffer::new(),
        })
    }

    pub fn bind_default_framebuffer(&mut self) {
        self.default_framebuffer.bind();
        self.state.sync(&self.default_framebuffer.state());
    }

    pub fn bind_framebuffer(&mut self, framebuffer: &GeneralFramebuffer) {
        framebuffer.bind();
        self.state.sync(&framebuffer.state());
    }

    pub fn clear_default_framebuffer(&mut self, buffers: ClearBuffers) -> () {
        self.bind_default_framebuffer();

        unsafe {
            clear(buffers);
        }
    }

    pub fn clear_framebuffer(
        &mut self,
        framebuffer: &GeneralFramebuffer,
        buffers: ClearBuffers,
    ) -> () {
        self.bind_framebuffer(framebuffer);

        unsafe {
            clear(buffers);
        }
    }

    pub fn multi_draw_arrays_indirect(
        &mut self,
        framebuffer: &FramebufferRenderTarget,
        buffers: &[BufferObjectTargetLocation],
        textures: &[&Texture],
        pipeline: &Pipeline,
        draw_commands_buffer: (&Buffer, usize),
        clear_buffers: ClearBuffers,
    ) -> Result<()> {
        match *framebuffer {
            FramebufferRenderTarget::Default => self.bind_default_framebuffer(),
            FramebufferRenderTarget::General(framebuffer, attachments) => {
                self.bind_framebuffer(framebuffer);
                framebuffer
                    .attach_textures(attachments)
                    .chain_err(|| "Could not attach textures")?;
            }
        }

        if let &FramebufferRenderTarget::General(fbo, attachments) = framebuffer {
            fbo.attach_textures(attachments)
                .chain_err(|| "Could not attach textures")?;
        };


        let res_textures: Vec<ResidentTexture> = textures
            .iter()
            .map(|t| t.make_resident_texture())
            .collect::<_>();

        unsafe {
            if clear_buffers != ClearBuffers::None {
                clear(clear_buffers);
            }
        }

        pipeline.bind();

        // TODO refactor into 4 bind buffers
        for buffer_target in buffers {
            unsafe {
                bind_buffer_base(
                    buffer_target.target,
                    buffer_target.index,
                    buffer_target.buffer.get_id(),
                ).chain_err(
                    || format!("Unable to bind buffer {:?}", buffer_target),
                )?;
            }
        }

        unsafe {
            bind_buffer(
                BindBufferTarget::DrawIndirectBuffer,
                draw_commands_buffer.0.get_id(),
            ).chain_err(|| "Could not bind draw indirect buffer")?;
            multi_draw_arrays_indirect(draw_commands_buffer.1).chain_err(|| "Could not draw")?;
        }

        Ok(())
    }

    ///
    /// # Arguments
    ///
    /// * `framebuffer`
    /// * `buffers`
    /// * `textures`
    /// * `pipeline`
    /// * `draw commands buffer`
    /// * `clear buffers`
    ///
    /// # Example
    ///
    pub fn multi_draw_elements_indirect(
        &mut self,
        framebuffer: &FramebufferRenderTarget,
        buffers: &[BufferObjectTargetLocation],
        textures: &[&Texture],
        pipeline: &Pipeline,
        draw_commands_buffer: (&Buffer, usize),
        clear_buffers: ClearBuffers,
    ) -> Result<()> {
        // Bind framebuffer (which also syncs its state) and attach textures
        // in case of GeneralFramebuffer
        match *framebuffer {
            FramebufferRenderTarget::Default => self.bind_default_framebuffer(),
            FramebufferRenderTarget::General(framebuffer, attachments) => {
                self.bind_framebuffer(framebuffer);
                framebuffer
                    .attach_textures(attachments)
                    .chain_err(|| "Could not attach textures")?;
            }
        }

        // Make needed textures resident
        let res_textures: Vec<ResidentTexture> = textures
            .iter()
            .map(|t| t.make_resident_texture())
            .collect::<_>();

        // Clear the requested buffers
        unsafe {
            if clear_buffers != ClearBuffers::None {
                clear(clear_buffers);
            }
        }

        // Bind the pipeline
        pipeline.bind();

        // Bind buffers
        // TODO refactor into 4 bind buffers
        for buffer_target in buffers {
            unsafe {
                bind_buffer_base(
                    buffer_target.target,
                    buffer_target.index,
                    buffer_target.buffer.get_id(),
                ).chain_err(
                    || format!("Unable to bind buffer {:?}", buffer_target),
                )?;
            }
        }

        // Bind draw command buffer
        // Draw
        unsafe {
            bind_buffer(
                BindBufferTarget::DrawIndirectBuffer,
                draw_commands_buffer.0.get_id(),
            ).chain_err(|| "Could not bind draw indirect buffer")?;

            multi_draw_elements_indirect(draw_commands_buffer.1).chain_err(|| "Could not draw")?;
        }

        Ok(())
    }

    pub fn draw_arrays(
        &mut self,
        framebuffer: &FramebufferRenderTarget,
        buffers: &[BufferObjectTargetLocation],
        textures: &[&Texture],
        pipeline: &Pipeline,
        first: usize,
        count: usize,
        clear_buffers: ClearBuffers,
    ) -> Result<()> {
        // Bind framebuffer (which also syncs its state) and attach textures
        // in case of GeneralFramebuffer
        match *framebuffer {
            FramebufferRenderTarget::Default => self.bind_default_framebuffer(),
            FramebufferRenderTarget::General(framebuffer, attachments) => {
                self.bind_framebuffer(framebuffer);
                framebuffer
                    .attach_textures(attachments)
                    .chain_err(|| "Could not attach textures")?;
            }
        }

        // Make needed textures resident
        let res_textures: Vec<ResidentTexture> = textures
            .iter()
            .map(|t| t.make_resident_texture())
            .collect::<_>();

        // Clear the requested buffers
        unsafe {
            if clear_buffers != ClearBuffers::None {
                clear(clear_buffers);
            }
        }

        // Bind the pipeline
        pipeline.bind();

        // Bind buffers
        // TODO refactor into 4 bind buffers
        for buffer_target in buffers {
            unsafe {
                bind_buffer_base(
                    buffer_target.target,
                    buffer_target.index,
                    buffer_target.buffer.get_id(),
                ).chain_err(
                    || format!("Unable to bind buffer {:?}", buffer_target),
                )?;
            }
        }

        // Bind draw command buffer
        // Draw
        unsafe {
            draw_arrays(first, count).chain_err(|| "Could not draw")?;
        }

        Ok(())
    }

    pub fn dispatch_compute(
        &mut self,
        buffers: &[BufferObjectTargetLocation],
        textures: &[&Texture],
        program: &ComputeProgram,
        command: DispatchCommand,
    ) -> Result<()> {
        let res_textures: Vec<ResidentTexture> = textures
            .iter()
            .map(|t| t.make_resident_texture())
            .collect::<_>();

        program.bind().chain_err(|| "Unable to bind program")?;

        for buffer_target in buffers {
            unsafe {
                bind_buffer_base(
                    buffer_target.target,
                    buffer_target.index,
                    buffer_target.buffer.get_id(),
                ).chain_err(|| "Unable to bind buffer")?;
            }
        }

        unsafe {
            dispatch_compute(
                command.num_groups_x,
                command.num_groups_y,
                command.num_groups_z,
            ).chain_err(|| "Error during command dispatch")?;
        }

        Ok(())
    }

    pub fn dispatch_compute_indirect<T: Buffer>(
        &mut self,
        buffers: &[BufferObjectTargetLocation],
        textures: &[&Texture],
        program: &ComputeProgram,
        command_buffer: &T,
        command_offset: usize,
    ) -> Result<()> {
        let res_textures: Vec<ResidentTexture> = textures
            .iter()
            .map(|t| t.make_resident_texture())
            .collect::<_>();

        program.bind().chain_err(|| "Unable to bind program")?;

        for buffer_target in buffers {
            unsafe {
                bind_buffer_base(
                    buffer_target.target,
                    buffer_target.index,
                    buffer_target.buffer.get_id(),
                ).chain_err(|| "Unable to bind buffer")?;
            }
        }

        unsafe {
            bind_buffer(
                BindBufferTarget::DispatchIndirectBuffer,
                command_buffer.get_id(),
            ).chain_err(|| "Could not bind dispatch indirect buffer")?;
            dispatch_compute_indirect(command_offset).chain_err(
                || "Error during command dispatch",
            )?;
        }

        Ok(())
    }

    pub fn default_framebuffer(&self) -> &DefaultFramebuffer {
        &self.default_framebuffer
    }

    pub fn mut_default_framebuffer(&mut self) -> &mut DefaultFramebuffer {
        &mut self.default_framebuffer
    }

    pub fn make_current(&mut self) -> Result<()> {
        unsafe {
            self.context
                .make_current()
                .chain_err(|| "Unable to make Renderer context current")?;
        }

        Ok(())
    }

    pub fn swap_buffers(&mut self) -> Result<()> {
        self.context
            .swap_buffers()
            .chain_err(|| "Unable to swap buffers")?;

        Ok(())
    }
}


impl<'a, C: glutin::GlContext> Drop for Renderer<'a, C> {
    fn drop(&mut self) {
        unsafe {
            delete_vertex_array(self.vertex_array_object);
        }
    }
}