pub struct BufferSlice<'a> { /* private fields */ }
Implementations§
Methods from Deref<Target = BufferSlice<'a>>§
Sourcepub fn slice<S>(&self, bounds: S) -> BufferSlice<'a>where
S: RangeBounds<u64>,
pub fn slice<S>(&self, bounds: S) -> BufferSlice<'a>where
S: RangeBounds<u64>,
Return another BufferSlice
referring to the portion of self
’s contents
indicated by bounds
.
The range
argument can be half or fully unbounded: for example,
buffer.slice(..)
refers to the entire buffer, and buffer.slice(n..)
refers to the portion starting at the n
th byte and extending to the
end of the buffer.
§Panics
- If
bounds
is outside of the bounds ofself
. - If
bounds
has a length less than 1.
Sourcepub fn map_async(
&self,
mode: MapMode,
callback: impl FnOnce(Result<(), BufferAsyncError>) + WasmNotSend + 'static,
)
pub fn map_async( &self, mode: MapMode, callback: impl FnOnce(Result<(), BufferAsyncError>) + WasmNotSend + 'static, )
Map the buffer to host (CPU) memory, making it available for reading or writing
via get_mapped_range()
.
It is available once the callback
is called with an Ok
response.
For the callback to complete, either queue.submit(..)
, instance.poll_all(..)
, or device.poll(..)
must be called elsewhere in the runtime, possibly integrated into an event loop or run on a separate thread.
The callback will be called on the thread that first calls the above functions after the GPU work has completed. There are no restrictions on the code you can run in the callback, however on native the call to the function will not complete until the callback returns, so prefer keeping callbacks short and used to set flags, send messages, etc.
As long as a buffer is mapped, it is not available for use by any other commands; at all times, either the GPU or the CPU has exclusive access to the contents of the buffer.
This can also be performed using Buffer::map_async()
.
§Panics
- If the buffer is already mapped.
- If the buffer’s
BufferUsages
do not allow the requestedMapMode
. - If the endpoints of this slice are not aligned to
MAP_ALIGNMENT
within the buffer.
Sourcepub fn get_mapped_range(&self) -> BufferView<'a>
pub fn get_mapped_range(&self) -> BufferView<'a>
Gain read-only access to the bytes of a mapped Buffer
.
Returns a BufferView
referring to the buffer range represented by
self
. See the documentation for BufferView
for details.
Multiple views may be obtained and used simultaneously as long as they are from non-overlapping slices.
This can also be performed using Buffer::get_mapped_range()
.
§Panics
- If the endpoints of this slice are not aligned to
MAP_ALIGNMENT
within the buffer. - If the buffer to which
self
refers is not currently mapped. - If you try to create overlapping views of a buffer, mutable or otherwise.
Sourcepub fn get_mapped_range_mut(&self) -> BufferViewMut<'a>
pub fn get_mapped_range_mut(&self) -> BufferViewMut<'a>
Gain write access to the bytes of a mapped Buffer
.
Returns a BufferViewMut
referring to the buffer range represented by
self
. See the documentation for BufferViewMut
for more details.
Multiple views may be obtained and used simultaneously as long as they are from non-overlapping slices.
This can also be performed using Buffer::get_mapped_range_mut()
.
§Panics
- If the endpoints of this slice are not aligned to
MAP_ALIGNMENT
. - If the buffer to which
self
refers is not currently mapped. - If you try to create overlapping views of a buffer, mutable or otherwise.
Sourcepub fn buffer(&self) -> &'a Buffer
pub fn buffer(&self) -> &'a Buffer
Returns the buffer this is a slice of.
You should usually not need to call this, and if you received the buffer from code you do not control, you should refrain from accessing the buffer outside the bounds of the slice. Nevertheless, it’s possible to get this access, so this method makes it simple.
Sourcepub fn offset(&self) -> u64
pub fn offset(&self) -> u64
Returns the offset in Self::buffer()
this slice starts at.
Trait Implementations§
Source§impl<'a> Clone for BufferSlice<'a>
impl<'a> Clone for BufferSlice<'a>
Source§fn clone(&self) -> BufferSlice<'a>
fn clone(&self) -> BufferSlice<'a>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl<'a> Debug for BufferSlice<'a>
impl<'a> Debug for BufferSlice<'a>
Source§impl<'a> Deref for BufferSlice<'a>
impl<'a> Deref for BufferSlice<'a>
Source§type Target = BufferSlice<'a>
type Target = BufferSlice<'a>
Auto Trait Implementations§
impl<'a> Freeze for BufferSlice<'a>
impl<'a> !RefUnwindSafe for BufferSlice<'a>
impl<'a> Send for BufferSlice<'a>
impl<'a> Sync for BufferSlice<'a>
impl<'a> Unpin for BufferSlice<'a>
impl<'a> !UnwindSafe for BufferSlice<'a>
Blanket Implementations§
Source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
Source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
, which can then be
downcast
into Box<dyn ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
, which can then be further
downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more