Skip to content

Add no_std support to bevy_color#16633

Merged
alice-i-cecile merged 2 commits intobevyengine:mainfrom
bushrat011899:NoSTDBevyColorV2
Dec 5, 2024
Merged

Add no_std support to bevy_color#16633
alice-i-cecile merged 2 commits intobevyengine:mainfrom
bushrat011899:NoSTDBevyColorV2

Conversation

@bushrat011899
Copy link
Copy Markdown
Contributor

@bushrat011899 bushrat011899 commented Dec 3, 2024

Objective

Solution

  • Added the following new features:
    • std (default)
    • alloc
    • encase (default)
    • libm

Testing

  • Added to compile-check-no-std CI command

Notes

  • ColorCurve requires alloc due to how the underlying EvenCore type works.
  • Srgba::to_hex requires alloc to return a String.
  • This was otherwise a very simple change

@bushrat011899 bushrat011899 mentioned this pull request Dec 3, 2024
Closed
@bushrat011899 bushrat011899 added C-Feature A new feature, making something new possible D-Trivial Nice and easy! A great choice to get started with Bevy X-Uncontroversial This work is generally agreed upon S-Needs-Review Needs reviewer attention (from anyone!) to move forward A-Color Color spaces and color math labels Dec 3, 2024
IQuick143
IQuick143 reviewed Dec 4, 2024
View reviewed changes
@IQuick143 IQuick143 added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Dec 4, 2024
TimJentzsch
TimJentzsch approved these changes Dec 4, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@TimJentzsch TimJentzsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have to say, I'm a bit surprised that stuff like rounding numbers is not available in core and has to be imported from bevy_math.

But the changes look fine to me :)

@bushrat011899
Copy link
Copy Markdown
Contributor Author

bushrat011899 commented Dec 4, 2024

I have to say, I'm a bit surprised that stuff like rounding numbers is not available in core and has to be imported from bevy_math.

Yeah they were in core in early versions of Rust, but have since been removed. The reason was they depended on libm for their implementation, and they wanted core to be as slim as possible. Since libm is also a no_std library with pretty much perfect platform support it isn't really that big of a change. I'd previously even discussed the idea of adding an extension trait in bevy_math that would make this change entirely transparent. The idea was eventually scrapped, as it's probably a good thing to highlight which maths operations are "problematic".

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Dec 5, 2024
Merged via the queue into bevyengine:main with commit 73c6479 Dec 5, 2024
@TimJentzsch TimJentzsch added the O-Embedded Weird hardware and no_std platforms label Dec 31, 2024
ecoskey pushed a commit to ecoskey/bevy that referenced this pull request Jan 6, 2025
@bushrat011899 @ecoskey
Add no_std support to bevy_color (bevyengine#16633)
10bbbb6 
# Objective

- Contributes to bevyengine#15460

## Solution

- Added the following new features: 
  - `std` (default)
  - `alloc`
  - `encase` (default)
  - `libm`

## Testing

- Added to `compile-check-no-std` CI command

## Notes

- `ColorCurve` requires `alloc` due to how the underlying `EvenCore`
type works.
- `Srgba::to_hex` requires `alloc` to return a `String`.
- This was otherwise a _very_ simple change
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

4 more reviewers

@IQuick143 IQuick143 IQuick143 approved these changes

@viridia viridia viridia approved these changes

@TimJentzsch TimJentzsch TimJentzsch approved these changes

@BenjaminBrienen BenjaminBrienen BenjaminBrienen approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

A-Color Color spaces and color math C-Feature A new feature, making something new possible D-Trivial Nice and easy! A great choice to get started with Bevy O-Embedded Weird hardware and no_std platforms S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it X-Uncontroversial This work is generally agreed upon

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@bushrat011899 @viridia @TimJentzsch @IQuick143 @BenjaminBrienen @alice-i-cecile