Added fill_buffer method documentation

* Changed a trace from wgpu-core (wrong name bc of copy-paste)
gfx-rs · Nov 13, 2021 · 6dbfe63 · 6dbfe63
1 parent f6fdaca
commit 6dbfe63
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/wgpu-core/src/command/clear.rs b/wgpu-core/src/command/clear.rs
@@ -216,7 +216,7 @@ impl<G: GlobalIdentityHandlerFactory> Global<G> {
             None => dst_buffer.size,
         };
         if offset == end {
-            log::trace!("Ignoring clear_buffer of size 0");
+            log::trace!("Ignoring fill_buffer of size 0");
             return Ok(());
         }
 

diff --git a/wgpu/src/lib.rs b/wgpu/src/lib.rs
@@ -2383,6 +2383,12 @@ impl CommandEncoder {
         );
     }
 
+    /// Fills buffer with `value`.
+    ///
+    /// # Panics
+    ///
+    /// - Buffer does not have `COPY_DST` or `STORAGE` usage.
+    /// - Range it out of bounds
     pub fn fill_buffer(
         &mut self,
         buffer: &Buffer,