Prepare tracy-client 0.17.5 release

.github/workflows/test.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        rust_toolchain: [nightly, stable, 1.74.0]
+        rust_toolchain: [nightly, stable, 1.80.0]
         os: [ubuntu-latest, windows-latest, macOS-latest]
         flags: [
           "",

tracy-client/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tracy-client"
-version = "0.17.4" # AUTO-BUMP
+version = "0.17.5" # AUTO-BUMP
 authors = ["Simonas Kazlauskas <[email protected]>"]
 license.workspace = true
 edition.workspace = true

tracy-client/src/plot.rs

@@ -37,6 +37,14 @@ pub enum PlotLineStyle {
 }
 
 /// Configuration for how a plot appears in the Tracy profiling UI.
+///
+/// # Examples
+///
+/// ```
+/// # use tracy_client::PlotConfiguration;
+/// // Create a red plot line.
+/// let configuration = PlotConfiguration::default().fill(false).color(Some(0xFF0000));
+/// ```
 #[derive(Clone, PartialEq, Debug)]
 pub struct PlotConfiguration {
     /// The format of values on the plot.
@@ -72,6 +80,18 @@ impl PlotConfiguration {
     }
 
     /// Sets a custom color of the plot. A value of `None` will cause Tracy to create its own color.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// # use tracy_client::PlotConfiguration;
+    /// // Configure the plot to be red.
+    /// let red = PlotConfiguration::default().color(Some(0xFF0000));
+    /// // Configure the plot to be green.
+    /// let green = PlotConfiguration::default().color(Some(0x00FF00));
+    /// // Configure the plot to be blue.
+    /// let blue = PlotConfiguration::default().color(Some(0x0000FF));
+    /// ```
     pub fn color(mut self, color: Option<u32>) -> Self {
         self.color = color;
         self

tracy-client/src/span.rs

@@ -165,6 +165,9 @@ impl Span {
     }
 
     /// Emit a color associated with this span.
+    ///
+    /// The color is specified as RGB. It is most straightforward to specify them as hex literals
+    /// such as `0xFF0000` for red, `0x00FF00` for green or `0x0000FF` for blue.
     pub fn emit_color(&self, color: u32) {
         #[cfg(feature = "enable")]
         unsafe {