Struct nannou::wgpu::util::StagingBelt [−][src]
pub struct StagingBelt { /* fields omitted */ }
Staging belt is a machine that uploads data.
Internally it uses a ring-buffer of staging buffers that are sub-allocated.
It has an advantage over Queue.write_buffer
in a way that it returns a mutable slice,
which you can fill to avoid an extra data copy.
Using a staging belt is slightly complicated, and generally goes as follows:
- Write to buffers that need writing to using
write_buffer
. - Call
finish
. - Submit all command encoders used with
write_buffer
. - Call
recall
Implementations
impl StagingBelt
[src]
pub fn new(chunk_size: u64) -> StagingBelt
[src]
Create a new staging belt.
The chunk_size
is the unit of internal buffer allocation.
It’s better when it’s big, but ideally still 1-4 times less than
the total amount of data uploaded per submission.
pub fn write_buffer(
&mut self,
encoder: &mut CommandEncoder,
target: &Buffer,
offset: u64,
size: NonZeroU64,
device: &Device
) -> BufferViewMut<'_>
[src]
&mut self,
encoder: &mut CommandEncoder,
target: &Buffer,
offset: u64,
size: NonZeroU64,
device: &Device
) -> BufferViewMut<'_>
Allocate the staging belt slice of size
to be uploaded into the target
buffer
at the specified offset.
The upload will be placed into the provided command encoder. This encoder
must be submitted after finish
is called and before recall
is called.
pub fn finish(&mut self)
[src]
Prepare currently mapped buffers for use in a submission.
At this point, all the partially used staging buffers are closed until the GPU is done copying the data from them.
pub fn recall(&mut self) -> impl Future<Output = ()> + Send
[src]
Recall all of the closed buffers back to be reused.
This has to be called after the command encoders written to write_buffer
are submitted!
Auto Trait Implementations
impl !RefUnwindSafe for StagingBelt
impl Send for StagingBelt
impl !Sync for StagingBelt
impl Unpin for StagingBelt
impl !UnwindSafe for StagingBelt
Blanket Implementations
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
T: Component + Float,
D: AdaptFrom<S, Swp, Dwp, T>,
Swp: WhitePoint,
Dwp: WhitePoint,
[src]
T: Component + Float,
D: AdaptFrom<S, Swp, Dwp, T>,
Swp: WhitePoint,
Dwp: WhitePoint,
pub fn adapt_into_using<M>(self, method: M) -> D where
M: TransformMatrix<Swp, Dwp, T>,
[src]
M: TransformMatrix<Swp, Dwp, T>,
pub fn adapt_into(self) -> D
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> ConvertInto<U> for T where
U: ConvertFrom<T>,
[src]
U: ConvertFrom<T>,
pub fn convert_into(self) -> U
[src]
pub fn convert_unclamped_into(self) -> U
[src]
pub fn try_convert_into(self) -> Result<U, OutOfBounds<U>>
[src]
impl<T> Downcast<T> for T
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Pointable for T
pub const ALIGN: usize
type Init = T
The type for initializers.
pub unsafe fn init(init: <T as Pointable>::Init) -> usize
pub unsafe fn deref<'a>(ptr: usize) -> &'a T
pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
pub unsafe fn drop(ptr: usize)
impl<T> SetParameter for T
pub fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,
T: Parameter<Self>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Upcast<T> for T
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,