Struct wgpu_core::track::buffer::BufferTracker
source · pub(crate) struct BufferTracker<A: HalApi> {
start: Vec<BufferUses>,
end: Vec<BufferUses>,
metadata: ResourceMetadata<A>,
temp: Vec<PendingTransition<BufferUses>>,
}
Expand description
Stores all buffer state within a command buffer or device.
Fields§
§start: Vec<BufferUses>
§end: Vec<BufferUses>
§metadata: ResourceMetadata<A>
§temp: Vec<PendingTransition<BufferUses>>
Implementations§
source§impl<A: HalApi> BufferTracker<A>
impl<A: HalApi> BufferTracker<A>
pub fn new() -> Self
fn tracker_assert_in_bounds(&self, index: usize)
sourcepub fn set_size(&mut self, size: usize)
pub fn set_size(&mut self, size: usize)
Sets the size of all the vectors inside the tracker.
Must be called with the highest possible Buffer ID before all unsafe functions are called.
sourcefn allow_index(&mut self, index: usize)
fn allow_index(&mut self, index: usize)
Extend the vectors to let the given index be valid.
sourcepub fn used(&self) -> impl Iterator<Item = Valid<BufferId>> + '_
pub fn used(&self) -> impl Iterator<Item = Valid<BufferId>> + '_
Returns a list of all buffers tracked.
sourcepub fn drain(&mut self) -> Drain<'_, PendingTransition<BufferUses>>
pub fn drain(&mut self) -> Drain<'_, PendingTransition<BufferUses>>
Drains all currently pending transitions.
sourcepub fn insert_single(
&mut self,
id: Valid<BufferId>,
ref_count: RefCount,
state: BufferUses
)
pub fn insert_single( &mut self, id: Valid<BufferId>, ref_count: RefCount, state: BufferUses )
Inserts a single buffer and its state into the resource tracker.
If the resource already exists in the tracker, this will panic.
If the ID is higher than the length of internal vectors, the vectors will be extended. A call to set_size is not needed.
sourcepub fn set_single<'a>(
&mut self,
storage: &'a Storage<Buffer<A>, BufferId>,
id: BufferId,
state: BufferUses
) -> Option<(&'a Buffer<A>, Option<PendingTransition<BufferUses>>)>
pub fn set_single<'a>( &mut self, storage: &'a Storage<Buffer<A>, BufferId>, id: BufferId, state: BufferUses ) -> Option<(&'a Buffer<A>, Option<PendingTransition<BufferUses>>)>
Sets the state of a single buffer.
If a transition is needed to get the buffer into the given state, that transition is returned. No more than one transition is needed.
If the ID is higher than the length of internal vectors, the vectors will be extended. A call to set_size is not needed.
sourcepub fn set_from_tracker(&mut self, tracker: &Self)
pub fn set_from_tracker(&mut self, tracker: &Self)
Sets the given state for all buffers in the given tracker.
If a transition is needed to get the buffers into the needed state,
those transitions are stored within the tracker. A subsequent
call to Self::drain
is needed to get those transitions.
If the ID is higher than the length of internal vectors, the vectors will be extended. A call to set_size is not needed.
sourcepub fn set_from_usage_scope(&mut self, scope: &BufferUsageScope<A>)
pub fn set_from_usage_scope(&mut self, scope: &BufferUsageScope<A>)
Sets the given state for all buffers in the given UsageScope.
If a transition is needed to get the buffers into the needed state,
those transitions are stored within the tracker. A subsequent
call to Self::drain
is needed to get those transitions.
If the ID is higher than the length of internal vectors, the vectors will be extended. A call to set_size is not needed.
sourcepub unsafe fn set_and_remove_from_usage_scope_sparse(
&mut self,
scope: &mut BufferUsageScope<A>,
id_source: impl IntoIterator<Item = Valid<BufferId>>
)
pub unsafe fn set_and_remove_from_usage_scope_sparse( &mut self, scope: &mut BufferUsageScope<A>, id_source: impl IntoIterator<Item = Valid<BufferId>> )
Iterates through all buffers in the given bind group and adopts the state given for those buffers in the UsageScope. It also removes all touched buffers from the usage scope.
If a transition is needed to get the buffers into the needed state,
those transitions are stored within the tracker. A subsequent
call to Self::drain
is needed to get those transitions.
This is a really funky method used by Compute Passes to generate barriers after a call to dispatch without needing to iterate over all elements in the usage scope. We use each the a given iterator of ids as a source of which IDs to look at. All the IDs must have first been added to the usage scope.
Safety
Self::set_size
must be called with the maximum possible Buffer ID before this
method is called.
sourcepub fn remove_abandoned(&mut self, id: Valid<BufferId>) -> bool
pub fn remove_abandoned(&mut self, id: Valid<BufferId>) -> bool
Removes the given resource from the tracker iff we have the last reference to the resource and the epoch matches.
Returns true if the resource was removed.
If the ID is higher than the length of internal vectors, false will be returned.