Rerun C++ SDK
Loading...
Searching...
No Matches
rerun.hpp
1#pragma once
2
3// Built-in Rerun types (largely generated from an interface definition language)
4#include "rerun/archetypes.hpp"
5#include "rerun/components.hpp"
6#include "rerun/datatypes.hpp"
7
8// Rerun API.
9#include "rerun/collection.hpp"
10#include "rerun/collection_adapter.hpp"
11#include "rerun/collection_adapter_builtins.hpp"
12#include "rerun/component_descriptor.hpp"
13#include "rerun/config.hpp"
14#include "rerun/entity_path.hpp"
15#include "rerun/error.hpp"
16#include "rerun/image_utils.hpp"
17#include "rerun/recording_stream.hpp"
18#include "rerun/result.hpp"
19#include "rerun/sdk_info.hpp"
20#include "rerun/spawn.hpp"
21
22/// All Rerun C++ types and functions are in the `rerun` namespace or one of its nested namespaces.
23namespace rerun {
24 /// When an external [`DataLoader`] is asked to load some data that it doesn't know how to load, it
25 /// should exit with this exit code.
26 // NOTE: Always keep in sync with other languages.
28
29 // Archetypes are the quick-and-easy default way of logging data to Rerun.
30 // Make them available in the rerun namespace.
31 using namespace archetypes;
32
33 // Also import any component or datatype that has a unique name:
47 using components::Text;
53
54 using datatypes::Angle;
70 using datatypes::Vec2D;
71 using datatypes::Vec3D;
72 using datatypes::Vec4D;
73
74 // Document namespaces that span several files:
75
76 /// All built-in archetypes. See [Types](https://www.rerun.io/docs/reference/types) in the Rerun manual.
77 namespace archetypes {}
78
79 /// All built-in components. See [Types](https://www.rerun.io/docs/reference/types) in the Rerun manual.
80 namespace components {}
81
82 /// All built-in datatypes. See [Types](https://www.rerun.io/docs/reference/types) in the Rerun manual.
83 namespace datatypes {}
84
85 /// All blueprint types. This is still experimental and subject to change!
86 namespace blueprint {}
87} // namespace rerun
TransformRelation
Component: Specifies relation a spatial transform describes.
Definition transform_relation.hpp:25
FillMode
Component: How a geometric shape is drawn and colored.
Definition fill_mode.hpp:25
PixelFormat
Datatype: Specifieds a particular format of an archetypes::Image.
Definition pixel_format.hpp:35
ColorModel
Datatype: Specified what color components are present in an archetypes::Image.
Definition color_model.hpp:27
ChannelDatatype
Datatype: The innermost datatype of an image.
Definition channel_datatype.hpp:27
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:23
const int EXTERNAL_DATA_LOADER_INCOMPATIBLE_EXIT_CODE
When an external [DataLoader] is asked to load some data that it doesn't know how to load,...
Definition rerun.hpp:27
Component: A color multiplier, usually applied to a whole entity, e.g. a mesh.
Definition albedo_factor.hpp:15
Component: An RGBA color with unmultiplied/separate alpha, in sRGB gamma space with linear alpha.
Definition color.hpp:18
Component: A geospatial line string expressed in EPSG:4326 latitude and longitude (North/East-positiv...
Definition geo_line_string.hpp:22
Component: Half-size (radius) of a 2D box.
Definition half_size2d.hpp:21
Component: Half-size (radius) of a 3D box.
Definition half_size3d.hpp:21
Component: A geospatial position expressed in EPSG:4326 latitude and longitude (North/East-positive d...
Definition lat_lon.hpp:16
Component: A line strip in 2D space.
Definition line_strip2d.hpp:34
Component: A line strip in 3D space.
Definition line_strip3d.hpp:34
Component: A standardized media type (RFC2046, formerly known as MIME types), encoded as a string.
Definition media_type.hpp:21
Component: A position in 2D space.
Definition position2d.hpp:16
Component: A position in 3D space.
Definition position3d.hpp:16
Component: The radius of something, e.g.
Definition radius.hpp:22
Component: The severity level of a text log message.
Definition text_log_level.hpp:26
Component: A string of text, e.g. for labels and text documents.
Definition text.hpp:17
Component: The three indices of a triangle in a triangle mesh.
Definition triangle_indices.hpp:16
Component: A vector in 2D space.
Definition vector2d.hpp:16
Component: A vector in 3D space.
Definition vector3d.hpp:16
Datatype: Angle in radians.
Definition angle.hpp:25
Datatype: Annotation info annotating a class id or key-point id.
Definition annotation_info.hpp:26
Datatype: The description of a semantic Class.
Definition class_description.hpp:36
Datatype: A double-precision vector in 2D space.
Definition dvec2d.hpp:21
Datatype: A single-precision 32-bit IEEE 754 floating point number.
Definition float32.hpp:25
Datatype: A connection between two datatypes::KeypointIds.
Definition keypoint_pair.hpp:21
Datatype: A 3x3 Matrix.
Definition mat3x3.hpp:32
Datatype: A Quaternion represented by 4 real numbers.
Definition quaternion.hpp:25
Datatype: An RGBA color with unmultiplied/separate alpha, in sRGB gamma space with linear alpha.
Definition rgba32.hpp:28
Datatype: 3D rotation represented by a rotation around a given axis.
Definition rotation_axis_angle.hpp:22
Datatype: The underlying storage for archetypes::Tensor.
Definition tensor_buffer.hpp:99
Datatype: An N-dimensional array of numbers.
Definition tensor_data.hpp:30
Datatype: A single dimension within a multi-dimensional tensor.
Definition tensor_dimension.hpp:22
Datatype: A vector in 2D space.
Definition vec2d.hpp:21
Datatype: A vector in 3D space.
Definition vec3d.hpp:21
Datatype: A vector in 4D space.
Definition vec4d.hpp:21