Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
botahamec committed Jan 12, 2023
1 parent 5ad0751 commit cc0530e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions wgpu/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2275,6 +2275,9 @@ pub struct BufferView<'a> {
}

/// Write only view into mapped buffer.
///
/// It is possible to read the buffer using this view, but doing so is not
/// recommended, as it is likely to be slow.
#[derive(Debug)]
pub struct BufferViewMut<'a> {
slice: BufferSlice<'a>,
Expand Down Expand Up @@ -3746,10 +3749,7 @@ impl Queue {
/// Schedule a data write into `buffer` starting at `offset` via the returned
/// [`QueueWriteBufferView`].
///
/// The returned value can be converted into a `&mut [u8]` with the `as_mut` method.
/// However, `as_ref` is not implemented for [`QueueWriteBufferView`].
/// (It is not unsound to read through the `&mut [u8]` anyway, but doing so will not
/// yield the existing contents of `buffer` from the GPU, and it is likely to be slow.)
/// Reading from this buffer is slow and will not yield the actual contents of the buffer.
///
/// This method is intended to have low performance costs.
/// As such, the write is not immediately submitted, and instead enqueued
Expand Down

0 comments on commit cc0530e

Please sign in to comment.