Struct alacritty::display::Display

pub struct Display {

    pub size_info: SizeInfo,
    pub window: Window,
    pub highlighted_hint: Option<HintMatch>,
    pub vi_highlighted_hint: Option<HintMatch>,
    pub is_x11: bool,
    pub cursor_hidden: bool,
    pub visual_bell: VisualBell,
    pub colors: List,
    pub hint_state: HintState,
    pub pending_update: DisplayUpdate,
    renderer: QuadRenderer,
    glyph_cache: GlyphCache,
    meter: Meter,
}

The display wraps a window, font rasterizer, and GPU renderer.

Fields

size_info: SizeInfo

window: Window

highlighted_hint: Option<HintMatch>

Hint highlighted by the mouse.

vi_highlighted_hint: Option<HintMatch>

Hint highlighted by the vi mode cursor.

is_x11: bool

cursor_hidden: bool

UI cursor visibility for blinking.

visual_bell: VisualBell

colors: List

Mapped RGB values for each terminal color.

hint_state: HintState

State of the keyboard hints.

pending_update: DisplayUpdate

Unprocessed display updates.

renderer: QuadRenderer

glyph_cache: GlyphCache

meter: Meter

Implementations

impl Display

pub fn new<E>(
    config: &UiConfig,
    event_loop: &EventLoopWindowTarget<E>,
    identity: &Identity,
    wayland_event_queue: Option<&EventQueue>
) -> Result<Display, Error>

fn new_glyph_cache(
    dpr: f64,
    renderer: &mut QuadRenderer,
    config: &UiConfig
) -> Result<(GlyphCache, f32, f32), Error>

fn update_glyph_cache(&mut self, config: &UiConfig, font: &Font) -> (f32, f32)

Update font size and cell dimensions.

This will return a tuple of the cell width and height.

fn clear_glyph_cache(&mut self)

Clear glyph cache.

pub fn handle_update<T>(
    &mut self,
    terminal: &mut Term<T>,
    pty_resize_handle: &mut dyn OnResize,
    message_buffer: &MessageBuffer,
    search_active: bool,
    config: &UiConfig
) where
    T: EventListener, 

Process update events.

pub fn draw<T: EventListener>(
    &mut self,
    terminal: MutexGuard<'_, Term<T>>,
    message_buffer: &MessageBuffer,
    config: &UiConfig,
    search_state: &SearchState
)

Draw the screen.

A reference to Term whose state is being drawn must be provided.

This call may block if vsync is enabled.

pub fn update_config(&mut self, config: &UiConfig)

Update to a new configuration.

pub fn update_highlighted_hints<T>(
    &mut self,
    term: &Term<T>,
    config: &UiConfig,
    mouse: &Mouse,
    modifiers: ModifiersState
) -> bool

Update the mouse/vi mode cursor hint highlighting.

This will return whether the highlighted hints changed.

fn format_search(
    size_info: &SizeInfo,
    search_regex: &str,
    search_label: &str
) -> String

Format search regex to account for the cursor and fullwidth characters.

fn draw_search(&mut self, config: &UiConfig, size_info: &SizeInfo, text: &str)

Draw current search regex.

fn draw_render_timer(&mut self, config: &UiConfig, size_info: &SizeInfo)

Draw render timer.

fn draw_line_indicator(
    &mut self,
    config: &UiConfig,
    size_info: &SizeInfo,
    total_lines: usize,
    obstructed_column: Option<Column>,
    line: usize
)

Draw an indicator for the position of a line in history.

fn request_frame(&self, window: &Window)

Requst a new frame for a window on Wayland.

Trait Implementations

impl Drop for Display

fn drop(&mut self)

Executes the destructor for this type.