We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 75a97df commit c5a733dCopy full SHA for c5a733d
crates/bevy_dev_tools/src/fps_overlay.rs
@@ -14,6 +14,10 @@ use bevy_ui::node_bundles::TextBundle;
14
#[derive(Default)]
15
/// A plugin that adds an FPS overlay to the Bevy application.
16
/// Warning: This plugin will add [`FrameTimeDiagnosticsPlugin`] if it wasn't added before.
17
+///
18
+/// Note: It is recommended to use native overlay of the rendering APi when possible. You can do
19
+/// this by:
20
+/// - **Metal**: setting env variable `MTL_HUD_ENABLED=1`
21
pub struct FpsOverlayPlugin {
22
/// Starting configuration of overlay, this can be later be changed through [`FpsOverlayConfig`] resource.
23
pub config: FpsOverlayConfig,
0 commit comments