Skip to content

Commit

Permalink
add docs about native overlay
Browse files Browse the repository at this point in the history
  • Loading branch information
matiqo15 committed Mar 9, 2024
1 parent 75a97df commit c5a733d
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions crates/bevy_dev_tools/src/fps_overlay.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit c5a733d

Please sign in to comment.