Rerun C++ SDK
|
Options to control the behavior of spawn
.
More...
#include <rerun/spawn_options.hpp>
Public Attributes | |
uint16_t | port = 9876 |
The port to listen on. | |
std::string_view | memory_limit = "75%" |
An upper limit on how much memory the Rerun Viewer should use. | |
std::string_view | server_memory_limit = "0B" |
An upper limit on how much memory the gRPC server running in the same process as the Rerun Viewer should use. | |
bool | hide_welcome_screen = false |
Hide the normal Rerun welcome screen. | |
bool | detach_process = true |
Detach Rerun Viewer process from the application process. | |
std::string_view | executable_name = "rerun" |
Specifies the name of the Rerun executable. | |
std::string_view | executable_path |
Enforce a specific executable to use instead of searching though PATH for SpawnOptions::executable_name . | |
Options to control the behavior of spawn
.
Refer to the field-level documentation for more information about each individual options.
The defaults are ok for most use cases.
Keep this in sync with rerun.h's rr_spawn_options
.
std::string_view rerun::SpawnOptions::memory_limit = "75%" |
An upper limit on how much memory the Rerun Viewer should use.
When this limit is reached, Rerun will drop the oldest data. Example: 16GB
or 50%
(of system total).
Defaults to 75%
if unset.
std::string_view rerun::SpawnOptions::server_memory_limit = "0B" |
An upper limit on how much memory the gRPC server running in the same process as the Rerun Viewer should use.
When this limit is reached, Rerun will drop the oldest data. Example: 16GB
or 50%
(of system total).
Defaults to 0B
.
bool rerun::SpawnOptions::hide_welcome_screen = false |
Hide the normal Rerun welcome screen.
Defaults to false
if unset.
bool rerun::SpawnOptions::detach_process = true |
Detach Rerun Viewer process from the application process.
Defaults to true
if unset.
std::string_view rerun::SpawnOptions::executable_name = "rerun" |
Specifies the name of the Rerun executable.
You can omit the .exe
suffix on Windows.
Defaults to rerun
if unset.