From c89d7edff54a8ef881dbe3cd4c73dced9f86d597 Mon Sep 17 00:00:00 2001 From: Aaron Loucks Date: Sun, 15 Mar 2020 15:37:10 -0400 Subject: [PATCH] [rs] Add note that `slot` refers to the index in RenderPipelineDescriptor::vertex_buffers Also fixed intra-doc links for `set_vertex_buffer`. --- wgpu/src/lib.rs | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/wgpu/src/lib.rs b/wgpu/src/lib.rs index 4a36783a47..7777e93582 100644 --- a/wgpu/src/lib.rs +++ b/wgpu/src/lib.rs @@ -1243,10 +1243,18 @@ impl<'a> RenderPass<'a> { /// Assign a vertex buffer to a slot. /// - /// Subsequent calls to [`draw`](RenderPass::draw) and [`draw_indexed`](RenderPass::draw_indexed) - /// on this [`RenderPass`] will use `buffer` as one of the source vertex buffers. + /// Subsequent calls to [`draw`] and [`draw_indexed`] on this + /// [`RenderPass`] will use `buffer` as one of the source vertex buffers. + /// + /// The `slot` refers to the index of the matching descriptor in + /// [`RenderPipelineDescriptor::vertex_buffers`]. /// /// If `size == 0`, the remaining part of the buffer is considered. + /// + /// [`draw`]: #method.draw + /// [`draw_indexed`]: #method.draw_indexed + /// [`RenderPass`]: struct.RenderPass.html + /// [`RenderPipelineDescriptor::vertex_buffers`]: struct.RenderPipelineDescriptor.html#structfield.vertex_buffers pub fn set_vertex_buffer( &mut self, slot: u32,