github/wgpu
1
1
Fork 0
mirror of https://github.com/gfx-rs/wgpu.git synced 2026-04-22 03:02:01 -04:00
Code Issues Packages Projects Releases Wiki Activity

[rs] Add note that slot refers to the index in RenderPipelineDescriptor::vertex_buffers

Browse Source 
Also fixed intra-doc links for `set_vertex_buffer`.
This commit is contained in:
Aaron Loucks
2020-03-15 15:37:10 -04:00
parent fbff46dc8f
commit c89d7edff5
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
wgpu/src/lib.rs
View File

@@ -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,