[Merged by Bors] - Use plugin setup for resource only used at setup time #6360

mockersf · 2022-10-24T23:13:28Z

Objective

Build on [Merged by Bors] - Plugins own their settings. Rework PluginGroup trait. #6336 for more plugin configurations

Solution

LogSettings, ImageSettings and DefaultTaskPoolOptions are now plugins settings rather than resources

Changelog

LogSettings plugin settings have been move to LogPlugin, ImageSettings to ImagePlugin and DefaultTaskPoolOptions to CorePlugin

Migration Guide

The LogSettings settings have been moved from a resource to LogPlugin configuration:

// Old (Bevy 0.8)
app
  .insert_resource(LogSettings {
    level: Level::DEBUG,
    filter: "wgpu=error,bevy_render=info,bevy_ecs=trace".to_string(),
  })
  .add_plugins(DefaultPlugins)

// New (Bevy 0.9)
app.add_plugins(DefaultPlugins.set(LogPlugin {
    level: Level::DEBUG,
    filter: "wgpu=error,bevy_render=info,bevy_ecs=trace".to_string(),
}))

The ImageSettings settings have been moved from a resource to ImagePlugin configuration:

// Old (Bevy 0.8)
app
  .insert_resource(ImageSettings::default_nearest())
  .add_plugins(DefaultPlugins)

// New (Bevy 0.9)
app.add_plugins(DefaultPlugins.set(ImagePlugin::default_nearest()))

The DefaultTaskPoolOptions settings have been moved from a resource to CorePlugin::task_pool_options:

// Old (Bevy 0.8)
app
  .insert_resource(DefaultTaskPoolOptions::with_num_threads(4))
  .add_plugins(DefaultPlugins)

// New (Bevy 0.9)
app.add_plugins(DefaultPlugins.set(CorePlugin {
  task_pool_options: TaskPoolOptions::with_num_threads(4),
}))

crates/bevy_log/src/lib.rs

alice-i-cecile

LGTM; I'd like to ship this in 0.9 to make the new feature more useful.

alice-i-cecile · 2022-10-25T09:57:00Z

bors r+

# Objective - Build on #6336 for more plugin configurations ## Solution - `LogSettings`, `ImageSettings` and `DefaultTaskPoolOptions` are now plugins settings rather than resources --- ## Changelog - `LogSettings` plugin settings have been move to `LogPlugin`, `ImageSettings` to `ImagePlugin` and `DefaultTaskPoolOptions` to `CorePlugin` ## Migration Guide The `LogSettings` settings have been moved from a resource to `LogPlugin` configuration: ```rust // Old (Bevy 0.8) app .insert_resource(LogSettings { level: Level::DEBUG, filter: "wgpu=error,bevy_render=info,bevy_ecs=trace".to_string(), }) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(LogPlugin { level: Level::DEBUG, filter: "wgpu=error,bevy_render=info,bevy_ecs=trace".to_string(), })) ``` The `ImageSettings` settings have been moved from a resource to `ImagePlugin` configuration: ```rust // Old (Bevy 0.8) app .insert_resource(ImageSettings::default_nearest()) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(ImagePlugin::default_nearest())) ``` The `DefaultTaskPoolOptions` settings have been moved from a resource to `CorePlugin::task_pool_options`: ```rust // Old (Bevy 0.8) app .insert_resource(DefaultTaskPoolOptions::with_num_threads(4)) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(CorePlugin { task_pool_options: TaskPoolOptions::with_num_threads(4), })) ```

bors · 2022-10-25T10:18:20Z

Build failed (retrying...):

build-without-default-features (bevy)

# Objective - Build on #6336 for more plugin configurations ## Solution - `LogSettings`, `ImageSettings` and `DefaultTaskPoolOptions` are now plugins settings rather than resources --- ## Changelog - `LogSettings` plugin settings have been move to `LogPlugin`, `ImageSettings` to `ImagePlugin` and `DefaultTaskPoolOptions` to `CorePlugin` ## Migration Guide The `LogSettings` settings have been moved from a resource to `LogPlugin` configuration: ```rust // Old (Bevy 0.8) app .insert_resource(LogSettings { level: Level::DEBUG, filter: "wgpu=error,bevy_render=info,bevy_ecs=trace".to_string(), }) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(LogPlugin { level: Level::DEBUG, filter: "wgpu=error,bevy_render=info,bevy_ecs=trace".to_string(), })) ``` The `ImageSettings` settings have been moved from a resource to `ImagePlugin` configuration: ```rust // Old (Bevy 0.8) app .insert_resource(ImageSettings::default_nearest()) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(ImagePlugin::default_nearest())) ``` The `DefaultTaskPoolOptions` settings have been moved from a resource to `CorePlugin::task_pool_options`: ```rust // Old (Bevy 0.8) app .insert_resource(DefaultTaskPoolOptions::with_num_threads(4)) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(CorePlugin { task_pool_options: TaskPoolOptions::with_num_threads(4), })) ```

