[Merged by Bors] - ExtractResourcePlugin #3745

superdump · 2022-01-22T13:59:29Z

Objective

Add an ExtractResourcePlugin for convenience and consistency

Solution

Add an ExtractResourcePlugin similar to ExtractComponentPlugin but for ECS Resources. The system that is executed simply clones the main world resource into a render world resource, if and only if the main world resource was either added or changed since the last execution of the system.
Add an ExtractResource trait with a fn extract_resource(res: &Self) -> Self function. This is used by the ExtractResourcePlugin to extract the resource
Add a derive macro for ExtractResource on a Resource with the Clone trait, that simply returns res.clone()
Use ExtractResourcePlugin wherever both possible and appropriate

kurtkuehnert · 2022-01-22T14:19:34Z

Should we use a ExtractResource trait to specify the extract method explicitly like we do for components? Is there a use case where we want to do something else than simply clone the component/resource into the render world?
And additionally I have thought about adding a derive ExtractComponent macro, which simply clones the component (without a filter), since this seems to be the common case.

crates/bevy_render/src/render_ecs_resource.rs

superdump · 2022-01-22T14:55:09Z

Should we use a ExtractResource trait to specify the extract method explicitly like we do for components? Is there a use case where we want to do something else than simply clone the component/resource into the render world?

Yup, that is definitely a use case as there are multiple instances of resource extraction systems that do something beyond just cloning. I'll look into it.

And additionally I have thought about adding a derive ExtractComponent macro, which simply clones the component (without a filter), since this seems to be the common case.

I was thinking that it would be good to go through and make use of ExtractComponentPlugin 'everywhere' now too. Mmm, perhaps that could be a reasonable approach... not requiring Clone but rather requiring it when deriving ExtractComponent. And similar for ExtractResource.

examples/shader/compute_shader_game_of_life.rs

superdump · 2022-01-22T23:10:03Z

I had a go at adding an ExtractResource trait, as well as a derive macro for it. This is my first time implementing any macro at all from scratch in Rust as far as I can remember. I pieced together some bits I found among the ECS derive macros and I think I've done it correctly but please do scrutinise it so I can learn if I did anything wrong. :)

crates/bevy_render/macros/src/render_ecs_resource.rs

kurtkuehnert · 2022-01-23T10:56:26Z

I really like those changes. The new plugin and its derive macro should make the extraction process way more ergonomic and should remove some boilerplate from user code. I am not familiar with macros as well, but the rest LGTM.
Now only the ExtractComponent derive macro is left, but this should probably be its own PR, because it is a bit less straight forward and maybe even controversial.

superdump · 2022-01-23T10:58:47Z

Yeah, I think keeping this PR to be only about extracting resources is a good idea, so I didn't look into the derive macro for extracting components. If we like the pattern here and we think it makes sense for components too then I can make another PR for that.

MinerSebas

The new bevy_render_macros crate also needs to be added to the ./tools/publish.sh script

crates/bevy_render/src/render_ecs_resource.rs

superdump · 2022-01-23T11:45:40Z

The new bevy_render_macros crate also needs to be added to the ./tools/publish.sh script

Done.

cart

I'm on board for this generally, but I'd like us to consider an alternative trait design.

crates/bevy_render/src/render_ecs_resource.rs

Co-authored-by: MinerSebas <66798382+MinerSebas@users.noreply.github.com>

…urcePlugin

Co-authored-by: MinerSebas <66798382+MinerSebas@users.noreply.github.com>

…extract_component

… resource

superdump · 2022-05-04T23:51:52Z

@cart any further comments or is this good to go now?

alice-i-cecile · 2022-05-30T15:09:48Z

This has been sitting for a couple weeks, and isn't controversial. I've done a final pass and I'm going to merge it in. We can tweak it further once it's in as we build on it.

alice-i-cecile · 2022-05-30T15:09:59Z

bors r+

bors · 2022-05-30T15:10:15Z

Merge conflict.

alice-i-cecile · 2022-05-30T16:20:01Z

@superdump can you rebase?

superdump · 2022-05-30T16:57:52Z

@superdump can you rebase?

Merged in main.

alice-i-cecile · 2022-05-30T18:16:30Z

bors r+

# Objective - Add an `ExtractResourcePlugin` for convenience and consistency ## Solution - Add an `ExtractResourcePlugin` similar to `ExtractComponentPlugin` but for ECS `Resource`s. The system that is executed simply clones the main world resource into a render world resource, if and only if the main world resource was either added or changed since the last execution of the system. - Add an `ExtractResource` trait with a `fn extract_resource(res: &Self) -> Self` function. This is used by the `ExtractResourcePlugin` to extract the resource - Add a derive macro for `ExtractResource` on a `Resource` with the `Clone` trait, that simply returns `res.clone()` - Use `ExtractResourcePlugin` wherever both possible and appropriate

bors · 2022-05-30T18:58:44Z

Pull request successfully merged into main.

Build succeeded:

# Objective - Add an `ExtractResourcePlugin` for convenience and consistency ## Solution - Add an `ExtractResourcePlugin` similar to `ExtractComponentPlugin` but for ECS `Resource`s. The system that is executed simply clones the main world resource into a render world resource, if and only if the main world resource was either added or changed since the last execution of the system. - Add an `ExtractResource` trait with a `fn extract_resource(res: &Self) -> Self` function. This is used by the `ExtractResourcePlugin` to extract the resource - Add a derive macro for `ExtractResource` on a `Resource` with the `Clone` trait, that simply returns `res.clone()` - Use `ExtractResourcePlugin` wherever both possible and appropriate

