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
use std::borrow::Borrow; use std::mem::MaybeUninit; use web_glitz::buffer::{Buffer, BufferView, UsageHint}; use web_glitz::runtime::RenderingContext; use crate::util::new_capacity_amortized; /// A growable GPU buffer for data that may be used to store GPU accessiable data that may be used /// in WebGlitz tasks. /// /// Elements must implement [Copy]. /// /// # Example /// ``` /// # #![feature(const_fn, const_maybe_uninit_as_ptr, const_ptr_offset_from, const_raw_ptr_deref, ptr_offset_from)] /// # use web_glitz::rendering::DefaultRGBBuffer; /// # use web_glitz::rendering::DefaultRenderTarget; /// # use web_glitz::buffer::BufferView; /// # use web_glitz::pipeline::graphics::GraphicsPipeline; /// # use web_glitz::runtime::RenderingContext; /// use web_glitz_buffer_vec::BufferVec; /// use web_glitz::buffer::UsageHint; /// /// #[derive(web_glitz::derive::Vertex, Clone, Copy)] /// struct Vertex { /// #[vertex_attribute(location = 0, format = "Float2_f32")] /// position: [f32; 2], /// } /// /// # fn wrapper<Rc>( /// # context: Rc, /// # mut render_target: DefaultRenderTarget<DefaultRGBBuffer, ()>, /// # graphics_pipeline: GraphicsPipeline<Vertex, (), ()> /// # ) /// # where /// # Rc: RenderingContext, /// # { /// # let resources = (); /// let mut vertices = BufferVec::new(context, UsageHint::StaticDraw); /// /// vertices.update([ /// Vertex { position: [-0.5, -0.5] }, /// Vertex { position: [0.5, -0.5] }, /// Vertex { position: [0.0, 0.5] }, /// ]); /// /// let vertices_view = vertices.as_buffer_view(); /// /// assert_eq!(vertices_view.len(), 3); /// /// let render_pass = render_target.create_render_pass(|framebuffer| { /// framebuffer.pipeline_task(&graphics_pipeline, |active_pipeline| { /// active_pipeline.task_builder() /// .bind_vertex_buffers(vertices_view) /// .bind_resources(resources) /// .draw(3, 1) /// .finish() /// }) /// }); /// # } /// ``` /// /// Here `context` is a WebGlitz [RenderingContext]. For details on rendering with WebGlitz, see the /// [web_glitz::rendering] module documentation. /// /// [RenderingContext]: web_glitz::runtime::RenderingContext pub struct BufferVec<Rc, T> { context: Rc, len: usize, buffer: Buffer<[MaybeUninit<T>]>, } impl<Rc, T> BufferVec<Rc, T> where Rc: RenderingContext, T: Copy + 'static, { /// Creates a new buffer-backed vector with 0 capacity for the given [RenderingContext]. /// /// See [UsageHint] for details on GPU buffer performance hints. /// /// # Example /// /// ``` /// # use web_glitz::runtime::RenderingContext; /// # fn wrapper<Rc>(context: Rc) where Rc: RenderingContext { /// use web_glitz_buffer_vec::BufferVec; /// use web_glitz::buffer::UsageHint; /// /// let mut vec = BufferVec::new(context, UsageHint::StaticDraw); /// /// assert_eq!(vec.capacity(), 0); /// # vec.update([1, 2, 3]); /// # } /// ``` /// /// Here context is a [RenderingContext]. /// /// [RenderingContext]: web_glitz::runtime::RenderingContext /// [UsageHint]: web_glitz::buffer::UsageHint pub fn new(context: Rc, usage: UsageHint) -> Self { let buffer = context.create_buffer_slice_uninit(0, usage); BufferVec { context, len: 0, buffer, } } /// Creates a new buffer-backed vector with the specified `capacity` for the given /// [RenderingContext]. /// /// See [UsageHint] for details on GPU buffer performance hints. /// /// # Example /// /// ``` /// # use web_glitz::runtime::RenderingContext; /// # fn wrapper<Rc>(context: Rc) where Rc: RenderingContext { /// use web_glitz_buffer_vec::BufferVec; /// use web_glitz::buffer::UsageHint; /// /// let mut vec = BufferVec::with_capacity(context, UsageHint::StaticDraw, 10); /// /// assert_eq!(vec.capacity(), 10); /// # vec.update([1, 2, 3]); /// # } /// ``` /// /// Here context is a [RenderingContext]. /// /// [RenderingContext]: web_glitz::runtime::RenderingContext /// [UsageHint]: web_glitz::buffer::UsageHint pub fn with_capacity(context: Rc, usage: UsageHint, capacity: usize) -> Self { let buffer = context.create_buffer_slice_uninit(capacity, usage); BufferVec { context, len: 0, buffer, } } /// Replaces the data in the buffer with the given `data`, resizing the buffer if necessary. /// /// Returns `true` if a new buffer was allocated, `false` otherwise. /// /// # Guarantees /// /// Any task submitted from the same thread that called `update` after the update will see the /// new data. Any task that does not fence submitted from the same thread that called `update` /// before the update will see the old data. No other guarantees are given. /// /// # Example /// /// ``` /// # use web_glitz::runtime::RenderingContext; /// # fn wrapper<Rc>(context: Rc) where Rc: RenderingContext { /// use web_glitz_buffer_vec::BufferVec; /// use web_glitz::buffer::UsageHint; /// /// let mut vec = BufferVec::new(context, UsageHint::StaticDraw); /// /// vec.update([1, 2, 3]); /// # } /// ``` /// /// Here `context` is a WebGlitz [RenderingContext]. /// /// [RenderingContext]: web_glitz::runtime::RenderingContext pub fn update<D>(&mut self, data: D) -> bool where D: Borrow<[T]> + Send + Sync + 'static, { let BufferVec { context, len, buffer, } = self; *len = data.borrow().len(); let current_capacity = buffer.len(); let reallocated = if let Some(new_capacity) = new_capacity_amortized(current_capacity, *len) { *buffer = context .create_buffer_slice_uninit(new_capacity, buffer.usage_hint()) .into(); true } else { false }; let view = buffer.get(0..*len).unwrap(); let upload_task = unsafe { // Note: the view data range is not actually guaranteed to be initialized, but we're // only writing, not reading. view.assume_init().upload_command(data) }; context.submit(upload_task); reallocated } /// The number of elements this vector can hold without allocating a new buffer. pub fn capacity(&self) -> usize { self.buffer.len() } /// Returns a view on the data in the buffer. /// /// # Example /// /// ``` /// # use web_glitz::runtime::RenderingContext; /// # fn wrapper<Rc>(context: Rc) where Rc: RenderingContext { /// use web_glitz_buffer_vec::BufferVec; /// use web_glitz::buffer::UsageHint; /// /// let mut vec = BufferVec::new(context, UsageHint::StaticDraw); /// /// vec.update([1, 2, 3]); /// /// let view = vec.as_buffer_view(); /// /// assert_eq!(view.len(), 3); /// # } /// ``` /// /// Here `context` is a WebGlitz [RenderingContext]. /// /// [RenderingContext]: web_glitz::runtime::RenderingContext pub fn as_buffer_view(&self) -> BufferView<[T]> where T: Copy + 'static, { let BufferVec { len, buffer, .. } = self; unsafe { buffer.get(0..*len).unwrap().assume_init() } } }