bors · 2022-10-25T10:21:26Z

Build failed:

build-without-default-features (bevy)

cart · 2022-10-25T22:19:17Z

bors r+

# Objective - Build on #6336 for more plugin configurations ## Solution - `LogSettings`, `ImageSettings` and `DefaultTaskPoolOptions` are now plugins settings rather than resources --- ## Changelog - `LogSettings` plugin settings have been move to `LogPlugin`, `ImageSettings` to `ImagePlugin` and `DefaultTaskPoolOptions` to `CorePlugin` ## Migration Guide The `LogSettings` settings have been moved from a resource to `LogPlugin` configuration: ```rust // Old (Bevy 0.8) app .insert_resource(LogSettings { level: Level::DEBUG, filter: "wgpu=error,bevy_render=info,bevy_ecs=trace".to_string(), }) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(LogPlugin { level: Level::DEBUG, filter: "wgpu=error,bevy_render=info,bevy_ecs=trace".to_string(), })) ``` The `ImageSettings` settings have been moved from a resource to `ImagePlugin` configuration: ```rust // Old (Bevy 0.8) app .insert_resource(ImageSettings::default_nearest()) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(ImagePlugin::default_nearest())) ``` The `DefaultTaskPoolOptions` settings have been moved from a resource to `CorePlugin::task_pool_options`: ```rust // Old (Bevy 0.8) app .insert_resource(DefaultTaskPoolOptions::with_num_threads(4)) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(CorePlugin { task_pool_options: TaskPoolOptions::with_num_threads(4), })) ```

bors · 2022-10-25T22:33:00Z

Pull request successfully merged into main.

Build succeeded:

DGriffin91 · 2022-10-26T01:33:17Z

Is there a way to query what the default sampler is now? I had code depending on this.

mockersf · 2022-10-26T11:55:28Z

@DGriffin91 would #6372 work for you?

DGriffin91 · 2022-10-26T18:29:12Z

@mockersf Yep! Just tested it and it works great! Also got a good laugh when I hovered get_added_plugins in vs code and saw the example.

# Objective - Build on bevyengine#6336 for more plugin configurations ## Solution - `LogSettings`, `ImageSettings` and `DefaultTaskPoolOptions` are now plugins settings rather than resources --- ## Changelog - `LogSettings` plugin settings have been move to `LogPlugin`, `ImageSettings` to `ImagePlugin` and `DefaultTaskPoolOptions` to `CorePlugin` ## Migration Guide The `LogSettings` settings have been moved from a resource to `LogPlugin` configuration: ```rust // Old (Bevy 0.8) app .insert_resource(LogSettings { level: Level::DEBUG, filter: "wgpu=error,bevy_render=info,bevy_ecs=trace".to_string(), }) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(LogPlugin { level: Level::DEBUG, filter: "wgpu=error,bevy_render=info,bevy_ecs=trace".to_string(), })) ``` The `ImageSettings` settings have been moved from a resource to `ImagePlugin` configuration: ```rust // Old (Bevy 0.8) app .insert_resource(ImageSettings::default_nearest()) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(ImagePlugin::default_nearest())) ``` The `DefaultTaskPoolOptions` settings have been moved from a resource to `CorePlugin::task_pool_options`: ```rust // Old (Bevy 0.8) app .insert_resource(DefaultTaskPoolOptions::with_num_threads(4)) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(CorePlugin { task_pool_options: TaskPoolOptions::with_num_threads(4), })) ```

Update example to use new `ImagePlugin` setup for nearest rendering. See the original PR bevyengine/bevy#6360

# Objective - Build on bevyengine#6336 for more plugin configurations ## Solution - `LogSettings`, `ImageSettings` and `DefaultTaskPoolOptions` are now plugins settings rather than resources --- ## Changelog - `LogSettings` plugin settings have been move to `LogPlugin`, `ImageSettings` to `ImagePlugin` and `DefaultTaskPoolOptions` to `CorePlugin` ## Migration Guide The `LogSettings` settings have been moved from a resource to `LogPlugin` configuration: ```rust // Old (Bevy 0.8) app .insert_resource(LogSettings { level: Level::DEBUG, filter: "wgpu=error,bevy_render=info,bevy_ecs=trace".to_string(), }) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(LogPlugin { level: Level::DEBUG, filter: "wgpu=error,bevy_render=info,bevy_ecs=trace".to_string(), })) ``` The `ImageSettings` settings have been moved from a resource to `ImagePlugin` configuration: ```rust // Old (Bevy 0.8) app .insert_resource(ImageSettings::default_nearest()) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(ImagePlugin::default_nearest())) ``` The `DefaultTaskPoolOptions` settings have been moved from a resource to `CorePlugin::task_pool_options`: ```rust // Old (Bevy 0.8) app .insert_resource(DefaultTaskPoolOptions::with_num_threads(4)) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(CorePlugin { task_pool_options: TaskPoolOptions::with_num_threads(4), })) ```

