TerminalRenderer

Struct TerminalRenderer 

Source
pub struct TerminalRenderer {
    pub font_family: String,
    pub font_size: Pixels,
    pub cell_width: Pixels,
    pub cell_height: Pixels,
    pub line_height_multiplier: f32,
    pub palette: ColorPalette,
}
Expand description

Terminal renderer with font settings and cell dimensions.

This struct manages the rendering of terminal content, including text, backgrounds, and cursor. It maintains font metrics and provides the paint method for drawing the terminal grid.

§Font Metrics

Cell dimensions are calculated from actual font measurements via measure_cell. This ensures accurate character positioning regardless of the font used.

§Usage

The renderer is typically used internally by TerminalView, but can also be used directly for custom rendering:

// Measure cell dimensions (call once per font change)
renderer.measure_cell(window);

// Paint the terminal grid
renderer.paint(bounds, padding, &term, window, cx);

§Performance

For optimal performance:

  • Call measure_cell only when font settings change
  • The paint method is designed to be called every frame
  • Background and text batching minimize GPU draw calls

Fields§

§font_family: String

Font family name (e.g., “Fira Code”, “Menlo”)

§font_size: Pixels

Font size in pixels

§cell_width: Pixels

Width of a single character cell

§cell_height: Pixels

Height of a single character cell (line height)

§line_height_multiplier: f32

Multiplier for line height to accommodate tall glyphs

§palette: ColorPalette

Color palette for resolving terminal colors

Implementations§

Source§

impl TerminalRenderer

Source

pub fn new( font_family: String, font_size: Pixels, line_height_multiplier: f32, palette: ColorPalette, ) -> Self

Creates a new terminal renderer with the given font settings and color palette.

§Arguments
  • font_family - The name of the font family to use
  • font_size - The font size in pixels
  • line_height_multiplier - Multiplier for line height (e.g., 1.2 for 20% extra)
  • palette - The color palette to use for terminal colors
§Returns

A new TerminalRenderer instance with default cell dimensions.

§Examples
use gpui::px;
use gpui_terminal::render::TerminalRenderer;
use gpui_terminal::ColorPalette;

let renderer = TerminalRenderer::new("Fira Code".to_string(), px(14.0), 1.2, ColorPalette::default());
Source

pub fn measure_cell(&mut self, window: &mut Window)

Measure cell dimensions based on actual font metrics.

This method measures the actual width and height of characters using the GPUI text system.

§Arguments
  • window - The GPUI window for text system access
Source

pub fn layout_row( &self, row: usize, cells: impl Iterator<Item = (usize, Cell)>, colors: &Colors, ) -> (Vec<BackgroundRect>, Vec<BatchedTextRun>)

Layout cells into batched text runs and background rects for a single row.

This method processes a row of terminal cells and groups adjacent cells with identical styling into batched runs. It also collects background rectangles that need to be painted.

§Arguments
  • row - The row number
  • cells - Iterator over (column, Cell) pairs
  • colors - Terminal color configuration
§Returns

A tuple of (backgrounds, text_runs) where:

  • backgrounds is a vector of merged background rectangles
  • text_runs is a vector of batched text runs
Source

pub fn paint( &self, bounds: Bounds<Pixels>, padding: Edges<Pixels>, term: &Term<GpuiEventProxy>, window: &mut Window, _cx: &mut App, )

Paint terminal content to the window.

This is the main rendering method that draws the terminal grid, including backgrounds, text, and cursor.

§Arguments
  • bounds - The bounding box to render within
  • padding - Padding around the terminal content
  • term - The terminal state
  • window - The GPUI window
  • cx - The application context

Trait Implementations§

Source§

impl Clone for TerminalRenderer

Source§

fn clone(&self) -> TerminalRenderer

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

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> 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> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

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

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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