From aadc4db3488e06afb39771039228842b653b77e5 Mon Sep 17 00:00:00 2001 From: Mateusz Wachowiak Date: Sat, 9 Mar 2024 14:23:46 +0100 Subject: [PATCH] fix doc --- crates/bevy_dev_tools/src/fps_overlay.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/crates/bevy_dev_tools/src/fps_overlay.rs b/crates/bevy_dev_tools/src/fps_overlay.rs index 8aab7da7b1cd7..e09b62c02ecfa 100644 --- a/crates/bevy_dev_tools/src/fps_overlay.rs +++ b/crates/bevy_dev_tools/src/fps_overlay.rs @@ -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,