superdump self-assigned this Jan 22, 2022

github-actions bot added the S-Needs-Triage This issue needs to be labelled label Jan 22, 2022

superdump added A-Rendering Drawing game state to the screen C-Enhancement A new feature and removed S-Needs-Triage This issue needs to be labelled labels Jan 22, 2022

superdump requested a review from cart January 22, 2022 14:01

MinerSebas reviewed Jan 22, 2022

View reviewed changes

crates/bevy_render/src/render_ecs_resource.rs Outdated Show resolved Hide resolved

james7132 requested changes Jan 22, 2022

View reviewed changes

examples/shader/compute_shader_game_of_life.rs Show resolved Hide resolved

superdump commented Jan 22, 2022

View reviewed changes

crates/bevy_render/macros/src/render_ecs_resource.rs Outdated Show resolved Hide resolved

MinerSebas reviewed Jan 23, 2022

View reviewed changes

crates/bevy_render/src/render_ecs_resource.rs Outdated Show resolved Hide resolved

MinerSebas approved these changes Jan 23, 2022

View reviewed changes

mockersf approved these changes Jan 23, 2022

View reviewed changes

superdump force-pushed the extract-resource-plugin branch from a4f7fd9 to dc90e02 Compare March 4, 2022 00:04

kurtkuehnert approved these changes Mar 4, 2022

View reviewed changes

superdump force-pushed the extract-resource-plugin branch 3 times, most recently from 8da17f1 to 009f982 Compare March 28, 2022 07:54

superdump force-pushed the extract-resource-plugin branch from 009f982 to 0b97a9d Compare April 7, 2022 19:14

james7132 added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Apr 8, 2022

cart reviewed Apr 25, 2022

View reviewed changes

crates/bevy_render/src/render_ecs_resource.rs Outdated Show resolved Hide resolved

crates/bevy_render/src/render_ecs_resource.rs Outdated Show resolved Hide resolved

superdump and others added 4 commits May 5, 2022 01:24

bevy_render: Add ExtractResourcePlugin to extract ECS Resources

944dff6

Use ExtractResourcePlugin where possible and appropriate

09aef1b

Update crates/bevy_render/src/render_ecs_resource.rs

a6204b3

Co-authored-by: MinerSebas <66798382+MinerSebas@users.noreply.github.com>

Add ExtractResource trait and derivation that just clones the Resource

d97bf6f

superdump and others added 7 commits May 5, 2022 01:26

compute_shader_game_of_life: Add clarifying comment about ExtractReso…

c635861

…urcePlugin

Enable use of ExtractResource derive macro within bevy_render itself

2f4736b

Add bevy_render/macros to publish.sh script

4af4421

Update crates/bevy_render/src/render_ecs_resource.rs

2b86bbe

Co-authored-by: MinerSebas <66798382+MinerSebas@users.noreply.github.com>

Move render_ecs_resource to extract_resource and render_component to …

0c761f8

…extract_component

Bump bevy_render_macros Cargo.toml versions to 0.8.0-dev

9a66a7d

bevy_render: Add associated type for the ExtractResource trait source…

38013fd

… resource

superdump force-pushed the extract-resource-plugin branch from 0b97a9d to 38013fd Compare May 4, 2022 23:47

alice-i-cecile requested a review from cart May 16, 2022 17:29

Merge branch 'main' into extract-resource-plugin

4ee5285

bors bot changed the title ~~ExtractResourcePlugin~~ [Merged by Bors] - ExtractResourcePlugin May 30, 2022

bors bot closed this May 30, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Merged by Bors] - ExtractResourcePlugin #3745

[Merged by Bors] - ExtractResourcePlugin #3745

superdump commented Jan 22, 2022 •

edited

Loading

kurtkuehnert commented Jan 22, 2022

superdump commented Jan 22, 2022

superdump commented Jan 22, 2022

kurtkuehnert commented Jan 23, 2022

superdump commented Jan 23, 2022

MinerSebas left a comment

superdump commented Jan 23, 2022

cart left a comment

superdump commented May 4, 2022

alice-i-cecile commented May 30, 2022

alice-i-cecile commented May 30, 2022

bors bot commented May 30, 2022

alice-i-cecile commented May 30, 2022

superdump commented May 30, 2022

alice-i-cecile commented May 30, 2022

bors bot commented May 30, 2022

[Merged by Bors] - ExtractResourcePlugin #3745

[Merged by Bors] - ExtractResourcePlugin #3745

Conversation

superdump commented Jan 22, 2022 • edited Loading

Objective

Solution

kurtkuehnert commented Jan 22, 2022

superdump commented Jan 22, 2022

superdump commented Jan 22, 2022

kurtkuehnert commented Jan 23, 2022

superdump commented Jan 23, 2022

MinerSebas left a comment

Choose a reason for hiding this comment

superdump commented Jan 23, 2022

cart left a comment

Choose a reason for hiding this comment

superdump commented May 4, 2022

alice-i-cecile commented May 30, 2022

alice-i-cecile commented May 30, 2022

bors bot commented May 30, 2022

alice-i-cecile commented May 30, 2022

superdump commented May 30, 2022

alice-i-cecile commented May 30, 2022

bors bot commented May 30, 2022

superdump commented Jan 22, 2022 •

edited

Loading