[go: up one dir, main page]

Visuals

egui::style

Struct Visuals 

Source 
pub struct Visuals {
Show 35 fields
    pub dark_mode: bool,
    pub text_alpha_from_coverage: AlphaFromCoverage,
    pub override_text_color: Option<Color32>,
    pub weak_text_alpha: f32,
    pub weak_text_color: Option<Color32>,
    pub widgets: Widgets,
    pub selection: Selection,
    pub hyperlink_color: Color32,
    pub faint_bg_color: Color32,
    pub extreme_bg_color: Color32,
    pub text_edit_bg_color: Option<Color32>,
    pub code_bg_color: Color32,
    pub warn_fg_color: Color32,
    pub error_fg_color: Color32,
    pub window_corner_radius: CornerRadius,
    pub window_shadow: Shadow,
    pub window_fill: Color32,
    pub window_stroke: Stroke,
    pub window_highlight_topmost: bool,
    pub menu_corner_radius: CornerRadius,
    pub panel_fill: Color32,
    pub popup_shadow: Shadow,
    pub resize_corner_size: f32,
    pub text_cursor: TextCursorStyle,
    pub clip_rect_margin: f32,
    pub button_frame: bool,
    pub collapsing_header_frame: bool,
    pub indent_has_left_vline: bool,
    pub striped: bool,
    pub slider_trailing_fill: bool,
    pub handle_shape: HandleShape,
    pub interact_cursor: Option<CursorIcon>,
    pub image_loading_spinners: bool,
    pub numeric_color_space: NumericColorSpace,
    pub disabled_alpha: f32,

}
Expand description

Controls the visual style (colors etc) of egui.

You can change the visuals of a Ui with Ui::visuals_mut and of everything with crate::Context::set_visuals_of.

If you want to change fonts, use crate::Context::set_fonts instead.

Fields§

§dark_mode: bool

If true, the visuals are overall dark with light text. If false, the visuals are overall light with dark text.

NOTE: setting this does very little by itself, this is more to provide a convenient summary of the rest of the settings.

§text_alpha_from_coverage: AlphaFromCoverage

ADVANCED: Controls how we render text.

§override_text_color: Option<Color32>

Override default text color for all text.

This is great for setting the color of text for any widget.

If text_color is None (default), then the text color will be the same as the foreground stroke color (WidgetVisuals::fg_stroke) and will depend on whether or not the widget is being interacted with.

In the future we may instead modulate the text_color based on whether or not it is interacted with so that visuals.text_color is always used, but its alpha may be different based on whether or not it is disabled, non-interactive, hovered etc.

§weak_text_alpha: f32

How strong “weak” text is.

Ignored if Self::weak_text_color is set.

§weak_text_color: Option<Color32>

Color of “weak” text.

If None, the color is Self::text_color multiplied by Self::weak_text_alpha.

§widgets: Widgets

Visual styles of widgets

§selection: Selection§hyperlink_color: Color32

The color used for crate::Hyperlink,

§faint_bg_color: Color32

Something just barely different from the background color. Used for crate::Grid::striped.

§extreme_bg_color: Color32

Very dark or light color (for corresponding theme). Used as the background of text edits, scroll bars and others things that needs to look different from other interactive stuff.

§text_edit_bg_color: Option<Color32>

The background color of crate::TextEdit.

Defaults to Self::extreme_bg_color.

§code_bg_color: Color32

Background color behind code-styled monospaced labels.

§warn_fg_color: Color32

A good color for warning text (e.g. orange).

§error_fg_color: Color32

A good color for error text (e.g. red).

§window_corner_radius: CornerRadius§window_shadow: Shadow§window_fill: Color32§window_stroke: Stroke§window_highlight_topmost: bool

Highlight the topmost window.

§menu_corner_radius: CornerRadius§panel_fill: Color32

Panel background color

§popup_shadow: Shadow§resize_corner_size: f32§text_cursor: TextCursorStyle

How the text cursor acts.

§clip_rect_margin: f32

Allow child widgets to be just on the border and still have a stroke with some thickness

§button_frame: bool

Show a background behind buttons.

§collapsing_header_frame: bool

Show a background behind collapsing headers.

§indent_has_left_vline: bool

Draw a vertical line left of indented region, in e.g. crate::CollapsingHeader.

§striped: bool

Whether or not Grids and Tables should be striped by default (have alternating rows differently colored).

§slider_trailing_fill: bool

Show trailing color behind the circle of a Slider. Default is OFF.

Enabling this will affect ALL sliders, and can be enabled/disabled per slider with Slider::trailing_fill.

§handle_shape: HandleShape

Shape of the handle for sliders and similar widgets.

Changing this will affect ALL sliders, and can be enabled/disabled per slider with Slider::handle_shape.

§interact_cursor: Option<CursorIcon>

Should the cursor change when the user hovers over an interactive/clickable item?

This is consistent with a lot of browser-based applications (vscode, github all turn your cursor into CursorIcon::PointingHand when a button is hovered) but it is inconsistent with native UI toolkits.

§image_loading_spinners: bool

Show a spinner when loading an image.

§numeric_color_space: NumericColorSpace

How to display numeric color values.

§disabled_alpha: f32

How much to modify the alpha of a disabled widget.

Implementations§

Source§

impl Visuals

Source

pub fn noninteractive(&self) -> &WidgetVisuals

Source

pub fn text_color(&self) -> Color32

Source

pub fn weak_text_color(&self) -> Color32

Source

pub fn strong_text_color(&self) -> Color32

Source

pub fn text_edit_bg_color(&self) -> Color32

The background color of crate::TextEdit.

Source

pub fn window_fill(&self) -> Color32

Window background color.

Source

pub fn window_stroke(&self) -> Stroke

Source

pub fn fade_out_to_color(&self) -> Color32

👎Deprecated: Use disabled_alpha(). Fading is now handled by modifying the alpha channel.

When fading out things, we fade the colors towards this.

Source

pub fn disabled_alpha(&self) -> f32

Disabled widgets have their alpha modified by this.

Source

pub fn disable(&self, color: Color32) -> Color32

Returns a “disabled” version of the given color.

This function modifies the opcacity of the given color. If this is undesirable use gray_out.

Source

pub fn gray_out(&self, color: Color32) -> Color32

Returns a “grayed out” version of the given color.

Source§

impl Visuals

Source

pub fn dark() -> Self

Default dark theme.

Source

pub fn light() -> Self

Default light theme.

Source§

impl Visuals

Source

pub fn ui(&mut self, ui: &mut Ui)

Trait Implementations§

Source§

impl Clone for Visuals

Source§

fn clone(&self) -> Visuals

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Visuals

Source§

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

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

impl Default for Visuals

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for Visuals
where Visuals: Default,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Visuals

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Visuals

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Visuals

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<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + Serialize + for<'a> Deserialize<'a> + Send + Sync,