Document that images can be compressed

rerun-io · Mar 25, 2024 · 3096c17 · 3096c17
1 parent bbcfc9e
commit 3096c17
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 2 deletions.
diff --git a/crates/re_types/definitions/rerun/archetypes/image.fbs b/crates/re_types/definitions/rerun/archetypes/image.fbs
@@ -16,10 +16,16 @@ namespace rerun.archetypes;
 /// Leading and trailing unit-dimensions are ignored, so that
 /// `1x640x480x3x1` is treated as a `640x480x3` RGB image.
 ///
+/// Rerun also supports compressed image encoded as JPEG, N12, and YUY2.
+/// Using these formats can save a lot of bandwidth and memory.
+/// \python To compress an image, use [`rerun.Image.compress`][].
+/// \python To pass in an already encoded image, use  [`rerun.ImageEncoded`][].
+/// \rust See [`crate::components::TensorData`] for more.
+/// \cpp See [`rerun::datatypes::TensorBuffer`] for more.
+///
 /// \cpp Since the underlying `rerun::datatypes::TensorData` uses `rerun::Collection` internally,
 /// \cpp data can be passed in without a copy from raw pointers or by reference from `std::vector`/`std::array`/c-arrays.
 /// \cpp If needed, this "borrow-behavior" can be extended by defining your own `rerun::CollectionAdapter`.
-/// \python For an easy way to pass in image formats or encoded images, see [`rerun.ImageEncoded`][].
 ///
 /// \example image_simple image="https://static.rerun.io/image_simple/06ba7f8582acc1ffb42a7fd0006fad7816f3e4e4/1200w.png"
 table Image (

diff --git a/crates/re_types/src/archetypes/image.rs b/crates/re_types/src/archetypes/image.rs
diff --git a/docs/content/reference/types/archetypes/image.md b/docs/content/reference/types/archetypes/image.md
diff --git a/rerun_cpp/src/rerun/archetypes/image.hpp b/rerun_cpp/src/rerun/archetypes/image.hpp
diff --git a/rerun_py/rerun_sdk/rerun/archetypes/image.py b/rerun_py/rerun_sdk/rerun/archetypes/image.py