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
use std::sync::Arc;
use ash::vk;
use crate::{Device, Error};
pub use vk::CommandBufferLevel as CommandBufferLevel;
pub use vk::CommandBufferUsageFlags as CommandBufferUsageFlags;
/// Holds a [`vk::CommandPool`], used to allocate [`CommandBuffers`](CommandBuffer).
pub struct CommandPool {
device: Arc<Device>,
cmd_pool: vk::CommandPool,
}
impl std::ops::Deref for CommandPool {
type Target = vk::CommandPool;
fn deref(&self) -> &Self::Target {
&self.cmd_pool
}
}
impl Drop for CommandPool {
fn drop(&mut self) {
unsafe {
self.device.destroy_command_pool(self.cmd_pool, None);
}
}
}
impl CommandPool {
/// Creates a CommandPool.
///
/// # Examples
///
/// ```no_run
/// # let event_loop = winit::event_loop::EventLoop::new();
/// # let window = winit::window::WindowBuilder::new().build(&event_loop)?;
/// # let device = plate::Device::new(&Default::default(), &Default::default(), Some(&window))?;
/// let cmd_pool = plate::CommandPool::new(&device)?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn new(device: &Arc<Device>) -> Result<Self, Error> {
let pool_info = vk::CommandPoolCreateInfo::builder()
.flags(vk::CommandPoolCreateFlags::RESET_COMMAND_BUFFER)
.queue_family_index(device.queue.family);
let cmd_pool = unsafe { device.create_command_pool(&pool_info, None)? };
Ok(Self {
device: Arc::clone(&device),
cmd_pool,
})
}
/// Allocates CommandBuffers.
///
/// # Examples
///
/// ```no_run
/// # let event_loop = winit::event_loop::EventLoop::new();
/// # let window = winit::window::WindowBuilder::new().build(&event_loop)?;
/// # let device = plate::Device::new(&Default::default(), &Default::default(), Some(&window))?;
/// # let cmd_pool = plate::CommandPool::new(&device)?;
/// let cmd_buffers = cmd_pool.alloc_cmd_buffers(plate::CommandBufferLevel::PRIMARY, 2)?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn alloc_cmd_buffers(&self, level: CommandBufferLevel, cmd_buffer_count: u32) -> Result<Vec<CommandBuffer>, Error> {
let alloc_info = vk::CommandBufferAllocateInfo::builder()
.command_pool(self.cmd_pool)
.level(level)
.command_buffer_count(cmd_buffer_count);
let cmd_buffers = unsafe { self.device.allocate_command_buffers(&alloc_info)? };
Ok(cmd_buffers.into_iter()
.map(|cmd_buffer| CommandBuffer { device: Arc::clone(&self.device), cmd_buffer })
.collect())
}
/// Allocates a single CommandBuffer.
///
/// # Examples
///
/// ```no_run
/// # let event_loop = winit::event_loop::EventLoop::new();
/// # let window = winit::window::WindowBuilder::new().build(&event_loop)?;
/// # let device = plate::Device::new(&Default::default(), &Default::default(), Some(&window))?;
/// # let cmd_pool = plate::CommandPool::new(&device)?;
/// let cmd_buffer = cmd_pool.alloc_cmd_buffer(plate::CommandBufferLevel::PRIMARY)?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn alloc_cmd_buffer(&self, level: CommandBufferLevel) -> Result<CommandBuffer, Error> {
Ok(self.alloc_cmd_buffers(level, 1)?.swap_remove(0))
}
}
/// Used to send instructions to the GPU.
pub struct CommandBuffer {
device: Arc<Device>,
cmd_buffer: vk::CommandBuffer,
}
impl std::ops::Deref for CommandBuffer {
type Target = vk::CommandBuffer;
fn deref(&self) -> &Self::Target {
&self.cmd_buffer
}
}
impl CommandBuffer {
/// Records instructions in the given closure to this command buffer.
///
/// Runs [`begin()`](Self::begin()), the closure then [`end()`](Self::end()).
///
/// # Examples
///
/// ```no_run
/// # let event_loop = winit::event_loop::EventLoop::new();
/// # let window = winit::window::WindowBuilder::new().build(&event_loop)?;
/// # let device = plate::Device::new(&Default::default(), &Default::default(), Some(&window))?;
/// # let cmd_pool = plate::CommandPool::new(&device)?;
/// # let cmd_buffer = cmd_pool.alloc_cmd_buffer(plate::CommandBufferLevel::PRIMARY)?;
/// cmd_buffer.record(plate::CommandBufferUsageFlags::empty(), || {
/// // cmd_buffer.draw(..);
/// })?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn record<F: FnOnce()>(&self, flags: CommandBufferUsageFlags, f: F) -> Result<(), Error> {
self.begin(flags)?;
f();
self.end()?;
Ok(())
}
/// Begin recording instructions to this command buffer.
///
/// # Examples
///
/// ```no_run
/// # let event_loop = winit::event_loop::EventLoop::new();
/// # let window = winit::window::WindowBuilder::new().build(&event_loop)?;
/// # let device = plate::Device::new(&Default::default(), &Default::default(), Some(&window))?;
/// # let cmd_pool = plate::CommandPool::new(&device)?;
/// # let cmd_buffer = cmd_pool.alloc_cmd_buffer(plate::CommandBufferLevel::PRIMARY)?;
/// cmd_buffer.begin(plate::CommandBufferUsageFlags::empty())?;
/// // cmd_buffer.draw(..);
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn begin(&self, flags: CommandBufferUsageFlags) -> Result<(), Error> {
let info = vk::CommandBufferBeginInfo::builder().flags(flags);
unsafe {
self.device.reset_command_buffer(self.cmd_buffer, vk::CommandBufferResetFlags::empty())?;
self.device.begin_command_buffer(self.cmd_buffer, &info)?;
}
Ok(())
}
/// Stop recording instructions to this command buffer.
///
/// # Examples
///
/// ```no_run
/// # let event_loop = winit::event_loop::EventLoop::new();
/// # let window = winit::window::WindowBuilder::new().build(&event_loop)?;
/// # let device = plate::Device::new(&Default::default(), &Default::default(), Some(&window))?;
/// # let cmd_pool = plate::CommandPool::new(&device)?;
/// # let cmd_buffer = cmd_pool.alloc_cmd_buffer(plate::CommandBufferLevel::PRIMARY)?;
/// // cmd_buffer.draw(..);
/// cmd_buffer.end()?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn end(&self) -> Result<(), Error> {
unsafe { self.device.end_command_buffer(self.cmd_buffer)? };
Ok(())
}
/// Calls a [`draw`](ash::Device::cmd_draw()) command.
///
/// To be used when recording a CommandBuffer.
///
/// # Examples
///
/// ```no_run
/// # let event_loop = winit::event_loop::EventLoop::new();
/// # let window = winit::window::WindowBuilder::new().build(&event_loop)?;
/// # let device = plate::Device::new(&Default::default(), &Default::default(), Some(&window))?;
/// # let cmd_pool = plate::CommandPool::new(&device)?;
/// # let cmd_buffer = cmd_pool.alloc_cmd_buffer(plate::CommandBufferLevel::PRIMARY)?;
/// cmd_buffer.record(plate::CommandBufferUsageFlags::empty(), || {
/// cmd_buffer.draw(3, 1, 0, 0);
/// })?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn draw(&self, vert_count: u32, instance_count: u32, first_vert: u32, first_instance: u32) {
unsafe { self.device.cmd_draw(self.cmd_buffer, vert_count, instance_count, first_vert, first_instance) }
}
/// Calls a [`draw_indexed`](ash::Device::cmd_draw_indexed()) command.
///
/// To be used when recording a CommandBuffer.
///
/// # Examples
///
/// ```no_run
/// # let event_loop = winit::event_loop::EventLoop::new();
/// # let window = winit::window::WindowBuilder::new().build(&event_loop)?;
/// # let device = plate::Device::new(&Default::default(), &Default::default(), Some(&window))?;
/// # let cmd_pool = plate::CommandPool::new(&device)?;
/// # let cmd_buffer = cmd_pool.alloc_cmd_buffer(plate::CommandBufferLevel::PRIMARY)?;
/// cmd_buffer.record(plate::CommandBufferUsageFlags::empty(), || {
/// cmd_buffer.draw_indexed(3, 1, 0, 0, 0);
/// })?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn draw_indexed(&self, index_count: u32, instance_count: u32, first_index: u32, vertex_offset: i32, first_instance: u32) {
unsafe { self.device.cmd_draw_indexed(self.cmd_buffer, index_count, instance_count, first_index, vertex_offset, first_instance) }
}
}