Skip to content

Commit

Permalink
feat: add colorManipulator.blend
Browse files Browse the repository at this point in the history
  • Loading branch information
romgrk committed Jan 17, 2024
1 parent ac5a1e0 commit 005338d
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
1 change: 1 addition & 0 deletions packages/mui-system/src/colorManipulator.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ export function darken(color: string, coefficient: number): string;
export function private_safeDarken(color: string, coefficient: number, warning?: string): string;
export function lighten(color: string, coefficient: number): string;
export function private_safeLighten(color: string, coefficient: number, warning?: string): string;
export function blend(background: string, overlay: string, opacity: number, gamma?: number): string;
27 changes: 27 additions & 0 deletions packages/mui-system/src/colorManipulator.js
Original file line number Diff line number Diff line change
Expand Up @@ -348,3 +348,30 @@ export function private_safeEmphasize(color, coefficient, warning) {
return color;
}
}

/**
* Blend a transparent overlay color with a background color, resulting in a single
* RGB color. The color space is gamma-corrected with a standard value of 2.2.
* @param {string} background - CSS color
* @param {string} overlay - CSS color
* @param {number} opacity - Opacity multiplier in the range 0 - 1
* @param {number} [gamma=1.0] - Gamma correction factor. For gamma-correct blending, 2.2 is usual.
*/
export function blend(background, overlay, opacity, gamma = 1.0) {
const f = (b, o) =>
Math.round((b ** (1 / gamma) * (1 - opacity) + o ** (1 / gamma) * opacity) ** gamma);

const backgroundColor = decomposeColor(background);
const overlayColor = decomposeColor(overlay);

const rgb = [
f(backgroundColor.values[0], overlayColor.values[0]),
f(backgroundColor.values[1], overlayColor.values[1]),
f(backgroundColor.values[2], overlayColor.values[2]),
];

return recomposeColor({
type: 'rgb',
values: rgb,
});
}

0 comments on commit 005338d

Please sign in to comment.