diff --git a/crates/bevy_dev_tools/src/fps_overlay.rs b/crates/bevy_dev_tools/src/fps_overlay.rs index 544a347bad10c..8aab7da7b1cd7 100644 --- a/crates/bevy_dev_tools/src/fps_overlay.rs +++ b/crates/bevy_dev_tools/src/fps_overlay.rs @@ -14,6 +14,10 @@ use bevy_ui::node_bundles::TextBundle; #[derive(Default)] /// A plugin that adds an FPS overlay to the Bevy application. /// Warning: This plugin will add [`FrameTimeDiagnosticsPlugin`] if it wasn't added before. +/// +/// Note: It is recommended to use native overlay of the rendering APi when possible. You can do +/// this by: +/// - **Metal**: setting env variable `MTL_HUD_ENABLED=1` pub struct FpsOverlayPlugin { /// Starting configuration of overlay, this can be later be changed through [`FpsOverlayConfig`] resource. pub config: FpsOverlayConfig,