From 3483a2817153d4e96d22c4d9b149636365e7e8ea Mon Sep 17 00:00:00 2001
From: Daniel McNab <36049421+DJMcNab@users.noreply.github.com>
Date: Fri, 20 Sep 2024 17:12:13 +0100
Subject: [PATCH] Remove wgpu-profiler from our "public" API

The API is still there, but it is directly documented as unsupported.
---
 vello/Cargo.toml | 17 +++++++++++++++--
 vello/src/lib.rs |  8 +++++++-
 2 files changed, 22 insertions(+), 3 deletions(-)

diff --git a/vello/Cargo.toml b/vello/Cargo.toml
index ed9859a5..abac18f9 100644
--- a/vello/Cargo.toml
+++ b/vello/Cargo.toml
@@ -16,11 +16,24 @@ default = ["wgpu"]
 # bump-allocated GPU memory.
 # TODO: Turn this into a runtime option used at resolve time and remove the feature.
 bump_estimate = ["vello_encoding/bump_estimate"]
-hot_reload = ["vello_shaders/compile"]
+# Adds labels to buffers created by Vello.
+# May improve debugability at the cost of slightly higher memory usage (TODO: We should just not make these optional).
 buffer_labels = []
-debug_layers = []
 wgpu = ["dep:wgpu"]
+
+# Development only features
+
+# Enables debug features when using the "async" pipeline.
+# This is only intended for development of Vello itself.
+debug_layers = []
+# Enables an embedded wgpu-profiler profiler.
+# This is only intended for development of Vello itself.
+# It is currently known to not work - see https://github.com/linebender/vello/issues/678
 wgpu-profiler = ["dep:wgpu-profiler"]
+# Enables hot reloading of Vello shaders.
+# This is only intended for development of Vello itself.
+# In practise, this won't compile outside of the Vello repository.
+hot_reload = ["vello_shaders/compile"]
 
 [lints]
 workspace = true
diff --git a/vello/src/lib.rs b/vello/src/lib.rs
index 336b3ff8..d8e7f116 100644
--- a/vello/src/lib.rs
+++ b/vello/src/lib.rs
@@ -229,11 +229,13 @@ pub enum Error {
     /// See [`wgpu_profiler::CreationError`] for more information.
     #[cfg(feature = "wgpu-profiler")]
     #[error("Couldn't create wgpu profiler")]
+    #[doc(hidden)] // End-users of Vello should not have `wgpu-profiler` enabled.
     ProfilerCreationError(#[from] wgpu_profiler::CreationError),
 
     /// Failed to compile the shaders.
     #[cfg(feature = "hot_reload")]
     #[error("Failed to compile shaders:\n{0}")]
+    #[doc(hidden)] // End-users of Vello should not have `hot_reload` enabled.
     ShaderCompilation(#[from] vello_shaders::compile::ErrorVec),
 }
 
@@ -253,8 +255,12 @@ pub struct Renderer {
     debug: Option<debug::DebugRenderer>,
     target: Option<TargetTexture>,
     #[cfg(feature = "wgpu-profiler")]
+    #[doc(hidden)] // End-users of Vello should not have `wgpu-profiler` enabled.
+    /// The profiler used with events for this renderer. This is *not* treated as public API.
     pub profiler: GpuProfiler,
     #[cfg(feature = "wgpu-profiler")]
+    #[doc(hidden)] // End-users of Vello should not have `wgpu-profiler` enabled.
+    /// The results from profiling. This is *not* treated as public API.
     pub profile_result: Option<Vec<wgpu_profiler::GpuTimerQueryResult>>,
 }
 // This is not `Send` (or `Sync`) on WebAssembly as the
@@ -350,7 +356,6 @@ impl Renderer {
             #[cfg(feature = "debug_layers")]
             debug,
             target: None,
-            // Use 3 pending frames
             #[cfg(feature = "wgpu-profiler")]
             profiler: GpuProfiler::new(GpuProfilerSettings {
                 ..Default::default()
@@ -486,6 +491,7 @@ impl Renderer {
 
     /// Reload the shaders. This should only be used during `vello` development
     #[cfg(feature = "hot_reload")]
+    #[doc(hidden)] // End-users of Vello should not have `hot_reload` enabled.
     pub async fn reload_shaders(&mut self, device: &Device) -> Result<(), Error> {
         device.push_error_scope(wgpu::ErrorFilter::Validation);
         let mut engine = WgpuEngine::new(self.options.use_cpu);