Add additional docs for command_encoder_as_hal_mut

gfx-rs · Mar 30, 2024 · 2daa2a6 · 2daa2a6
1 parent 6827ab2
commit 2daa2a6
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/wgpu/src/backend/wgpu_core.rs b/wgpu/src/backend/wgpu_core.rs
@@ -240,6 +240,7 @@ impl ContextWgpuCore {
         }
     }
 
+    /// This method will start the wgpu_core level command recording.
     pub unsafe fn command_encoder_as_hal_mut<
         A: wgc::hal_api::HalApi,
         F: FnOnce(Option<&mut A::CommandEncoder>) -> R,

diff --git a/wgpu/src/lib.rs b/wgpu/src/lib.rs
@@ -3474,6 +3474,8 @@ impl CommandEncoder {
     /// Returns the inner hal CommandEncoder using a callback. The hal command encoder will be `None` if the
     /// backend type argument does not match with this wgpu CommandEncoder
     ///
+    /// This method will start the wgpu_core level command recording.
+    ///
     /// # Safety
     ///
     /// - The raw handle obtained from the hal CommandEncoder must not be manually destroyed