# Objective PR #6360 changed `TaskPoolOptions` so it is no longer used as a Resource, but didn't remove the `Resource` derive. ## Solution Remove the Resource derive from `TaskPoolOptions`, as it is no longer needed. Also add a Debug derive, because it didn't have it before. --- ## Changelog - `TaskPoolOptions` no longer derives Resource, and `TaskPoolOptions` & `TaskPoolThreadAssignmentPolicy` now derive Debug. ## Migration Guide If for some reason anyone is still using `TaskPoolOptions` as a Resource, they would now have to use a wrapper type: ```rust #[derive(Resource)] pub struct MyTaskPoolOptions(pub TaskPoolOptions); ```

mockersf added 3 commits October 25, 2022 00:24

move LogSettings to LogPlugin setup

cb3c39a

move ImageSettings to ImagePlugin setup

29c2f0b

move DefaultTaskPoolOptions to CorePlugin setup

a049a57

alice-i-cecile added this to the Bevy 0.9 milestone Oct 24, 2022

alice-i-cecile added C-Usability A simple quality-of-life change that makes Bevy easier to use A-App Bevy apps and plugins labels Oct 24, 2022

alice-i-cecile reviewed Oct 24, 2022

View reviewed changes

crates/bevy_log/src/lib.rs Outdated Show resolved Hide resolved

alice-i-cecile approved these changes Oct 24, 2022

View reviewed changes

mockersf added 2 commits October 25, 2022 01:32

more precise allow_unused

3db0727

missed to remove a line

a281dcb

JoJoJet approved these changes Oct 25, 2022

View reviewed changes

IceSentry approved these changes Oct 25, 2022

View reviewed changes

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 Oct 25, 2022

work without default features

ea49e3e

bors bot changed the title ~~Use plugin setup for resource only used at setup time~~ [Merged by Bors] - Use plugin setup for resource only used at setup time Oct 25, 2022

bors bot closed this Oct 25, 2022

ickk added the C-Breaking-Change A breaking change to Bevy's public API that needs to be noted in a migration guide label Oct 26, 2022

mockersf added the hacktoberfest-accepted A PR that was accepted for Hacktoberfest, an annual open source event label Oct 27, 2022

alice-i-cecile mentioned this pull request Nov 3, 2022

Add display precision to log_diagnostics_plugin #6118

Open

cscorley added a commit to cscorley/bevy_pixel_camera that referenced this pull request Dec 9, 2022

Update README.md

b374dfa

Update example to use new `ImagePlugin` setup for nearest rendering. See the original PR bevyengine/bevy#6360

cscorley mentioned this pull request Dec 9, 2022

Update README.md to use new ImagePlugin setup for nearest rendering drakmaniso/bevy_pixel_camera#21

Merged

Pixelstormer mentioned this pull request Aug 18, 2023

Remove Resource and add Debug to TaskPoolOptions #9485

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Merged by Bors] - Use plugin setup for resource only used at setup time #6360

[Merged by Bors] - Use plugin setup for resource only used at setup time #6360

mockersf commented Oct 24, 2022 •

edited

alice-i-cecile left a comment

alice-i-cecile commented Oct 25, 2022

bors bot commented Oct 25, 2022

bors bot commented Oct 25, 2022

cart commented Oct 25, 2022

bors bot commented Oct 25, 2022

DGriffin91 commented Oct 26, 2022

mockersf commented Oct 26, 2022

DGriffin91 commented Oct 26, 2022

[Merged by Bors] - Use plugin setup for resource only used at setup time #6360

[Merged by Bors] - Use plugin setup for resource only used at setup time #6360

Conversation

mockersf commented Oct 24, 2022 • edited

Objective

Solution

Changelog

Migration Guide

alice-i-cecile left a comment

Choose a reason for hiding this comment

alice-i-cecile commented Oct 25, 2022

bors bot commented Oct 25, 2022

bors bot commented Oct 25, 2022

cart commented Oct 25, 2022

bors bot commented Oct 25, 2022

DGriffin91 commented Oct 26, 2022

mockersf commented Oct 26, 2022

DGriffin91 commented Oct 26, 2022

mockersf commented Oct 24, 2022 •

edited