summaryrefslogtreecommitdiffstats
path: root/wgpu/src/buffers.rs
diff options
context:
space:
mode:
authorLibravatar shan <shankern@protonmail.com>2022-10-06 07:28:05 -0700
committerLibravatar shan <shankern@protonmail.com>2022-10-06 07:28:05 -0700
commitcb7c4676543cd508dfae8d4dcbd9cc8b61b1a94e (patch)
treed72191140c2a7a4919a0787431c1c6da60a55964 /wgpu/src/buffers.rs
parent1eb8d972ba60592da7bfc27fe7ec80138e64dd7b (diff)
downloadiced-cb7c4676543cd508dfae8d4dcbd9cc8b61b1a94e.tar.gz
iced-cb7c4676543cd508dfae8d4dcbd9cc8b61b1a94e.tar.bz2
iced-cb7c4676543cd508dfae8d4dcbd9cc8b61b1a94e.zip
Fixed lint issues & cleaned up some documentation.
Diffstat (limited to 'wgpu/src/buffers.rs')
-rw-r--r--wgpu/src/buffers.rs11
1 files changed, 4 insertions, 7 deletions
diff --git a/wgpu/src/buffers.rs b/wgpu/src/buffers.rs
index bf7bb49e..7a15692b 100644
--- a/wgpu/src/buffers.rs
+++ b/wgpu/src/buffers.rs
@@ -9,7 +9,7 @@ use std::mem;
const DEFAULT_STATIC_BUFFER_COUNT: wgpu::BufferAddress = 128;
/// A generic buffer struct useful for items which have no alignment requirements
-/// (e.g. Vertex, Index buffers) and are set once and never changed until destroyed.
+/// (e.g. Vertex, Index buffers) & no dynamic offsets.
#[derive(Debug)]
pub(crate) struct StaticBuffer<T> {
//stored sequentially per mesh iteration; refers to the offset index in the GPU buffer
@@ -17,7 +17,6 @@ pub(crate) struct StaticBuffer<T> {
label: &'static str,
usages: wgpu::BufferUsages,
gpu: wgpu::Buffer,
- //the static size of the buffer
size: wgpu::BufferAddress,
_data: PhantomData<T>,
}
@@ -75,11 +74,9 @@ impl<T: Pod + Zeroable> StaticBuffer<T> {
}
}
- /// Writes the current vertex data to the gpu buffer if it is currently writable with a memcpy &
- /// stores its offset.
+ /// Writes the current vertex data to the gpu buffer with a memcpy & stores its offset.
///
- /// This will return either the offset of the written bytes, or `None` if the GPU buffer is not
- /// currently writable.
+ /// Returns the size of the written bytes.
pub fn write(
&mut self,
device: &wgpu::Device,
@@ -125,4 +122,4 @@ impl<T: Pod + Zeroable> StaticBuffer<T> {
pub fn clear(&mut self) {
self.offsets.clear()
}
-} \ No newline at end of file
+}