alacritty::display

Struct Display

Source
pub struct Display {
Show 23 fields pub window: Window, pub size_info: SizeInfo, pub highlighted_hint: Option<HintMatch>, highlighted_hint_age: usize, pub vi_highlighted_hint: Option<HintMatch>, vi_highlighted_hint_age: usize, pub raw_window_handle: RawWindowHandle, pub cursor_hidden: bool, pub visual_bell: VisualBell, pub colors: List, pub hint_state: HintState, pub pending_update: DisplayUpdate, pub pending_renderer_update: Option<RendererUpdate>, pub ime: Ime, pub frame_timer: FrameTimer, pub damage_tracker: DamageTracker, pub font_size: Size, hint_mouse_point: Option<Point>, renderer: ManuallyDrop<Renderer>, surface: ManuallyDrop<Surface<WindowSurface>>, context: ManuallyDrop<PossiblyCurrentContext>, glyph_cache: GlyphCache, meter: Meter,
}
Expand description

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

Fields§

§window: Window§size_info: SizeInfo§highlighted_hint: Option<HintMatch>

Hint highlighted by the mouse.

§highlighted_hint_age: usize

Frames since hint highlight was created.

§vi_highlighted_hint: Option<HintMatch>

Hint highlighted by the vi mode cursor.

§vi_highlighted_hint_age: usize

Frames since hint highlight was created.

§raw_window_handle: RawWindowHandle§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.

§pending_renderer_update: Option<RendererUpdate>

The renderer update that takes place only once before the actual rendering.

§ime: Ime

The ime on the given display.

§frame_timer: FrameTimer

The state of the timer for frame scheduling.

§damage_tracker: DamageTracker

Damage tracker for the given display.

§font_size: Size

Font size used by the window.

§hint_mouse_point: Option<Point>§renderer: ManuallyDrop<Renderer>§surface: ManuallyDrop<Surface<WindowSurface>>§context: ManuallyDrop<PossiblyCurrentContext>§glyph_cache: GlyphCache§meter: Meter

Implementations§

Source§

impl Display

Source

pub fn new( window: Window, gl_context: NotCurrentContext, config: &UiConfig, _tabbed: bool, ) -> Result<Display, Error>

Source

pub fn gl_context(&self) -> &PossiblyCurrentContext

Source

pub fn make_not_current(&mut self)

Source

pub fn make_current(&self)

Source

fn swap_buffers(&self)

Source

fn update_font_size( glyph_cache: &mut GlyphCache, config: &UiConfig, font: &Font, ) -> (f32, f32)

Update font size and cell dimensions.

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

Source

fn reset_glyph_cache(&mut self)

Reset glyph cache.

Source

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

Process update events.

Source

pub fn process_renderer_update(&mut self)

Update the state of the renderer.

Source

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

Draw the screen.

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

This call may block if vsync is enabled.

Source

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

Update to a new configuration.

Source

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.

Source

fn draw_ime_preview( &mut self, point: Point<usize>, fg: Rgb, bg: Rgb, rects: &mut Vec<RenderRect>, config: &UiConfig, )

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

Draw preview for the currently highlighted Hyperlink.

Draw current search regex.

Source

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

Draw render timer.

Source

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

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

Source

fn highlight_damage(&self, render_rects: &mut Vec<RenderRect>)

Highlight damaged rects.

This function is for debug purposes only.

Source

fn validate_hint_highlights(&mut self, display_offset: usize)

Check whether a hint highlight needs to be cleared.

Source

fn request_frame(&mut self, scheduler: &mut Scheduler)

Request a new frame for a window on Wayland.

Trait Implementations§

Source§

impl Drop for Display

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl Freeze for Display

§

impl !RefUnwindSafe for Display

§

impl !Send for Display

§

impl !Sync for Display

§

impl Unpin for Display

§

impl !UnwindSafe for Display

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more