Files
phy/search.desc/iyes_perf_ui/iyes_perf_ui-desc-0-.js
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

1 line
12 KiB
JavaScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

searchState.loadedDescShard("iyes_perf_ui", 0, "Customizable Performance/Debug Overlay for Bevy UI\nAbsolute positioning based on distance from bottom and …\nAbsolute positioning based on distance from bottom and …\nExtension trait for adding new types of Perf UI Entries.\nBundle for a Perf UI with all entry types provided by …\nTrait for components representing entries (rows) in the …\nThe Bevy Plugin\nWhich corner of the screen to display the Perf UI at?\nComponent to configure a Perf UI instance.\nSystem Set to allow you to order things relative to our …\nSystems that manage (spawn) the Perf UI entity hierarchy.\nAny system parameters you need to fetch/update the value.\nAbsolute positioning based on distance from top and left …\nAbsolute positioning based on distance from top and right …\nSystems that update the values of Perf UI entries (of any …\nThe raw (unformatted) type of the value to be displayed.\nAdd support for a custom perf UI entry type (component).\nThe color to use for the background of the Perf UI.\nThe color to use for entries that do not provide a custom …\nPerf UI Entries based on Bevy Diagnostics\nShould labels be displayed? If false, there will be no …\nThe color for the error text.\nThe font to use for highlighted values.\nThe font to use for labels.\nThe font to use for values.\nThe font size for labels.\nThe font size for values.\nFormat the raw value into a string for display\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nThe color to use for the background of each entry/row.\nThe color to use for the background of highlighted entries.\nEmpty space around entries (rows) in pixels\nEmpty space around the text in every row\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nThe label text to display in the Perf UI.\nThe color to use for label text.\nDisplay entries horizontally instead of vertically.\nDistance from the edge of the screen in pixels\nEmpty space around the edge of the Perf UI\nThe position of the UI.\nPrelude of common types for users of the library\nThe sort key controls where the entry will appear in the …\nThe text to display if a value cannot be obtained.\nPerf UI Entries for displaying the current time.\nSystem that updates the values of Perf UI entries of a …\nUpdate the value to display in the Perf UI.\nHelper functions\nOptional: set a custom color for the value to display.\nOptional: set whether the value should be displayed using …\nForce a fixed width (in pixels) for the values column\nOptional: provide a desired width for the value string.\nPerf UI Entries for info about application windows.\nThe ZIndex of the UI.\nPerf UI Entry to display Bevys built-in CPU Usage …\nPerf UI Entry to display Bevys built-in ECS entity …\nPerf UI Entry to display Bevys built-in FPS measurement …\nPerf UI Entry to display Bevys built-in FPS measurement …\nPerf UI Entry to display Bevys built-in frame counter.\nPerf UI Entry to display Bevys built-in frame time …\nPerf UI Entry to display Bevys built-in frame time …\nPerf UI Entry to display Bevys built-in Memory (RAM) …\nEnable color based on value.\nEnable color based on value.\nEnable color based on value.\nEnable color based on value.\nEnable color based on value.\nEnable color based on value.\nEnable color based on value.\nNumber of digits to display for the integer (whole number) …\nNumber of digits to display for the integer (whole number) …\nNumber of digits to display for the integer (whole number) …\nNumber of digits to display for the integer (whole number) …\nNumber of digits to display.\nNumber of digits to display.\nDisplay the unit (“ms”) alongside the number.\nDisplay the unit (“ms”) alongside the number.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCustom label. If empty (default), the default label will …\nCustom label. If empty (default), the default label will …\nCustom label. If empty (default), the default label will …\nCustom label. If empty (default), the default label will …\nCustom label. If empty (default), the default label will …\nCustom label. If empty (default), the default label will …\nCustom label. If empty (default), the default label will …\nCustom label. If empty (default), the default label will …\nNumber of digits to display for the fractional (after the …\nNumber of digits to display for the fractional (after the …\nNumber of digits to display for the fractional (after the …\nNumber of digits to display for the fractional (after the …\nNumber of digits to display for the fractional (after the …\nNumber of digits to display for the fractional (after the …\nShould we display the smoothed value or the raw value?\nShould we display the smoothed value or the raw value?\nShould we display the smoothed value or the raw value?\nShould we display the smoothed value or the raw value?\nSort Key (control where the entry will appear in the Perf …\nSort Key (control where the entry will appear in the Perf …\nSort Key (control where the entry will appear in the Perf …\nSort Key (control where the entry will appear in the Perf …\nSort Key (control where the entry will appear in the Perf …\nSort Key (control where the entry will appear in the Perf …\nSort Key (control where the entry will appear in the Perf …\nSort Key (control where the entry will appear in the Perf …\nHighlight the value if FPS is below this threshold.\nHighlight the value if FPS is below this threshold.\nHighlight the value if frame time is above this threshold.\nHighlight the value if frame time is above this threshold.\nHighlight the value if above this threshold.\nHighlight the value if above this threshold.\nHighlight the value if above this threshold.\nPerf UI Entry to display the wall clock / current time of …\nPerf UI Entry to display Bevys Fixed Time overstep.\nPerf UI Entry to display Bevys Fixed Time Step duration.\nPerf UI Entry to display the time the Bevy app has been …\nDisplay it as a rate in Hz instead of duration in …\nDisplay it as a percentage of the timestep instead of …\nNumber of digits to display for the integer (whole number) …\nNumber of digits to display for the integer (whole number) …\nNumber of digits to display for the integer (whole number) …\nDisplay the unit (“s”) alongside the number.\nDisplay the unit (“ms” or “Hz”) alongside the …\nDisplay the unit (“ms” or “%”) alongside the …\nIf true, format time as HH:MM:SS (with optional fractional …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCustom label. If empty (default), the default label will …\nCustom label. If empty (default), the default label will …\nCustom label. If empty (default), the default label will …\nCustom label. If empty (default), the default label will …\nNumber of digits to display for the fractional (after the …\nNumber of digits to display for the fractional (after the …\nNumber of digits to display for the fractional (after the …\nNumber of digits to display for the fractional (after the …\nIf true, time will be displayed in UTC and not the local …\nSort Key (control where the entry will appear in the Perf …\nSort Key (control where the entry will appear in the Perf …\nSort Key (control where the entry will appear in the Perf …\nSort Key (control where the entry will appear in the Perf …\nIf set, count time relative to this. If unset, count time …\nRepresents a color gradient with any number of stops.\nAdd a stop to the gradient.\nAdd multiple stops to the gradient.\nFormat a float in a pretty way.\nFormat an integer in a pretty way.\nFormat a time duration in a pretty way.\nFormat time (provided as hours, minutes, seconds, …\nReturns the argument unchanged.\nPerform the actual interpolation. Return a color for the …\nCalls <code>U::from(self)</code>.\nCreate a new empty gradient.\nPreset constructor: Green-Yellow-Red between the specified …\nPreset constructor: Red-Yellow-Green between the specified …\nGenerate a new incrementally-increasing sort key.\nCreate a “gradient” with only one color.\nWidth hint for a value formatted with <code>format_pretty_float</code>\nWidth hint for a value formatted with <code>format_pretty_int</code>\nWidth hint for a value formatted with <code>format_pretty_time</code>/…\nAdd a stop to the gradient (builder-style API).\nAdd multiple stops to the gradient (builder-style API).\nPerf UI Entry to display the current coordinates of the …\nPerf UI Entry to display the window mode (windowed, …\nPerf UI Entry to display the window present mode (vsync).\nPerf UI Entry to display the window size / resolution.\nPerf UI Entry to display the window size / resolution.\nNumber of digits to display for the integer (whole number) …\nDisplay the axis (“X”/“Y”) alongside the numbers.\nDisplay the axis (“X”/“Y”) alongside the numbers.\nDisplay the unit (“px”) alongside the numbers.\nDisplay the unit (“px”) alongside the numbers.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCustom label. If empty (default), the default label will …\nCustom label. If empty (default), the default label will …\nCustom label. If empty (default), the default label will …\nCustom label. If empty (default), the default label will …\nCustom label. If empty (default), the default label will …\nDisplay the physical pixel coordinates instead of the …\nDisplay the physical pixel coordinates instead of the …\nNumber of digits to display for the fractional (after the …\nNumber of digits to display for the fractional (after the …\nNumber of digits to display for the fractional (after the …\nSeparate the X and Y values by this string.\nSeparate the X and Y values by this string.\nSort Key (control where the entry will appear in the Perf …\nSort Key (control where the entry will appear in the Perf …\nSort Key (control where the entry will appear in the Perf …\nSort Key (control where the entry will appear in the Perf …\nSort Key (control where the entry will appear in the Perf …\nFormat the value string so that there is always space for …\nFormat the value string so that there is always space for …\nDisplay the value from the specified window (in a …\nDisplay the value from the specified window (in a …\nDisplay the value from the specified window (in a …\nDisplay the value from the specified window (in a …\nDisplay the value from the specified window (in a …")