Skip to content
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.

Sign up for GitHub

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

Increase type safety and clarity for change detection #7905

Merged
merged 22 commits into from
Mar 9, 2023
Merged

Increase type safety and clarity for change detection #7905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
0dcbb3e
use the `Tick` type for change ticks
joseph-gio Mar 5, 2023
3c6910f
use `Tick` in `DetectChangesMut`
joseph-gio Mar 5, 2023
f7d650b
rename locals to `last_run` and `this_run`
joseph-gio Mar 5, 2023
dd9bf5e
rename `{g,s}et_last_change_tick` to `last_run`
joseph-gio Mar 5, 2023
fdcb88b
rename `SystemMeta::last_change_tick`
joseph-gio Mar 5, 2023
4428354
rename stuff for `SystemChangeTick`
joseph-gio Mar 5, 2023
66cfcd1
rename more things to `last_run`
joseph-gio Mar 5, 2023
5400aa5
rewrite docs for `Tick`
joseph-gio Mar 5, 2023
bc7267f
update `ComponentTicks::set_changed`
joseph-gio Mar 5, 2023
4afe50f
rename `Tick::set_changed` to `set`
joseph-gio Mar 5, 2023
6fd32f8
remove incorrect duplicate docs
joseph-gio Mar 5, 2023
9d94588
add `Tick::relative_to` to encapsulate subtraction
joseph-gio Mar 5, 2023
4539841
return `Tick` from `DetectChanges`
joseph-gio Mar 5, 2023
71c7271
encapsulate `Tick::tick`
joseph-gio Mar 5, 2023
39043c9
encapsulate tick checks
joseph-gio Mar 5, 2023
195dfc7
encapsulate uses of `MAX_CHANGE_TICK`
joseph-gio Mar 5, 2023
7a9be98
make `relative_to` pub(crate)
joseph-gio Mar 6, 2023
0aaa1ae
Merge remote-tracking branch 'upstream/main' into newtype-ticks
joseph-gio Mar 9, 2023
7a4b357
fix a merge error
joseph-gio Mar 9, 2023
bef9ce6
update a unit test
joseph-gio Mar 9, 2023
75d33a8
bless a compile fail test
joseph-gio Mar 9, 2023
d1b7c09
Merge remote-tracking branch 'upstream/main' into newtype-ticks
joseph-gio Mar 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions crates/bevy_ecs/macros/src/fetch.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,16 +224,16 @@ pub fn derive_world_query_impl(ast: DeriveInput) -> TokenStream {
unsafe fn init_fetch<'__w>(
_world: &'__w #path::world::World,
state: &Self::State,
_last_change_tick: u32,
_change_tick: u32
_last_run: #path::component::Tick,
_this_run: #path::component::Tick,
) -> <Self as #path::query::WorldQuery>::Fetch<'__w> {
#fetch_struct_name {
#(#field_idents:
<#field_types>::init_fetch(
_world,
&state.#field_idents,
_last_change_tick,
_change_tick
_last_run,
_this_run,
),
)*
#(#ignored_field_idents: Default::default(),)*
Expand Down
4 changes: 2 additions & 2 deletions crates/bevy_ecs/macros/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ pub fn impl_param_set(_input: TokenStream) -> TokenStream {
state: &'s mut Self::State,
system_meta: &SystemMeta,
world: &'w World,
change_tick: u32,
change_tick: Tick,
) -> Self::Item<'w, 's> {
ParamSet {
param_states: state,
Expand Down Expand Up @@ -431,7 +431,7 @@ pub fn derive_system_param(input: TokenStream) -> TokenStream {
state: &'s2 mut Self::State,
system_meta: &#path::system::SystemMeta,
world: &'w2 #path::world::World,
change_tick: u32,
change_tick: #path::component::Tick,
) -> Self::Item<'w2, 's2> {
let (#(#tuple_patterns,)*) = <
(#(#tuple_types,)*) as #path::system::SystemParam
Expand Down
12 changes: 6 additions & 6 deletions crates/bevy_ecs/src/bundle.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ impl BundleInfo {
components: &mut Components,
storages: &'a mut Storages,
archetype_id: ArchetypeId,
change_tick: u32,
change_tick: Tick,
) -> BundleInserter<'a, 'b> {
let new_archetype_id =
self.add_bundle_to_archetype(archetypes, storages, components, archetype_id);
Expand Down Expand Up @@ -342,7 +342,7 @@ impl BundleInfo {
archetypes: &'a mut Archetypes,
components: &mut Components,
storages: &'a mut Storages,
change_tick: u32,
change_tick: Tick,
) -> BundleSpawner<'a, 'b> {
let new_archetype_id =
self.add_bundle_to_archetype(archetypes, storages, components, ArchetypeId::EMPTY);
Expand Down Expand Up @@ -383,7 +383,7 @@ impl BundleInfo {
bundle_component_status: &S,
entity: Entity,
table_row: TableRow,
change_tick: u32,
change_tick: Tick,
bundle: T,
) {
// NOTE: get_components calls this closure on each component in "bundle order".
Expand All @@ -397,7 +397,7 @@ impl BundleInfo {
// SAFETY: bundle_component is a valid index for this bundle
match bundle_component_status.get_status(bundle_component) {
ComponentStatus::Added => {
column.initialize(table_row, component_ptr, Tick::new(change_tick));
column.initialize(table_row, component_ptr, change_tick);
}
ComponentStatus::Mutated => {
column.replace(table_row, component_ptr, change_tick);
Expand Down Expand Up @@ -508,7 +508,7 @@ pub(crate) struct BundleInserter<'a, 'b> {
sparse_sets: &'a mut SparseSets,
result: InsertBundleResult<'a>,
archetypes_ptr: *mut Archetype,
change_tick: u32,
change_tick: Tick,
}

pub(crate) enum InsertBundleResult<'a> {
Expand Down Expand Up @@ -666,7 +666,7 @@ pub(crate) struct BundleSpawner<'a, 'b> {
bundle_info: &'b BundleInfo,
table: &'a mut Table,
sparse_sets: &'a mut SparseSets,
change_tick: u32,
change_tick: Tick,
}

impl<'a, 'b> BundleSpawner<'a, 'b> {
Expand Down
Loading