@@ -18,6 +18,7 @@ Recommended profilers
1818- `VerySleepy <http://www.codersnotes.com/sleepy/ >`__ (Windows only)
1919- `HotSpot <https://github.com/KDAB/hotspot >`__ (Linux only)
2020- `Xcode Instruments <https://developer.apple.com/xcode/ >`__ (macOS only)
21+ - `Superluminal <https://superluminal.eu/ >`__ (Windows, Xbox, and PlayStation, requires paid license)
2122
2223These profilers may not be the most powerful or flexible options, but their
2324standalone operation and limited feature set tends to make them easier to use.
@@ -159,3 +160,38 @@ Xcode Instruments
159160- You can use the timeline at the top of the window to display details for the specific time period.
160161
161162.. image :: img/cpp_profiler_time_profiler_result.png
163+
164+ Superluminal
165+ ~~~~~~~~~~~~
166+
167+ Superluminal is a commercial profiler with many features and a special focus on game development.
168+ It has support for profiling on Windows and some console platforms.
169+
170+ While it does not have a free version, it has more advanced features that aren't available in the open source profilers.
171+
172+ Here are the steps to use it:
173+
174+ - Open Superluminal. Set the **Application ** field to the Godot executable path.
175+ Set the **Working Directory ** to the project path.
176+
177+ - Set the **Commandline Arguments ** field based on your needs. Use ``--editor `` if you want to profile
178+ the editor, for instance. You can leave it empty for profiling a running project.
179+
180+ .. image :: img/cpp_profiler_superluminal_setup_session.webp
181+
182+ - If needed, you can adjust the **Capture Options **. The defaults are usually fine.
183+ You can use this to enable child process profiling, which allows for profiling the editor
184+ and running the game from it on the same session.
185+
186+ - Click on the **Run ** button to start profiling. The software will ask for elevated privileges
187+ which are necessary to capture the information.
188+
189+ - Perform the actions you need to profile on the running process.
190+
191+ - Once done, you can close the executable, or click on the **Start Analyzing ** button (which will
192+ kill the executable process).
193+
194+ .. image :: img/cpp_profiler_superluminal_graph.webp
195+
196+ - The results will be shown on screen. For more information on how to use this, see the
197+ `Superluminal documentation <https://www.superluminal.eu/docs/documentation.html#navigating_ui >`__.
0 commit comments