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
use {
    super::Frame,
    crate::graphics::{
        vulkan_api::{raii, FramesInFlight, RenderDevice, Texture2D},
        GraphicsError,
    },
    ash::vk,
    std::sync::Arc,
};

mod pipeline;

#[derive(Debug, Copy, Clone, PartialEq, Default)]
#[repr(C)]
pub struct BindlessVertex {
    pub pos: [f32; 4],
    pub uv: [f32; 3],
    pub pad: [f32; 1],
    pub color: [f32; 4],
}

/// A utility for rendering high-performance textured triangles using bindless
/// textures.
pub struct BindlessTriangles {
    textures: Vec<Arc<Texture2D>>,

    vertex_count: u32,
    vertex_buffers: Vec<raii::Buffer>,
    vertex_buffer_ptrs: Vec<*mut BindlessVertex>,

    sampler: raii::Sampler,
    descriptor_pool: raii::DescriptorPool,
    _descriptor_set_layout: raii::DescriptorSetLayout,

    pipeline_layout: raii::PipelineLayout,
    pipeline: raii::Pipeline,
    render_device: Arc<RenderDevice>,
}

impl BindlessTriangles {
    /// Create a new instance of bindless triangles.
    ///
    /// # Safety
    ///
    /// Unsafe because:
    ///   - This instance must be dropped before the RenderDevice is destroyed.
    pub unsafe fn new(
        render_device: Arc<RenderDevice>,
        render_pass: &raii::RenderPass,
        frames_in_flight: &FramesInFlight,
        textures: &[Arc<Texture2D>],
    ) -> Result<Self, GraphicsError> {
        let (descriptor_set_layout, pipeline_layout) =
            pipeline::create_layouts(
                render_device.clone(),
                textures.len() as u32,
            )?;

        let pipeline = pipeline::create_pipeline(
            render_device.clone(),
            include_bytes!("./shaders/bindless.vert.spv"),
            include_bytes!("./shaders/bindless.frag.spv"),
            &pipeline_layout,
            render_pass,
        )?;

        let descriptor_count = frames_in_flight.frame_count() as u32;
        let mut descriptor_pool = raii::DescriptorPool::new_with_sizes(
            render_device.clone(),
            descriptor_count,
            &[
                vk::DescriptorPoolSize {
                    ty: vk::DescriptorType::STORAGE_BUFFER,
                    descriptor_count,
                },
                vk::DescriptorPoolSize {
                    ty: vk::DescriptorType::COMBINED_IMAGE_SAMPLER,
                    descriptor_count,
                },
            ],
        )?;
        let layouts = (0..descriptor_count)
            .map(|_| &descriptor_set_layout)
            .collect::<Vec<&raii::DescriptorSetLayout>>();
        let _ = descriptor_pool.allocate_descriptor_sets(&layouts)?;

        let sampler = raii::Sampler::new(
            render_device.clone(),
            &vk::SamplerCreateInfo {
                mipmap_mode: vk::SamplerMipmapMode::LINEAR,
                mag_filter: vk::Filter::LINEAR,
                min_filter: vk::Filter::LINEAR,
                ..Default::default()
            },
        )?;

        let vertex_buffer_count = frames_in_flight.frame_count();
        let mut vertex_buffers = Vec::with_capacity(vertex_buffer_count);
        let mut vertex_buffer_ptrs = Vec::with_capacity(vertex_buffer_count);
        for _ in 0..vertex_buffer_count {
            let (buffer, ptr) =
                Self::allocate_vertex_buffer(&render_device, 1000)?;
            vertex_buffer_ptrs.push(ptr);
            vertex_buffers.push(buffer);
        }

        for (index, vertex_buffer) in vertex_buffers.iter().enumerate() {
            Self::write_descriptor_set(
                &render_device,
                &descriptor_pool,
                index,
                vertex_buffer,
                textures,
                &sampler,
            );
        }

        Ok(Self {
            textures: textures.to_owned(),
            vertex_count: 0,
            vertex_buffers,
            vertex_buffer_ptrs,
            sampler,
            descriptor_pool,
            _descriptor_set_layout: descriptor_set_layout,
            pipeline_layout,
            pipeline,
            render_device,
        })
    }

    pub fn write_vertices_for_frame(
        &mut self,
        frame: &Frame,
        vertices: &[BindlessVertex],
    ) -> Result<(), GraphicsError> {
        if self.vertex_buffers[frame.frame_index()]
            .allocation()
            .size_in_bytes()
            < std::mem::size_of_val(vertices) as u64
        {
            unsafe {
                self.reallocate_vertex_buffer(frame, vertices.len() as u64)?;
                Self::write_descriptor_set(
                    &self.render_device,
                    &self.descriptor_pool,
                    frame.frame_index(),
                    &self.vertex_buffers[frame.frame_index()],
                    &self.textures,
                    &self.sampler,
                );
            };
        }

        let buffer_data = unsafe {
            std::slice::from_raw_parts_mut(
                self.vertex_buffer_ptrs[frame.frame_index()],
                vertices.len(),
            )
        };
        buffer_data.copy_from_slice(vertices);

        self.vertex_count = vertices.len() as u32;

        Ok(())
    }

