diff --git a/crates/build/re_types_builder/src/codegen/docs/mod.rs b/crates/build/re_types_builder/src/codegen/docs/mod.rs index ba286b2353bf..d94ff4d828c2 100644 --- a/crates/build/re_types_builder/src/codegen/docs/mod.rs +++ b/crates/build/re_types_builder/src/codegen/docs/mod.rs @@ -488,9 +488,10 @@ fn write_fields(objects: &Objects, o: &mut String, object: &Object) { if let Some(enum_value) = field.enum_value { field_string.push_str(&format!(" = {enum_value}")); } + field_string.push('\n'); if !object.is_enum() { - field_string.push_str(": "); + field_string.push_str("Type: "); if field.typ == Type::Unit { field_string.push_str("`null`"); } else { @@ -499,9 +500,10 @@ fn write_fields(objects: &Objects, o: &mut String, object: &Object) { } field_string.push_str(&type_info(objects, &field.typ)); } + field_string.push('\n'); + field_string.push('\n'); } - field_string.push('\n'); for line in field.docs.lines_for(objects, Target::WebDocsMarkdown) { field_string.push_str(&line); field_string.push('\n'); diff --git a/docs/content/reference/types/datatypes/annotation_info.md b/docs/content/reference/types/datatypes/annotation_info.md index e6842e3a5d1a..c8e36d0b5dd5 100644 --- a/docs/content/reference/types/datatypes/annotation_info.md +++ b/docs/content/reference/types/datatypes/annotation_info.md @@ -9,13 +9,19 @@ Color and label will be used to annotate entities/keypoints which reference the The id refers either to a class or key-point id ## Fields -#### `id`: `uint16` +#### `id` +Type: `uint16` + [`datatypes.ClassId`](https://rerun.io/docs/reference/types/datatypes/class_id) or [`datatypes.KeypointId`](https://rerun.io/docs/reference/types/datatypes/keypoint_id) to which this annotation info belongs. -#### `label`: nullable [`Utf8`](../datatypes/utf8.md) +#### `label` +Type: nullable [`Utf8`](../datatypes/utf8.md) + The label that will be shown in the UI. -#### `color`: nullable [`Rgba32`](../datatypes/rgba32.md) +#### `color` +Type: nullable [`Rgba32`](../datatypes/rgba32.md) + The color that will be applied to the annotated entity. diff --git a/docs/content/reference/types/datatypes/class_description.md b/docs/content/reference/types/datatypes/class_description.md index cd00bea72831..d68ddd30b91c 100644 --- a/docs/content/reference/types/datatypes/class_description.md +++ b/docs/content/reference/types/datatypes/class_description.md @@ -19,13 +19,19 @@ keypoints should be connected with an edge. The edge should be labeled and colored as described by the class's [`datatypes.AnnotationInfo`](https://rerun.io/docs/reference/types/datatypes/annotation_info). ## Fields -#### `info`: [`AnnotationInfo`](../datatypes/annotation_info.md) +#### `info` +Type: [`AnnotationInfo`](../datatypes/annotation_info.md) + The [`datatypes.AnnotationInfo`](https://rerun.io/docs/reference/types/datatypes/annotation_info) for the class. -#### `keypoint_annotations`: List of [`AnnotationInfo`](../datatypes/annotation_info.md) +#### `keypoint_annotations` +Type: List of [`AnnotationInfo`](../datatypes/annotation_info.md) + The [`datatypes.AnnotationInfo`](https://rerun.io/docs/reference/types/datatypes/annotation_info) for all of the keypoints. -#### `keypoint_connections`: List of [`KeypointPair`](../datatypes/keypoint_pair.md) +#### `keypoint_connections` +Type: List of [`KeypointPair`](../datatypes/keypoint_pair.md) + The connections between keypoints. diff --git a/docs/content/reference/types/datatypes/class_description_map_elem.md b/docs/content/reference/types/datatypes/class_description_map_elem.md index 3bb52b78e626..f8a2991f761c 100644 --- a/docs/content/reference/types/datatypes/class_description_map_elem.md +++ b/docs/content/reference/types/datatypes/class_description_map_elem.md @@ -8,10 +8,14 @@ A helper type for mapping [`datatypes.ClassId`](https://rerun.io/docs/reference/ This is internal to [`components.AnnotationContext`](https://rerun.io/docs/reference/types/components/annotation_context). ## Fields -#### `class_id`: [`ClassId`](../datatypes/class_id.md) +#### `class_id` +Type: [`ClassId`](../datatypes/class_id.md) + The key: the [`components.ClassId`](https://rerun.io/docs/reference/types/components/class_id). -#### `class_description`: [`ClassDescription`](../datatypes/class_description.md) +#### `class_description` +Type: [`ClassDescription`](../datatypes/class_description.md) + The value: class name, color, etc. diff --git a/docs/content/reference/types/datatypes/image_format.md b/docs/content/reference/types/datatypes/image_format.md index 0df03f54087c..ab654918f9a3 100644 --- a/docs/content/reference/types/datatypes/image_format.md +++ b/docs/content/reference/types/datatypes/image_format.md @@ -6,23 +6,33 @@ title: "ImageFormat" The metadata describing the contents of a [`components.ImageBuffer`](https://rerun.io/docs/reference/types/components/image_buffer). ## Fields -#### `width`: `uint32` +#### `width` +Type: `uint32` + The width of the image in pixels. -#### `height`: `uint32` +#### `height` +Type: `uint32` + The height of the image in pixels. -#### `pixel_format`: nullable [`PixelFormat`](../datatypes/pixel_format.md) +#### `pixel_format` +Type: nullable [`PixelFormat`](../datatypes/pixel_format.md) + Used mainly for chroma downsampled formats and differing number of bits per channel. If specified, this takes precedence over both [`datatypes.ColorModel`](https://rerun.io/docs/reference/types/datatypes/color_model) and [`datatypes.ChannelDatatype`](https://rerun.io/docs/reference/types/datatypes/channel_datatype) (which are ignored). -#### `color_model`: nullable [`ColorModel`](../datatypes/color_model.md) +#### `color_model` +Type: nullable [`ColorModel`](../datatypes/color_model.md) + L, RGB, RGBA, … Also requires a [`datatypes.ChannelDatatype`](https://rerun.io/docs/reference/types/datatypes/channel_datatype) to fully specify the pixel format. -#### `channel_datatype`: nullable [`ChannelDatatype`](../datatypes/channel_datatype.md) +#### `channel_datatype` +Type: nullable [`ChannelDatatype`](../datatypes/channel_datatype.md) + The data type of each channel (e.g. the red channel) of the image data (U8, F16, …). Also requires a [`datatypes.ColorModel`](https://rerun.io/docs/reference/types/datatypes/color_model) to fully specify the pixel format. diff --git a/docs/content/reference/types/datatypes/keypoint_pair.md b/docs/content/reference/types/datatypes/keypoint_pair.md index d6425f26cdd7..c466bac9b3bb 100644 --- a/docs/content/reference/types/datatypes/keypoint_pair.md +++ b/docs/content/reference/types/datatypes/keypoint_pair.md @@ -6,10 +6,14 @@ title: "KeypointPair" A connection between two [`datatypes.KeypointId`](https://rerun.io/docs/reference/types/datatypes/keypoint_id)s. ## Fields -#### `keypoint0`: [`KeypointId`](../datatypes/keypoint_id.md) +#### `keypoint0` +Type: [`KeypointId`](../datatypes/keypoint_id.md) + The first point of the pair. -#### `keypoint1`: [`KeypointId`](../datatypes/keypoint_id.md) +#### `keypoint1` +Type: [`KeypointId`](../datatypes/keypoint_id.md) + The second point of the pair. diff --git a/docs/content/reference/types/datatypes/range2d.md b/docs/content/reference/types/datatypes/range2d.md index ee7388703496..558c3a24a220 100644 --- a/docs/content/reference/types/datatypes/range2d.md +++ b/docs/content/reference/types/datatypes/range2d.md @@ -6,10 +6,14 @@ title: "Range2D" An Axis-Aligned Bounding Box in 2D space, implemented as the minimum and maximum corners. ## Fields -#### `x_range`: [`Range1D`](../datatypes/range1d.md) +#### `x_range` +Type: [`Range1D`](../datatypes/range1d.md) + The range of the X-axis (usually left and right bounds). -#### `y_range`: [`Range1D`](../datatypes/range1d.md) +#### `y_range` +Type: [`Range1D`](../datatypes/range1d.md) + The range of the Y-axis (usually top and bottom bounds). diff --git a/docs/content/reference/types/datatypes/rotation_axis_angle.md b/docs/content/reference/types/datatypes/rotation_axis_angle.md index b01ace5cf825..e9a26b8086f2 100644 --- a/docs/content/reference/types/datatypes/rotation_axis_angle.md +++ b/docs/content/reference/types/datatypes/rotation_axis_angle.md @@ -6,14 +6,18 @@ title: "RotationAxisAngle" 3D rotation represented by a rotation around a given axis. ## Fields -#### `axis`: [`Vec3D`](../datatypes/vec3d.md) +#### `axis` +Type: [`Vec3D`](../datatypes/vec3d.md) + Axis to rotate around. This is not required to be normalized. If normalization fails (typically because the vector is length zero), the rotation is silently ignored. -#### `angle`: [`Angle`](../datatypes/angle.md) +#### `angle` +Type: [`Angle`](../datatypes/angle.md) + How much to rotate around the axis. diff --git a/docs/content/reference/types/datatypes/tensor_buffer.md b/docs/content/reference/types/datatypes/tensor_buffer.md index 9e2fc7cf9b7b..653f915c978f 100644 --- a/docs/content/reference/types/datatypes/tensor_buffer.md +++ b/docs/content/reference/types/datatypes/tensor_buffer.md @@ -8,37 +8,59 @@ The underlying storage for [`archetypes.Tensor`](https://rerun.io/docs/reference Tensor elements are stored in a contiguous buffer of a single type. ## Variants -#### `U8` = 1: List of `uint8` +#### `U8` = 1 +Type: List of `uint8` + 8bit unsigned integer. -#### `U16` = 2: List of `uint16` +#### `U16` = 2 +Type: List of `uint16` + 16bit unsigned integer. -#### `U32` = 3: List of `uint32` +#### `U32` = 3 +Type: List of `uint32` + 32bit unsigned integer. -#### `U64` = 4: List of `uint64` +#### `U64` = 4 +Type: List of `uint64` + 64bit unsigned integer. -#### `I8` = 5: List of `int8` +#### `I8` = 5 +Type: List of `int8` + 8bit signed integer. -#### `I16` = 6: List of `int16` +#### `I16` = 6 +Type: List of `int16` + 16bit signed integer. -#### `I32` = 7: List of `int32` +#### `I32` = 7 +Type: List of `int32` + 32bit signed integer. -#### `I64` = 8: List of `int64` +#### `I64` = 8 +Type: List of `int64` + 64bit signed integer. -#### `F16` = 9: List of `float16` +#### `F16` = 9 +Type: List of `float16` + 16bit IEEE-754 floating point, also known as `half`. -#### `F32` = 10: List of `float32` +#### `F32` = 10 +Type: List of `float32` + 32bit IEEE-754 floating point, also known as `float` or `single`. -#### `F64` = 11: List of `float64` +#### `F64` = 11 +Type: List of `float64` + 64bit IEEE-754 floating point, also known as `double`. diff --git a/docs/content/reference/types/datatypes/tensor_data.md b/docs/content/reference/types/datatypes/tensor_data.md index a00cf198a922..caef70928282 100644 --- a/docs/content/reference/types/datatypes/tensor_data.md +++ b/docs/content/reference/types/datatypes/tensor_data.md @@ -13,10 +13,14 @@ These dimensions are combined with an index to look up values from the `buffer` which stores a contiguous array of typed values. ## Fields -#### `shape`: List of [`TensorDimension`](../datatypes/tensor_dimension.md) +#### `shape` +Type: List of [`TensorDimension`](../datatypes/tensor_dimension.md) + The shape of the tensor, including optional names for each dimension. -#### `buffer`: [`TensorBuffer`](../datatypes/tensor_buffer.md) +#### `buffer` +Type: [`TensorBuffer`](../datatypes/tensor_buffer.md) + The content/data. diff --git a/docs/content/reference/types/datatypes/tensor_dimension.md b/docs/content/reference/types/datatypes/tensor_dimension.md index c58f3009e835..4341e405ac10 100644 --- a/docs/content/reference/types/datatypes/tensor_dimension.md +++ b/docs/content/reference/types/datatypes/tensor_dimension.md @@ -6,10 +6,14 @@ title: "TensorDimension" A single dimension within a multi-dimensional tensor. ## Fields -#### `size`: `uint64` +#### `size` +Type: `uint64` + The length of this dimension. -#### `name`: nullable `utf8` +#### `name` +Type: nullable `utf8` + The name of this dimension, e.g. "width", "height", "channel", "batch', …. diff --git a/docs/content/reference/types/datatypes/tensor_dimension_index_selection.md b/docs/content/reference/types/datatypes/tensor_dimension_index_selection.md index 456da715f756..1373e1455731 100644 --- a/docs/content/reference/types/datatypes/tensor_dimension_index_selection.md +++ b/docs/content/reference/types/datatypes/tensor_dimension_index_selection.md @@ -8,10 +8,14 @@ Indexing a specific tensor dimension. Selecting `dimension=2` and `index=42` is similar to doing `tensor[:, :, 42, :, :, …]` in numpy. ## Fields -#### `dimension`: `uint32` +#### `dimension` +Type: `uint32` + The dimension number to select. -#### `index`: `uint64` +#### `index` +Type: `uint64` + The index along the dimension to use. diff --git a/docs/content/reference/types/datatypes/tensor_dimension_selection.md b/docs/content/reference/types/datatypes/tensor_dimension_selection.md index 732409728bc1..94d97e242c17 100644 --- a/docs/content/reference/types/datatypes/tensor_dimension_selection.md +++ b/docs/content/reference/types/datatypes/tensor_dimension_selection.md @@ -6,10 +6,14 @@ title: "TensorDimensionSelection" Selection of a single tensor dimension. ## Fields -#### `dimension`: `uint32` +#### `dimension` +Type: `uint32` + The dimension number to select. -#### `invert`: `boolean` +#### `invert` +Type: `boolean` + Invert the direction of the dimension. diff --git a/docs/content/reference/types/datatypes/time_range.md b/docs/content/reference/types/datatypes/time_range.md index 5c82cb45a235..a4b272616a4c 100644 --- a/docs/content/reference/types/datatypes/time_range.md +++ b/docs/content/reference/types/datatypes/time_range.md @@ -6,10 +6,14 @@ title: "TimeRange" Visible time range bounds for a specific timeline. ## Fields -#### `start`: [`TimeRangeBoundary`](../datatypes/time_range_boundary.md) +#### `start` +Type: [`TimeRangeBoundary`](../datatypes/time_range_boundary.md) + Low time boundary for sequence timeline. -#### `end`: [`TimeRangeBoundary`](../datatypes/time_range_boundary.md) +#### `end` +Type: [`TimeRangeBoundary`](../datatypes/time_range_boundary.md) + High time boundary for sequence timeline. diff --git a/docs/content/reference/types/datatypes/time_range_boundary.md b/docs/content/reference/types/datatypes/time_range_boundary.md index d5a0fa226714..e409fe485ab0 100644 --- a/docs/content/reference/types/datatypes/time_range_boundary.md +++ b/docs/content/reference/types/datatypes/time_range_boundary.md @@ -6,13 +6,19 @@ title: "TimeRangeBoundary" Left or right boundary of a time range. ## Variants -#### `CursorRelative` = 1: [`TimeInt`](../datatypes/time_int.md) +#### `CursorRelative` = 1 +Type: [`TimeInt`](../datatypes/time_int.md) + Boundary is a value relative to the time cursor. -#### `Absolute` = 2: [`TimeInt`](../datatypes/time_int.md) +#### `Absolute` = 2 +Type: [`TimeInt`](../datatypes/time_int.md) + Boundary is an absolute value. -#### `Infinite` = 3: `null` +#### `Infinite` = 3 +Type: `null` + The boundary extends to infinity. diff --git a/docs/content/reference/types/datatypes/visible_time_range.md b/docs/content/reference/types/datatypes/visible_time_range.md index 017489d74c18..6ad2bc9c8cb4 100644 --- a/docs/content/reference/types/datatypes/visible_time_range.md +++ b/docs/content/reference/types/datatypes/visible_time_range.md @@ -6,10 +6,14 @@ title: "VisibleTimeRange" Visible time range bounds for a specific timeline. ## Fields -#### `timeline`: [`Utf8`](../datatypes/utf8.md) +#### `timeline` +Type: [`Utf8`](../datatypes/utf8.md) + Name of the timeline this applies to. -#### `range`: [`TimeRange`](../datatypes/time_range.md) +#### `range` +Type: [`TimeRange`](../datatypes/time_range.md) + Time range to use for this timeline.