Skip to main content

FontColorTransferFunction

Enum FontColorTransferFunction 

Source
pub enum FontColorTransferFunction {
    Off,
    Gamma(f32),
    TwoCoverageMinusCoverageSq,
}
Expand description

How to convert font coverage values into alpha and color values.

epaint stores all glyphs in the font atlas as white (with varying opacity), so that egui can reuse the same glyph for different text colors (with a simple color multiplication in the shader).

Because of this simplification, we need to apply a non-linear ramp to the glyph colors before writing them into the font atlas, as a way to compensate.

This whole thing is less than rigorous.

It would be better to either render all text colors into the font atlas (which would require more atlas space, but would allow for more accurate rendering of colored text and emojis), or do the color compensation in the shader, based on the active text color.

When experimenting, use https://fonts.google.com/specimen/Ubuntu to compare to a ground truth.

See https://hikogui.org/2022/10/24/the-trouble-with-anti-aliasing.html for related analysis.

Variants§

§

Off

Use the raw RGBA values from the font rasterizer, without any conversion.

This is the required mode for colored emojis etc.

This mode looks good for black-on-white text, i.e. light mode.

§

Gamma(f32)

alpha = coverage^gamma.

Gamma=1 looks good for black-on-white text, i.e. light mode.

§

TwoCoverageMinusCoverageSq

alpha = 2 * coverage - coverage^2

This looks good for white-on-black text, i.e. dark mode.

Very similar to a gamma of 0.5, but produces sharper text. See https://www.desmos.com/calculator/w0ndf5blmn for a comparison to gamma=0.5.

Implementations§

Source§

impl FontColorTransferFunction

Source

pub const LIGHT_MODE_DEFAULT: Self = Self::Off

A good-looking default for light mode (black-on-white text).

Source

pub const DARK_MODE_DEFAULT: Self = Self::TwoCoverageMinusCoverageSq

A good-looking default for dark mode (white-on-black text).

Source

pub fn to_atlas_color(self, input_color: Color32) -> Color32

How to convert a white color written by the font rasterizer into a color to be written into the font atlas.

Source

pub fn alpha_from_coverage(self, coverage: f32) -> f32

Convert coverage to alpha.

Source

pub fn color_from_coverage(self, coverage: f32) -> Color32

Source

pub fn to_gamma(self) -> f32

Convert this into the closest gamma exponent

Trait Implementations§

Source§

impl Clone for FontColorTransferFunction

Source§

fn clone(&self) -> FontColorTransferFunction

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for FontColorTransferFunction

Source§

impl Debug for FontColorTransferFunction

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for FontColorTransferFunction

Source§

fn default() -> FontColorTransferFunction

Returns the “default value” for a type. Read more
Source§

impl PartialEq for FontColorTransferFunction

Source§

fn eq(&self, other: &FontColorTransferFunction) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FontColorTransferFunction

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.