linear_srgb/
default.rs

1//! Recommended API for sRGB ↔ linear conversion.
2//!
3//! This module re-exports the optimal implementation for each use case:
4//!
5//! - **Single f32 values**: Rational polynomial (~14 ULP max, perfectly
6//!   monotonic — no `powf`)
7//! - **Single u8/u16 values**: LUT lookup (zero math)
8//! - **Slices**: SIMD-accelerated with runtime CPU dispatch
9//! - **Custom gamma**: Pure power function (f32, slices)
10//!
11//! For exact `powf()` conversions with C0-continuous constants, see [`crate::precise`].
12//!
13//! # Quick Start
14//!
15//! ```rust
16//! use linear_srgb::default::{srgb_to_linear, linear_to_srgb};
17//!
18//! let linear = srgb_to_linear(0.5);
19//! let srgb = linear_to_srgb(linear);
20//! ```
21//!
22//! # Batch Processing
23//!
24//! ```rust
25//! use linear_srgb::default::{srgb_to_linear_slice, linear_to_srgb_slice};
26//!
27//! let mut values = vec![0.5f32; 10000];
28//! srgb_to_linear_slice(&mut values);  // SIMD-accelerated
29//! linear_to_srgb_slice(&mut values);
30//! ```
31
32// ============================================================================
33// Single-value sRGB f32 (rational polynomial — fast, ≤14 ULP, monotonic)
34// ============================================================================
35
36pub use crate::rational_poly::{
37    linear_to_srgb_fast as linear_to_srgb, srgb_to_linear_fast as srgb_to_linear,
38};
39
40// ============================================================================
41// Single-value sRGB integer (LUT lookup — zero math)
42// ============================================================================
43
44pub use crate::scalar::{
45    linear_to_srgb_u8, linear_to_srgb_u16, srgb_u8_to_linear, srgb_u16_to_linear,
46};
47
48// ============================================================================
49// Slice functions (SIMD-dispatched)
50// ============================================================================
51
52pub use crate::simd::{
53    // Custom gamma slices
54    gamma_to_linear_slice,
55    linear_to_gamma_slice,
56    // f32 RGBA slices (alpha-preserving)
57    linear_to_srgb_rgba_slice,
58    // f32 slices (in-place)
59    linear_to_srgb_slice,
60    linear_to_srgb_u8_rgba_slice,
61    // u8 slices
62    linear_to_srgb_u8_slice,
63    linear_to_srgb_u16_rgba_slice,
64    // u16 slices
65    linear_to_srgb_u16_slice,
66    // Fused premultiply/unpremultiply
67    srgb_to_linear_premultiply_rgba_slice,
68    // f32 RGBA slices (alpha-preserving)
69    srgb_to_linear_rgba_slice,
70    // f32 slices (in-place)
71    srgb_to_linear_slice,
72    srgb_u8_to_linear_premultiply_rgba_slice,
73    srgb_u8_to_linear_rgba_slice,
74    // u8 slices
75    srgb_u8_to_linear_slice,
76    srgb_u16_to_linear_rgba_slice,
77    // u16 slices
78    srgb_u16_to_linear_slice,
79    unpremultiply_linear_to_srgb_rgba_slice,
80    unpremultiply_linear_to_srgb_u8_rgba_slice,
81};
82
83// Deprecated gamma premultiply/unpremultiply re-exports
84#[allow(deprecated)]
85pub use crate::simd::{
86    gamma_to_linear_premultiply_rgba_slice, unpremultiply_linear_to_gamma_rgba_slice,
87};
88
89// ============================================================================
90// Custom gamma (scalar)
91// ============================================================================
92
93pub use crate::scalar::{gamma_to_linear, linear_to_gamma};
94
95// ============================================================================
96// Transfer functions (behind `transfer` feature)
97// ============================================================================
98
99#[cfg(feature = "transfer")]
100pub use crate::tf::{
101    bt709_to_linear, hlg_to_linear, linear_to_bt709, linear_to_hlg, linear_to_pq, pq_to_linear,
102};
103
104// ============================================================================
105// Transfer function slice operations (behind `transfer` feature)
106// ============================================================================
107//
108// Scalar-loop wrappers — correct but not yet SIMD-accelerated.
109// TODO: add incant!-dispatched SIMD versions using the x8/x16 token functions.
110
111/// Convert HLG signal f32 values to linear in-place.
112#[cfg(feature = "transfer")]
113#[inline]
114pub fn hlg_to_linear_slice(values: &mut [f32]) {
115    for v in values.iter_mut() {
116        *v = crate::tf::hlg_to_linear(*v);
117    }
118}
119
120/// Convert linear f32 values to HLG signal in-place.
121#[cfg(feature = "transfer")]
122#[inline]
123pub fn linear_to_hlg_slice(values: &mut [f32]) {
124    for v in values.iter_mut() {
125        *v = crate::tf::linear_to_hlg(*v);
126    }
127}
128
129/// Convert PQ (ST 2084) signal f32 values to linear in-place.
130#[cfg(feature = "transfer")]
131#[inline]
132pub fn pq_to_linear_slice(values: &mut [f32]) {
133    for v in values.iter_mut() {
134        *v = crate::tf::pq_to_linear(*v);
135    }
136}
137
138/// Convert linear f32 values to PQ (ST 2084) signal in-place.
139#[cfg(feature = "transfer")]
140#[inline]
141pub fn linear_to_pq_slice(values: &mut [f32]) {
142    for v in values.iter_mut() {
143        *v = crate::tf::linear_to_pq(*v);
144    }
145}
146
147// ============================================================================
148// LUT converter (zero-cost const tables)
149// ============================================================================
150
151pub use crate::lut::SrgbConverter;
linear_srgb/default.rs

linear_srgb/
default.rs
