Rerun C++ SDK
Loading...
Searching...
No Matches
spawn.hpp
1// General information about the SDK.
2#pragma once
3
4#include <cstdint> // uint32_t etc.
5#include <optional>
6#include <string_view>
7
8#include "error.hpp"
9#include "spawn_options.hpp"
10
11namespace rerun {
12 /// Spawns a new Rerun Viewer process from an executable available in PATH, ready to
13 /// listen for incoming TCP connections.
14 ///
15 /// If a Rerun Viewer is already listening on this TCP port, the stream will be redirected to
16 /// that viewer instead of starting a new one.
17 ///
18 /// options:
19 /// See `rerun::SpawnOptions` for more information.
20 Error spawn(const SpawnOptions& options = {});
21} // namespace rerun
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:87
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:20
Error spawn(const SpawnOptions &options={})
Spawns a new Rerun Viewer process from an executable available in PATH, ready to listen for incoming ...
Options to control the behavior of spawn.
Definition spawn_options.hpp:17