-
-
Notifications
You must be signed in to change notification settings - Fork 4k
[Merged by Bors] - Add ParallelCommands system parameter #4749
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
TheRawMeatball
wants to merge
10
commits into
bevyengine:main
from
TheRawMeatball:parallel-command-scope
Closed
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
da5e088
add method
TheRawMeatball 0772588
Merge remote-tracking branch 'upstream/main' into commands-from-entities
TheRawMeatball f424223
Add ParallelCommands SystemParam
TheRawMeatball 9597c9e
fix doctest
TheRawMeatball 14c9f24
Update crates/bevy_ecs/src/system/commands/parallel_scope.rs
TheRawMeatball 16aafd5
Update crates/bevy_ecs/src/system/commands/parallel_scope.rs
TheRawMeatball 2ca8970
Add determinism warning
TheRawMeatball d97549c
better variable names
TheRawMeatball 9b23bb1
Merge remote-tracking branch 'upstream/main' into parallel-command-scope
TheRawMeatball a97bfdc
update doc
TheRawMeatball File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
use std::cell::Cell; | ||
|
||
use thread_local::ThreadLocal; | ||
|
||
use crate::{ | ||
entity::Entities, | ||
prelude::World, | ||
system::{SystemParam, SystemParamFetch, SystemParamState}, | ||
}; | ||
|
||
use super::{CommandQueue, Commands}; | ||
|
||
#[doc(hidden)] | ||
#[derive(Default)] | ||
TheRawMeatball marked this conversation as resolved.
Show resolved
Hide resolved
|
||
/// The internal [`SystemParamState`] of the [`ParallelCommands`] type | ||
pub struct ParallelCommandsState { | ||
TheRawMeatball marked this conversation as resolved.
Show resolved
Hide resolved
|
||
thread_local_storage: ThreadLocal<Cell<CommandQueue>>, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I wonder if we should generalize this and add it to |
||
} | ||
|
||
/// An alternative to [`Commands`] that can be used in parallel contexts, such as those in [`Query::par_for_each`](crate::system::Query::par_for_each) | ||
/// | ||
/// Note: Because command application order will depend on how many threads are ran, non-commutative commands may result in non-deterministic results. | ||
/// | ||
TheRawMeatball marked this conversation as resolved.
Show resolved
Hide resolved
|
||
/// Example: | ||
/// ``` | ||
/// # use bevy_ecs::prelude::*; | ||
/// # use bevy_tasks::ComputeTaskPool; | ||
/// # | ||
/// # #[derive(Component)] | ||
/// # struct Velocity; | ||
/// # impl Velocity { fn magnitude(&self) -> f32 { 42.0 } } | ||
/// fn parallel_command_system( | ||
/// mut query: Query<(Entity, &Velocity)>, | ||
/// par_commands: ParallelCommands | ||
/// ) { | ||
/// query.par_for_each(32, |(entity, velocity)| { | ||
/// if velocity.magnitude() > 10.0 { | ||
/// par_commands.command_scope(|mut commands| { | ||
/// commands.entity(entity).despawn(); | ||
/// }); | ||
/// } | ||
/// }); | ||
/// } | ||
/// # bevy_ecs::system::assert_is_system(parallel_command_system); | ||
///``` | ||
pub struct ParallelCommands<'w, 's> { | ||
state: &'s mut ParallelCommandsState, | ||
entities: &'w Entities, | ||
} | ||
|
||
impl SystemParam for ParallelCommands<'_, '_> { | ||
type Fetch = ParallelCommandsState; | ||
} | ||
|
||
impl<'w, 's> SystemParamFetch<'w, 's> for ParallelCommandsState { | ||
type Item = ParallelCommands<'w, 's>; | ||
|
||
unsafe fn get_param( | ||
state: &'s mut Self, | ||
_: &crate::system::SystemMeta, | ||
world: &'w World, | ||
_: u32, | ||
) -> Self::Item { | ||
ParallelCommands { | ||
state, | ||
entities: world.entities(), | ||
} | ||
} | ||
} | ||
|
||
// SAFE: no component or resource access to report | ||
unsafe impl SystemParamState for ParallelCommandsState { | ||
fn init(_: &mut World, _: &mut crate::system::SystemMeta) -> Self { | ||
Self::default() | ||
} | ||
|
||
fn apply(&mut self, world: &mut World) { | ||
for cq in self.thread_local_storage.iter_mut() { | ||
cq.get_mut().apply(world); | ||
} | ||
} | ||
} | ||
|
||
impl<'w, 's> ParallelCommands<'w, 's> { | ||
pub fn command_scope<R>(&self, f: impl FnOnce(Commands) -> R) -> R { | ||
let store = &self.state.thread_local_storage; | ||
let command_queue_cell = store.get_or_default(); | ||
let mut command_queue = command_queue_cell.take(); | ||
|
||
let r = f(Commands::new_from_entities( | ||
&mut command_queue, | ||
self.entities, | ||
)); | ||
|
||
command_queue_cell.set(command_queue); | ||
r | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this already in our tree?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, but it is a nice crate that another PR (#4663) depends on as well.