From 2daa2a6e40536b6f1b41bb63cca786393ca8a665 Mon Sep 17 00:00:00 2001 From: JMS55 <47158642+JMS55@users.noreply.github.com> Date: Sat, 30 Mar 2024 11:13:59 -0400 Subject: [PATCH] Add additional docs for command_encoder_as_hal_mut --- wgpu/src/backend/wgpu_core.rs | 1 + wgpu/src/lib.rs | 2 ++ 2 files changed, 3 insertions(+) diff --git a/wgpu/src/backend/wgpu_core.rs b/wgpu/src/backend/wgpu_core.rs index f7de13bff5..98f1ca1de6 100644 --- 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 index 7dac0ee8fc..ecf5f88d88 100644 --- 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