mirror of
https://github.com/storytold/wgpu.git
synced 2026-11-21 06:50:59 +01:00
Reformat comments in wgpu-core. (#3102)
This commit is contained in:
1 parent
fa4d8401e8
commit
215884184b
22 files changed
+525
-289
No files matched your search
@@ -27,10 +27,12 @@ pub(crate) type SurfacesInDiscardState = Vec<TextureSurfaceDiscard>;
|
||||
|
||||
#[derive(Default)]
|
||||
pub(crate) struct CommandBufferTextureMemoryActions {
|
||||
// init actions describe the tracker actions that we need to be executed before the command buffer is executed
|
||||
/// The tracker actions that we need to be executed before the command
|
||||
/// buffer is executed.
|
||||
init_actions: Vec<TextureInitTrackerAction>,
|
||||
// discards describe all the discards that haven't been followed by init again within the command buffer
|
||||
// i.e. everything in this list resets the texture init state *after* the command buffer execution
|
||||
/// All the discards that haven't been followed by init again within the
|
||||
/// command buffer i.e. everything in this list resets the texture init
|
||||
/// state *after* the command buffer execution
|
||||
discards: Vec<TextureSurfaceDiscard>,
|
||||
}
|
||||
|
||||
@@ -54,19 +56,22 @@ impl CommandBufferTextureMemoryActions {
|
||||
) -> SurfacesInDiscardState {
|
||||
let mut immediately_necessary_clears = SurfacesInDiscardState::new();
|
||||
|
||||
// Note that within a command buffer we may stack arbitrary memory init actions on the same texture
|
||||
// Since we react to them in sequence, they are going to be dropped again at queue submit
|
||||
// Note that within a command buffer we may stack arbitrary memory init
|
||||
// actions on the same texture Since we react to them in sequence, they
|
||||
// are going to be dropped again at queue submit
|
||||
//
|
||||
// We don't need to add MemoryInitKind::NeedsInitializedMemory to init_actions if a surface is part of the discard list.
|
||||
// But that would mean splitting up the action which is more than we'd win here.
|
||||
// We don't need to add MemoryInitKind::NeedsInitializedMemory to
|
||||
// init_actions if a surface is part of the discard list. But that would
|
||||
// mean splitting up the action which is more than we'd win here.
|
||||
self.init_actions
|
||||
.extend(match texture_guard.get(action.id) {
|
||||
Ok(texture) => texture.initialization_status.check_action(action),
|
||||
Err(_) => return immediately_necessary_clears, // texture no longer exists
|
||||
});
|
||||
|
||||
// We expect very few discarded surfaces at any point in time which is why a simple linear search is likely best.
|
||||
// (i.e. most of the time self.discards is empty!)
|
||||
// We expect very few discarded surfaces at any point in time which is
|
||||
// why a simple linear search is likely best. (i.e. most of the time
|
||||
// self.discards is empty!)
|
||||
let init_actions = &mut self.init_actions;
|
||||
self.discards.retain(|discarded_surface| {
|
||||
if discarded_surface.texture == action.id
|
||||
@@ -79,7 +84,9 @@ impl CommandBufferTextureMemoryActions {
|
||||
if let MemoryInitKind::NeedsInitializedMemory = action.kind {
|
||||
immediately_necessary_clears.push(discarded_surface.clone());
|
||||
|
||||
// Mark surface as implicitly initialized (this is relevant because it might have been uninitialized prior to discarding
|
||||
// Mark surface as implicitly initialized (this is relevant
|
||||
// because it might have been uninitialized prior to
|
||||
// discarding
|
||||
init_actions.push(TextureInitTrackerAction {
|
||||
id: discarded_surface.texture,
|
||||
range: TextureInitRange {
|
||||
@@ -99,7 +106,8 @@ impl CommandBufferTextureMemoryActions {
|
||||
immediately_necessary_clears
|
||||
}
|
||||
|
||||
// Shortcut for register_init_action when it is known that the action is an implicit init, not requiring any immediate resource init.
|
||||
// Shortcut for register_init_action when it is known that the action is an
|
||||
// implicit init, not requiring any immediate resource init.
|
||||
pub(crate) fn register_implicit_init<A: hal::Api>(
|
||||
&mut self,
|
||||
id: id::Valid<TextureId>,
|
||||
@@ -118,7 +126,9 @@ impl CommandBufferTextureMemoryActions {
|
||||
}
|
||||
}
|
||||
|
||||
// Utility function that takes discarded surfaces from (several calls to) register_init_action and initializes them on the spot.
|
||||
// Utility function that takes discarded surfaces from (several calls to)
|
||||
// register_init_action and initializes them on the spot.
|
||||
//
|
||||
// Takes care of barriers as well!
|
||||
pub(crate) fn fixup_discarded_surfaces<
|
||||
A: HalApi,
|
||||
@@ -148,14 +158,16 @@ pub(crate) fn fixup_discarded_surfaces<
|
||||
}
|
||||
|
||||
impl<A: HalApi> BakedCommands<A> {
|
||||
// inserts all buffer initializations that are going to be needed for executing the commands and updates resource init states accordingly
|
||||
// inserts all buffer initializations that are going to be needed for
|
||||
// executing the commands and updates resource init states accordingly
|
||||
pub(crate) fn initialize_buffer_memory(
|
||||
&mut self,
|
||||
device_tracker: &mut Tracker<A>,
|
||||
buffer_guard: &mut Storage<Buffer<A>, id::BufferId>,
|
||||
) -> Result<(), DestroyedBufferError> {
|
||||
// Gather init ranges for each buffer so we can collapse them.
|
||||
// It is not possible to do this at an earlier point since previously executed command buffer change the resource init state.
|
||||
// It is not possible to do this at an earlier point since previously
|
||||
// executed command buffer change the resource init state.
|
||||
let mut uninitialized_ranges_per_buffer = FastHashMap::default();
|
||||
for buffer_use in self.buffer_memory_init_actions.drain(..) {
|
||||
let buffer = buffer_guard
|
||||
@@ -194,15 +206,19 @@ impl<A: HalApi> BakedCommands<A> {
|
||||
// Collapse touching ranges.
|
||||
ranges.sort_by_key(|r| r.start);
|
||||
for i in (1..ranges.len()).rev() {
|
||||
assert!(ranges[i - 1].end <= ranges[i].start); // The memory init tracker made sure of this!
|
||||
// The memory init tracker made sure of this!
|
||||
assert!(ranges[i - 1].end <= ranges[i].start);
|
||||
if ranges[i].start == ranges[i - 1].end {
|
||||
ranges[i - 1].end = ranges[i].end;
|
||||
ranges.swap_remove(i); // Ordering not important at this point
|
||||
}
|
||||
}
|
||||
|
||||
// Don't do use_replace since the buffer may already no longer have a ref_count.
|
||||
// However, we *know* that it is currently in use, so the tracker must already know about it.
|
||||
// Don't do use_replace since the buffer may already no longer have
|
||||
// a ref_count.
|
||||
//
|
||||
// However, we *know* that it is currently in use, so the tracker
|
||||
// must already know about it.
|
||||
let transition = device_tracker
|
||||
.buffers
|
||||
.set_single(buffer_guard, buffer_id, hal::BufferUses::COPY_DST)
|
||||
@@ -223,8 +239,20 @@ impl<A: HalApi> BakedCommands<A> {
|
||||
}
|
||||
|
||||
for range in ranges.iter() {
|
||||
assert!(range.start % wgt::COPY_BUFFER_ALIGNMENT == 0, "Buffer {:?} has an uninitialized range with a start not aligned to 4 (start was {})", raw_buf, range.start);
|
||||
assert!(range.end % wgt::COPY_BUFFER_ALIGNMENT == 0, "Buffer {:?} has an uninitialized range with an end not aligned to 4 (end was {})", raw_buf, range.end);
|
||||
assert!(
|
||||
range.start % wgt::COPY_BUFFER_ALIGNMENT == 0,
|
||||
"Buffer {:?} has an uninitialized range with a start \
|
||||
not aligned to 4 (start was {})",
|
||||
raw_buf,
|
||||
range.start
|
||||
);
|
||||
assert!(
|
||||
range.end % wgt::COPY_BUFFER_ALIGNMENT == 0,
|
||||
"Buffer {:?} has an uninitialized range with an end \
|
||||
not aligned to 4 (end was {})",
|
||||
raw_buf,
|
||||
range.end
|
||||
);
|
||||
|
||||
unsafe {
|
||||
self.encoder.clear_buffer(raw_buf, range.clone());
|
||||
@@ -234,8 +262,10 @@ impl<A: HalApi> BakedCommands<A> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
// inserts all texture initializations that are going to be needed for executing the commands and updates resource init states accordingly
|
||||
// any textures that are left discarded by this command buffer will be marked as uninitialized
|
||||
// inserts all texture initializations that are going to be needed for
|
||||
// executing the commands and updates resource init states accordingly any
|
||||
// textures that are left discarded by this command buffer will be marked as
|
||||
// uninitialized
|
||||
pub(crate) fn initialize_texture_memory(
|
||||
&mut self,
|
||||
device_tracker: &mut Tracker<A>,
|
||||
@@ -290,7 +320,9 @@ impl<A: HalApi> BakedCommands<A> {
|
||||
}
|
||||
}
|
||||
|
||||
// Now that all buffers/textures have the proper init state for before cmdbuf start, we discard init states for textures it left discarded after its execution.
|
||||
// Now that all buffers/textures have the proper init state for before
|
||||
// cmdbuf start, we discard init states for textures it left discarded
|
||||
// after its execution.
|
||||
for surface_discard in self.texture_memory_actions.discards.iter() {
|
||||
let texture = texture_guard
|
||||
.get_mut(surface_discard.texture)
|
||||
|
||||
Reference in new issue
Block a user