Skip to content

Add instructions for profiling with Superluminal #11496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+36 −0
Open

Add instructions for profiling with Superluminal #11496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added engine_details/development/debugging/img/cpp_profiler_superluminal_graph.webp
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ..._details/development/debugging/img/cpp_profiler_superluminal_setup_session.webp
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions engine_details/development/debugging/using_cpp_profilers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Recommended profilers
- `VerySleepy <http://www.codersnotes.com/sleepy/>`__ (Windows only)
- `HotSpot <https://github.com/KDAB/hotspot>`__ (Linux only)
- `Xcode Instruments <https://developer.apple.com/xcode/>`__ (macOS only)
- `Superluminal <https://superluminal.eu/>`__ (Windows, Xbox, and PlayStation)
Copy link
Member

@AThousandShips AThousandShips Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure we should list this under "recommended profilers" as it isn't free

Copy link
Member

@Calinou Calinou Nov 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's fine to keep in the same list for conciseness' sake, but I would add a mention that it's paid:

Suggested change
- `Superluminal <https://superluminal.eu/>`__ (Windows, Xbox, and PlayStation)
- `Superluminal <https://superluminal.eu/>`__ (Windows, Xbox, and PlayStation, requires paid license)


These profilers may not be the most powerful or flexible options, but their
standalone operation and limited feature set tends to make them easier to use.
Expand Down Expand Up @@ -159,3 +160,38 @@ Xcode Instruments
- You can use the timeline at the top of the window to display details for the specific time period.

.. image:: img/cpp_profiler_time_profiler_result.png

Superluminal
~~~~~~~~~~~~

Superluminal is a commercial profiler with many features and a special focus on game development.
It has support for profiling on Windows, Xbox One® and Xbox Series X®, PlayStation® 4 and PlayStation® 5.
Copy link
Member

@AThousandShips AThousandShips Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It has support for profiling on Windows, Xbox One® and Xbox Series X®, PlayStation® 4 and PlayStation® 5.
It has support for profiling on Windows, Xbox One, Xbox Series X, PlayStation 4, and PlayStation 5.

We don't use the trademark symbol elsewhere and it doesn't make much sense to use it here I'd say

Copy link
Member

@Calinou Calinou Nov 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additionally, since Godot itself does not officially support consoles, it may not be worth listing console platforms here.

Copy link
Member Author

@vnen vnen Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay. Maybe I can add "some console platforms" for completeness? I think it's relevant even if consoles are not officially supported, because you can (in some ways) port for consoles.


While it does not have a free version, it has more advanced features that aren't available in the open source profilers.

Here are the steps to use it:

- Open Superluminal. Set the **Application** field to the Godot executable path.
Set the **Working Directory** to the project path.

- Set the **Commandline Arguments** field based on your needs. Use ``--editor`` if you want to profile
the editor, for instance. You can leave it empty for profiling a running project.

.. image:: img/cpp_profiler_superluminal_setup_session.webp

- If needed, you can adjust the **Capture Options**. The defaults are usually fine.
You can use this to enable child process profiling, which allows for profiling the editor
and running the game from it on the same session.

- Click on the **Run** button to start profiling. The software will ask for elevated privileges
which are necessary to capture the information.

- Perform the actions you need to profile on the running process.

- Once done, you can close the executable, or click on the **Start Analyzing** button (which will
kill the executable process).

.. image:: img/cpp_profiler_superluminal_graph.webp

- The results will be shown on screen. For more information on how to use this, see the
`Superluminal documentation <https://www.superluminal.eu/docs/documentation.html#navigating_ui>`__.