Rerun C++ SDK
Loading...
Searching...
No Matches
sdk_info.hpp
1// General information about the SDK.
2#pragma once
3
4#include "c/sdk_info.h"
5#include "error.hpp"
6
7namespace rerun {
8 /// Returns a human-readable version string of the Rerun C SDK.
9 ///
10 /// This should match the string in `RERUN_SDK_HEADER_VERSION`.
11 /// If not, the SDK's binary and the C++ headers are out of sync.
12 const char* version_string();
13
14 /// Internal check whether the version reported by the rerun_c binary matches `sdk_version_string`.
15 ///
16 /// This method is called on various C++ API entry points, calling `Error::handle` on the return value.
17 /// There is no need to call this method yourself unless you want to ensure that rerun_c binary and
18 /// rerun_c header versions match ahead of time.
20} // namespace rerun
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:91
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:22
Error check_binary_and_header_version_match()
Internal check whether the version reported by the rerun_c binary matches sdk_version_string.
const char * version_string()
Returns a human-readable version string of the Rerun C SDK.