Struct Builder

pub struct Builder<'a, P: PostProcessor = DefaultPostProcessor> { /* private fields */ }

Builds a WgpuBackend instance.

Height and width will default to 1x1, so don’t forget to call Builder::with_dimensions to configure the backend presentation dimensions.

Implementations

impl<'a, P: PostProcessor> Builder<'a, P>

where P::UserData: Default,

pub fn from_font(font: Font<'a>) -> Self

Create a new Builder from a specified Font and default PostProcessor::UserData.

impl<'a, P: PostProcessor> Builder<'a, P>

pub fn from_font_and_user_data(font: Font<'a>, user_data: P::UserData) -> Self

Create a new Builder from a specified Font and supplied PostProcessor::UserData.

pub fn with_instance(self, instance: Instance) -> Self

Use the supplied wgpu::Instance when building the backend.

pub fn with_viewport(self, viewport: Viewport) -> Self

Use the supplied Viewport for rendering. Defaults to Viewport::Full.

pub fn with_font_size_px(self, size: u32) -> Self

Use the specified font size in pixels. Defaults to 24px.

pub fn with_fonts<I: IntoIterator<Item = Font<'a>>>(self, fonts: I) -> Self

Use the specified list of fonts for rendering. You may call this multiple times to extend the list of fallback fonts. Note that this will automatically organize fonts by relative width in order to optimize fallback rendering quality. The ordering of already provided fonts will remain unchanged.

See also Fonts::add_fonts.

pub fn with_regular_fonts<I: IntoIterator<Item = Font<'a>>>( self, fonts: I, ) -> Self

Use the specified list of regular fonts for rendering. You may call this multiple times to extend the list of fallback fonts.

See also Fonts::add_regular_fonts.

pub fn with_bold_fonts<I: IntoIterator<Item = Font<'a>>>(self, fonts: I) -> Self

Use the specified list of bold fonts for rendering. You may call this multiple times to extend the list of fallback fonts.

See also Fonts::add_bold_fonts.

pub fn with_italic_fonts<I: IntoIterator<Item = Font<'a>>>( self, fonts: I, ) -> Self

Use the specified list of italic fonts for rendering. You may call this multiple times to extend the list of fallback fonts.

See also Fonts::add_italic_fonts.

pub fn with_bold_italic_fonts<I: IntoIterator<Item = Font<'a>>>( self, fonts: I, ) -> Self

Use the specified list of bold italic fonts for rendering. You may call this multiple times to extend the list of fallback fonts.

See also Fonts::add_bold_italic_fonts.

pub fn with_limits(self, limits: Limits) -> Self

Use the specified wgpu::Limits. Defaults to wgpu::Adapter::limits.

pub fn with_present_mode(self, mode: PresentMode) -> Self

Use the specified wgpu::PresentMode.

pub fn with_dimensions(self, dimensions: Dimensions) -> Self

Use the specified height and width when creating the surface. Defaults to 1x1.

pub fn with_width_and_height(self, dimensions: Dimensions) -> Self

Use the specified height and width when creating the surface. Defaults to 1x1.

pub fn with_fg_color(self, fg: Color) -> Self

Use the specified ratatui::style::Color for the default foreground color. Defaults to Black.

pub fn with_bg_color(self, bg: Color) -> Self

Use the specified ratatui::style::Color for the default background color. Defaults to White.

pub fn with_rapid_blink_millis(self, millis: u64) -> Self

Use the specified interval in milliseconds as the rapid blink speed. Note that this library doesn’t spin off rendering into a separate thread for you. If you want text to blink, you must ensure that a call to flush is made frequently enough. Defaults to 200ms.

pub fn with_slow_blink_millis(self, millis: u64) -> Self

Use the specified interval in milliseconds as the slow blink speed. Note that this library doesn’t spin off rendering into a separate thread for you. If you want text to blink, you must ensure that a call to flush is made frequently enough. Defaults to 1000ms.

impl<'a, P: PostProcessor> Builder<'a, P>

pub async fn build_with_target<'s>( self, target: impl Into<SurfaceTarget<'s>>, ) -> Result<WgpuBackend<'a, 's, P>>

Build a new backend with the provided surface target - e.g. a winit Window.

pub async fn build_with_surface<'s>( self, surface: Surface<'s>, ) -> Result<WgpuBackend<'a, 's, P>>

Build a new backend from this builder with the supplied surface. You almost certainly want to call this with the instance you used to create the provided surface - see Builder::with_instance. If one is not provided, a default instance will be created.