mirror of
https://github.com/bevyengine/bevy
synced 2024-11-22 12:43:34 +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.
37 lines
1.3 KiB
Rust
37 lines
1.3 KiB
Rust
//! This example illustrates how to create a custom diagnostic.
|
|
|
|
use bevy::{
|
|
diagnostic::{Diagnostic, DiagnosticId, Diagnostics, LogDiagnosticsPlugin},
|
|
prelude::*,
|
|
};
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
// The "print diagnostics" plugin is optional.
|
|
// It just visualizes our diagnostics in the console.
|
|
.add_plugin(LogDiagnosticsPlugin::default())
|
|
.add_startup_system(setup_diagnostic_system)
|
|
.add_system(my_system)
|
|
.run();
|
|
}
|
|
|
|
// All diagnostics should have a unique DiagnosticId.
|
|
// For each new diagnostic, generate a new random number.
|
|
pub const SYSTEM_ITERATION_COUNT: DiagnosticId =
|
|
DiagnosticId::from_u128(337040787172757619024841343456040760896);
|
|
|
|
fn setup_diagnostic_system(mut diagnostics: ResMut<Diagnostics>) {
|
|
// Diagnostics must be initialized before measurements can be added.
|
|
// In general it's a good idea to set them up in a "startup system".
|
|
diagnostics.add(Diagnostic::new(
|
|
SYSTEM_ITERATION_COUNT,
|
|
"system_iteration_count",
|
|
10,
|
|
));
|
|
}
|
|
|
|
fn my_system(mut diagnostics: ResMut<Diagnostics>) {
|
|
// Add a measurement of 10.0 for our diagnostic each time this system runs.
|
|
diagnostics.add_measurement(SYSTEM_ITERATION_COUNT, 10.0);
|
|
}
|