File tree Expand file tree Collapse file tree
crates/bevy_dev_tools/src Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -15,9 +15,10 @@ use bevy_ui::node_bundles::TextBundle;
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.
1717///
18- /// Note: It is recommended to use native overlay of the rendering APi when possible. You can do
18+ /// Note: It is recommended to use native overlay of the rendering `API` when possible. You can do
1919/// this by:
2020/// - **Metal**: setting env variable `MTL_HUD_ENABLED=1`
21+ /// - **Vulkan** (specific to linux, requires Vulkan Mesa layers): `VK_INSTANCE_LAYERS='VK_LAYER_MESA_overlay'`
2122pub struct FpsOverlayPlugin {
2223 /// Starting configuration of overlay, this can be later be changed through [`FpsOverlayConfig`] resource.
2324 pub config : FpsOverlayConfig ,
You can’t perform that action at this time.
0 commit comments