    /// Add commands to the frame's command buffer to draw the vertices.
    ///
    /// # Safety
    ///
    /// Unsafe because:
    ///   - The render pass must already be started.
    pub unsafe fn draw_vertices(
        &self,
        frame: &Frame,
        viewport: vk::Extent2D,
    ) -> Result<(), GraphicsError> {
        self.render_device.device().cmd_bind_pipeline(
            frame.command_buffer(),
            vk::PipelineBindPoint::GRAPHICS,
            self.pipeline.raw(),
        );

        let vk::Extent2D { width, height } = viewport;
        self.render_device.device().cmd_set_viewport(
            frame.command_buffer(),
            0,
            &[vk::Viewport {
                x: 0.0,
                y: 0.0,
                width: width as f32,
                height: height as f32,
                min_depth: 0.0,
                max_depth: 1.0,
            }],
        );
        self.render_device.device().cmd_set_scissor(
            frame.command_buffer(),
            0,
            &[vk::Rect2D {
                offset: vk::Offset2D { x: 0, y: 0 },
                extent: vk::Extent2D { width, height },
            }],
        );
        self.render_device.device().cmd_bind_descriptor_sets(
            frame.command_buffer(),
            vk::PipelineBindPoint::GRAPHICS,
            self.pipeline_layout.raw(),
            0,
            &[self.descriptor_pool.descriptor_set(frame.frame_index())],
            &[],
        );
        self.render_device.device().cmd_draw(
            frame.command_buffer(),
            self.vertex_count,
            1,
            0,
            0,
        );

        Ok(())
    }
}

impl BindlessTriangles {
    /// Reallocate's the current frame's vertex buffer to have capacity for the
    /// requested vertex count.
    ///
    /// # Safety
    ///
    /// Unsafe because:
    ///   - A graphics error can render the BindlessTriangles entirely unusable.
    unsafe fn reallocate_vertex_buffer(
        &mut self,
        frame: &Frame,
        vertex_count: u64,
    ) -> Result<(), GraphicsError> {
        let index = frame.frame_index();

        self.vertex_buffers[index]
            .allocation()
            .unmap(self.render_device.device())?;
        self.vertex_buffer_ptrs[index] = std::ptr::null_mut();

        let (buffer, ptr) =
            Self::allocate_vertex_buffer(&self.render_device, vertex_count)?;
        self.vertex_buffers[index] = buffer;
        self.vertex_buffer_ptrs[index] = ptr;

        Ok(())
    }

    /// Allocate a vertex buffer.
    ///
    /// # Safety
    ///
    /// Unsafe because:
    ///   - The application must not use the associated memory-mapped pointer
    ///     once the buffer has been dropped.
    unsafe fn allocate_vertex_buffer(
        render_device: &Arc<RenderDevice>,
        vertex_count: u64,
    ) -> Result<(raii::Buffer, *mut BindlessVertex), GraphicsError> {
        let queue_family_index = render_device.graphics_queue().family_index();
        let create_info = vk::BufferCreateInfo {
            size: std::mem::size_of::<BindlessVertex>() as u64 * vertex_count,
            usage: vk::BufferUsageFlags::STORAGE_BUFFER,
            queue_family_index_count: 1,
            p_queue_family_indices: &queue_family_index,
            sharing_mode: vk::SharingMode::EXCLUSIVE,
            ..Default::default()
        };
        let buffer = raii::Buffer::new(
            render_device.clone(),
            &create_info,
            vk::MemoryPropertyFlags::HOST_VISIBLE
                | vk::MemoryPropertyFlags::HOST_COHERENT,
        )?;
        let ptr = buffer.allocation().map(render_device.device())?;
        debug_assert!(
            ptr as usize % std::mem::align_of::<BindlessVertex>() == 0,
            "CPU Ptr must be align for Vertex data!"
        );

        Ok((buffer, ptr as *mut BindlessVertex))
    }

    /// Write the descriptor set for frame index.
    ///
    /// # Safety
    ///
    /// Unsafe because:
    ///   - the descriptor set must not be in use by the GPU when it is written.
    unsafe fn write_descriptor_set(
        render_device: &RenderDevice,
        descriptor_pool: &raii::DescriptorPool,
        index: usize,
        vertex_buffer: &raii::Buffer,
        textures: &[Arc<Texture2D>],
        sampler: &raii::Sampler,
    ) {
        let buffer_info = vk::DescriptorBufferInfo {
            buffer: vertex_buffer.raw(),
            offset: 0,
            range: vertex_buffer.allocation().size_in_bytes(),
        };
        let image_infos = textures
            .iter()
            .map(|texture| vk::DescriptorImageInfo {
                sampler: sampler.raw(),
                image_view: texture.image_view.raw(),
                image_layout: vk::ImageLayout::SHADER_READ_ONLY_OPTIMAL,
            })
            .collect::<Vec<vk::DescriptorImageInfo>>();
        render_device.device().update_descriptor_sets(
            &[
                vk::WriteDescriptorSet {
                    dst_set: descriptor_pool.descriptor_set(index),
                    dst_binding: 0,
                    dst_array_element: 0,
                    descriptor_type: vk::DescriptorType::STORAGE_BUFFER,
                    descriptor_count: 1,
                    p_buffer_info: &buffer_info,
                    ..vk::WriteDescriptorSet::default()
                },
                vk::WriteDescriptorSet {
                    dst_set: descriptor_pool.descriptor_set(index),
                    dst_binding: 1,
                    dst_array_element: 0,
                    descriptor_type: vk::DescriptorType::COMBINED_IMAGE_SAMPLER,
                    descriptor_count: image_infos.len() as u32,
                    p_image_info: image_infos.as_ptr(),
                    ..vk::WriteDescriptorSet::default()
                },
            ],
            &[],
        );
    }
}