mew/
buffer.rs

1/// Define a storage buffer, with an optional internal type/struct to align its
2/// length with.
3///
4/// For example, if the buffer stores an array of `f32` matrices, you could set
5/// the internal type to `[f32; 16]`, and the buffer descriptor will initialize
6/// a multiple of the internal type's size.  
7/// If omitted, the internal type will default to `u8`, so you can initialize
8/// the buffer using a number of bytes manually.
9///
10/// You also need to specify the
11/// [`wgpu::BufferUsages`](https://docs.rs/wgpu/latest/wgpu/struct.BufferUsages.html),
12/// but note that it requires either `STORAGE` or `UNIFORM` as the *first* usage.
13///
14/// ```
15/// buffer! { MatrixBuffer <SomeMatrixStructYouDefinedBefore> as UNIFORM | COPY_DST }
16///
17/// let buffer: MatrixBuffer = render_context.new_buffer(1);
18///
19/// queue.write_buffer(&buffer, 0, &[1, 2, 3, ..]);
20/// ```
21#[macro_export]
22macro_rules! buffer {
23    { @buffertype STORAGE } => {
24        $crate::wgpu::BufferBindingType::Storage { read_only: true, }
25    };
26    { @buffertype UNIFORM } => {
27        $crate::wgpu::BufferBindingType::Uniform
28    };
29
30    { $struct:ident as $( $usage:ident )|+ } => {
31        $crate::buffer! { $struct <u8> as $( $usage )|+ }
32    };
33    { $struct:ident < $inner:ty > as $storageuniform:ident $( | $usage:ident )* } => {
34        #[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
35        pub struct $struct {
36            buffer: $crate::wgpu::Buffer,
37        }
38
39        impl ::std::ops::Deref for $struct {
40            type Target = $crate::wgpu::Buffer;
41            fn deref(&self) -> &Self::Target {
42                &self.buffer
43            }
44        }
45
46        impl $crate::buffer::MewBuffer for $struct {
47            type Inner = $inner;
48
49            fn new(buffer: $crate::wgpu::Buffer) -> Self {
50                Self {
51                    buffer,
52                }
53            }
54
55            fn binding_type() -> $crate::wgpu::BindingType {
56                $crate::wgpu::BindingType::Buffer {
57                    ty: $crate::buffer! { @buffertype $storageuniform },
58                    has_dynamic_offset: false,
59                    min_binding_size: None,
60                }
61            }
62
63            fn buffer_desc(inner_size: u64) -> $crate::wgpu::BufferDescriptor<'static> {
64                $crate::wgpu::BufferDescriptor {
65                    label: Some(concat!(stringify!($struct), "<", stringify!($inner), "> Buffer")),
66                    size: inner_size * ::std::mem::size_of::<Self::Inner>() as u64,
67                    usage: $crate::wgpu::BufferUsages::$storageuniform $( | $crate::wgpu::BufferUsages::$usage )*,
68                    mapped_at_creation: false,
69                }
70            }
71
72            fn as_binding<'a>(&'a self) -> $crate::wgpu::BindingResource<'a> {
73                self.buffer.as_entire_binding()
74            }
75        }
76    }
77}
78pub use buffer;
79
80
81/// Trait for buffer wrapper types, to get layouts and descriptors about the
82/// inner buffer.
83pub trait MewBuffer {
84    type Inner;
85
86    /// Wrap a buffer in this struct.
87    fn new(buffer: wgpu::Buffer) -> Self;
88    /// Get the binding type info.
89    fn binding_type() -> wgpu::BindingType;
90    /// Get a buffer descriptor big enough to fit some number of [`Self::Inner`]s.
91    fn buffer_desc(inner_size: u64) -> wgpu::BufferDescriptor<'static>;
92    /// Get the bindable resource of the buffer.
93    fn as_binding<'a>(&'a self) -> wgpu::BindingResource<'a>;
94}
mew/buffer.rs

mew/
buffer.rs
