mirror of
https://github.com/bevyengine/bevy
synced 2024-11-26 14:40:19 +00:00
1ba7429371
# Objective Provide a starting point for #3951, or a partial solution. Providing a few comment blocks to discuss, and hopefully find better one in the process. ## Solution Since I am pretty new to pretty much anything in this context, I figured I'd just start with a draft for some file level doc blocks. For some of them I found more relevant details (or at least things I considered interessting), for some others there is less. ## Changelog - Moved some existing comments from main() functions in the 2d examples to the file header level - Wrote some more comment blocks for most other 2d examples TODO: - [x] 2d/sprite_sheet, wasnt able to come up with something good yet - [x] all other example groups... Also: Please let me know if the commit style is okay, or to verbose. I could certainly squash these things, or add more details if needed. I also hope its okay to raise this PR this early, with just a few files changed. Took me long enough and I dont wanted to let it go to waste because I lost motivation to do the whole thing. Additionally I am somewhat uncertain over the style and contents of the commets. So let me know what you thing please.
21 lines
855 B
Rust
21 lines
855 B
Rust
//! Shows different built-in plugins that logs diagnostics, like frames per second (FPS), to the console.
|
|
|
|
use bevy::{
|
|
diagnostic::{FrameTimeDiagnosticsPlugin, LogDiagnosticsPlugin},
|
|
prelude::*,
|
|
};
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
// Adds frame time diagnostics
|
|
.add_plugin(FrameTimeDiagnosticsPlugin::default())
|
|
// Adds a system that prints diagnostics to the console
|
|
.add_plugin(LogDiagnosticsPlugin::default())
|
|
// Any plugin can register diagnostics
|
|
// Uncomment this to add an entity count diagnostics:
|
|
// .add_plugin(bevy::diagnostic::EntityCountDiagnosticsPlugin::default())
|
|
// Uncomment this to add an asset count diagnostics:
|
|
// .add_plugin(bevy::asset::diagnostic::AssetCountDiagnosticsPlugin::<Texture>::default())
|
|
.run();
|
|
}
|