Skip to content

Commit c5a733d

Browse files
committed
add docs about native overlay
1 parent 75a97df commit c5a733d

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

crates/bevy_dev_tools/src/fps_overlay.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ use bevy_ui::node_bundles::TextBundle;
1414
#[derive(Default)]
1515
/// A plugin that adds an FPS overlay to the Bevy application.
1616
/// 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`
1721
pub struct FpsOverlayPlugin {
1822
/// Starting configuration of overlay, this can be later be changed through [`FpsOverlayConfig`] resource.
1923
pub config: FpsOverlayConfig,

0 commit comments

Comments
 (0)