Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
matiqo15 committed Mar 9, 2024
1 parent c5a733d commit 88e3658
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion crates/bevy_dev_tools/src/fps_overlay.rs
Expand Up @@ -15,9 +15,10 @@ use bevy_ui::node_bundles::TextBundle;
/// 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
/// 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`
/// - **Vulkan** (specific to linux, requires Vulkan Mesa layers): `VK_INSTANCE_LAYERS='VK_LAYER_MESA_overlay'`
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 88e3658

Please sign in to comment.