Document supported platforms for RenderStatisticsPlugin

bevyengine · Jul 14, 2023 · 8e2fd35 · 8e2fd35
1 parent e666107
commit 8e2fd35
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/crates/bevy_render/src/renderer/statistics.rs b/crates/bevy_render/src/renderer/statistics.rs
@@ -26,6 +26,10 @@ const TIMESTAMP_SIZE: u64 = 8;
 const PIPELINE_STATISTICS_SIZE: u64 = 40;
 
 /// Enables collecting render pass statistics into [`RenderStatistics`] resource.
+///
+/// # Supported platforms
+/// Timestamp queries and pipeline statistics are currently supported only on Vulkan and DX12.
+/// On other platforms (Metal, WebGPU, WebGL2) only CPU time will be recorded.
 #[derive(Default)]
 pub struct RenderStatisticsPlugin;