Skip to content

Commit

Permalink
Document our encoding of Color datatype and component (#3289)
Browse files Browse the repository at this point in the history
### What
* Related to #2782

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/3289) (if
applicable)

- [PR Build Summary](https://build.rerun.io/pr/3289)
- [Docs
preview](https://rerun.io/preview/cbd599a8e94ff31bff87f7ab42d5a6ac441b3d0d/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/cbd599a8e94ff31bff87f7ab42d5a6ac441b3d0d/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
  • Loading branch information
emilk authored Sep 12, 2023
1 parent 7e4d556 commit c201281
Show file tree
Hide file tree
Showing 8 changed files with 29 additions and 10 deletions.
5 changes: 4 additions & 1 deletion crates/re_types/definitions/rerun/components/color.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ namespace rerun.components;

// ---

/// An RGBA color tuple with unmultiplied/separate alpha, in sRGB gamma space with linear alpha.
/// An RGBA color with unmultiplied/separate alpha, in sRGB gamma space with linear alpha.
///
/// The color is stored as a 32-bit integer, where the most significant
/// byte is `R` and the least significant byte is `A`.
///
/// \py Float colors are assumed to be in 0-1 gamma sRGB space.
/// \py All other colors are assumed to be in 0-255 gamma sRGB space.
Expand Down
5 changes: 4 additions & 1 deletion crates/re_types/definitions/rerun/datatypes/color.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ namespace rerun.datatypes;

// ---

/// An RGBA color tuple with unmultiplied/separate alpha, in sRGB gamma space with linear alpha.
/// An RGBA color with unmultiplied/separate alpha, in sRGB gamma space with linear alpha.
///
/// The color is stored as a 32-bit integer, where the most significant
/// byte is `R` and the least significant byte is `A`.
///
/// \py Float colors are assumed to be in 0-1 gamma sRGB space.
/// \py All other colors are assumed to be in 0-255 gamma sRGB space.
Expand Down
2 changes: 1 addition & 1 deletion crates/re_types/source_hash.txt

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion crates/re_types/src/components/color.rs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion crates/re_types/src/datatypes/color.rs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions rerun_cpp/src/rerun/components/color.hpp

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions rerun_cpp/src/rerun/datatypes/color.hpp

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion rerun_py/rerun_sdk/rerun/_rerun2/datatypes/color.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c201281

Please sign in to comment.