3 releases (breaking)
new 0.2.0 | Dec 17, 2024 |
---|---|
0.1.0 | Nov 20, 2024 |
0.0.1 | Nov 21, 2014 |
#3 in #css-color
255 downloads per month
Used in hi-nvim-rs
245KB
4K
SLoC
Color is a Rust crate which implements color space conversions, targeting at least CSS Color Level 4.
Main types
The crate has two approaches to representing color in the Rust type system: a set of
types with static color space as part of the types, and DynamicColor
in which the color space is represented at runtime.
The static color types come in three variants: OpaqueColor
without an
alpha channel, AlphaColor
with a separate alpha channel, and PremulColor
with
premultiplied alpha. The last type is particularly useful for making interpolation and
compositing more efficient. These have a marker type parameter, indicating which
ColorSpace
they are in. Conversion to another color space uses the convert
method
on each of these types. The static types are open-ended, as it's possible to implement
this trait for new color spaces.
Scope and goals
Color in its entirety is an extremely deep and complex topic. It is completely impractical for a single crate to meet all color needs. The goal of this one is to strike a balance, providing color capabilities while also keeping things simple and efficient.
The main purpose of this crate is to provide a good set of types for representing colors, along with conversions between them and basic manipulations, especially interpolation. A major inspiration is the CSS Color Level 4 draft spec; we implement most of the operations and strive for correctness.
A primary use case is rendering, including color conversions and methods for preparing gradients. The crate should also be suitable for document authoring and editing, as it contains methods for parsing and serializing colors with CSS Color 4 compatible syntax.
Simplifications include:
- Always using
f32
to represent component values. - Only handling 3-component color spaces (plus optional alpha).
- Choosing a fixed, curated set of color spaces for dynamic color types.
- Choosing linear sRGB as the central color space.
- Keeping white point implicit.
A number of other tasks are out of scope for this crate:
- Print color spaces (CMYK).
- Spectral colors.
- Color spaces with more than 3 components generally.
- ICC color profiles.
- ACES color transforms.
- Appearance models and other color science not needed for rendering.
- Quantizing and packing to lower bit depths.
The Rgba8
and PremulRgba8
types are a partial exception to this last item, as
those representation are ubiquitous and requires special logic for serializing to
maximize compatibility.
Some of these capabilities may be added as other crates within the color
repository,
and we will also facilitate interoperability with other color crates in the Rust
ecosystem as needed.
Features
std
(enabled by default): Get floating point functions from the standard library (likely using your target's libc).libm
: Use floating point implementations from libm.bytemuck
: Implement traits frombytemuck
onAlphaColor
,ColorSpaceTag
,HueDirection
,OpaqueColor
,PremulColor
,PremulRgba8
, andRgba8
.serde
: Implementserde::Deserialize
andserde::Serialize
onAlphaColor
,DynamicColor
,OpaqueColor
,PremulColor
,PremulRgba8
, andRgba8
.
At least one of std
and libm
is required; std
overrides libm
.
Minimum supported Rust Version (MSRV)
This version of Color has been verified to compile with Rust 1.82 and later.
Future versions of Color might increase the Rust version requirement. It will not be treated as a breaking change and as such can even happen with small patch releases.
Click here if compiling fails.
As time has passed, some of Color's dependencies could have released versions with a higher Rust requirement. If you encounter a compilation issue due to a dependency and don't want to upgrade your Rust toolchain, then you could downgrade the dependency.
# Use the problematic dependency's name and version
cargo update -p package_name --precise 0.1.1
Community
Discussion of Color development happens in the Linebender Zulip, specifically the #color channel. All public content can be read without logging in.
License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Contributions are welcome by pull request. The Rust code of conduct applies. Please feel free to add your name to the AUTHORS file in any substantive pull request.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.
Dependencies
~0–290KB