From 9073d18c70b679f51610086daa37eb10bbff4ba5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marvin=20L=C3=B6bel?= Date: Thu, 22 Oct 2020 17:14:39 +0200 Subject: [PATCH] [rs] Clarify docs for Queue::write methods --- wgpu/src/lib.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/wgpu/src/lib.rs b/wgpu/src/lib.rs index e08dff11c6..578e3a2c16 100644 --- a/wgpu/src/lib.rs +++ b/wgpu/src/lib.rs @@ -2581,11 +2581,19 @@ impl<'a> RenderBundleEncoder<'a> { impl Queue { /// Schedule a data write into `buffer` starting at `offset`. + /// + /// This method is intended to have low performance costs. + /// As such, the write is not immediately submitted, and instead enqueued + /// internally to happen at the start of the next `submit()` call. pub fn write_buffer(&self, buffer: &Buffer, offset: BufferAddress, data: &[u8]) { Context::queue_write_buffer(&*self.context, &self.id, &buffer.id, offset, data) } /// Schedule a data write into `texture`. + /// + /// This method is intended to have low performance costs. + /// As such, the write is not immediately submitted, and instead enqueued + /// internally to happen at the start of the next `submit()` call. pub fn write_texture( &self, texture: TextureCopyView,