Skip to main content

RendererParams

Struct RendererParams 

Source
pub struct RendererParams<'a> {
Show 44 fields pub window: Arc<Window>, pub vsync_mode: VsyncMode, pub power_preference: PowerPreference, pub window_opacity: f32, pub font_family: Option<&'a str>, pub font_family_bold: Option<&'a str>, pub font_family_italic: Option<&'a str>, pub font_family_bold_italic: Option<&'a str>, pub font_ranges: &'a [FontRange], pub font_size: f32, pub enable_text_shaping: bool, pub enable_ligatures: bool, pub enable_kerning: bool, pub font_antialias: bool, pub font_hinting: bool, pub font_thin_strokes: ThinStrokesMode, pub minimum_contrast: f32, pub window_padding: f32, pub line_spacing: f32, pub char_spacing: f32, pub scrollbar_position: &'a str, pub scrollbar_width: f32, pub scrollbar_thumb_color: [f32; 4], pub scrollbar_track_color: [f32; 4], pub background_color: [u8; 3], pub background_image_path: Option<&'a str>, pub background_image_enabled: bool, pub background_image_mode: BackgroundImageMode, pub background_image_opacity: f32, pub custom_shader_path: Option<&'a str>, pub custom_shader_enabled: bool, pub custom_shader_animation: bool, pub custom_shader_animation_speed: f32, pub custom_shader_full_content: bool, pub custom_shader_brightness: f32, pub custom_shader_channel_paths: &'a [Option<PathBuf>; 4], pub custom_shader_cubemap_path: Option<&'a Path>, pub use_background_as_channel0: bool, pub image_scaling_mode: ImageScalingMode, pub image_preserve_aspect_ratio: bool, pub cursor_shader_path: Option<&'a str>, pub cursor_shader_enabled: bool, pub cursor_shader_animation: bool, pub cursor_shader_animation_speed: f32,
}
Expand description

Bundles all parameters needed by super::Renderer::new().

Grouping the parameters into a struct eliminates the 46-argument function signature (audit finding H4) without changing any behaviour.

Fields§

§window: Arc<Window>

The winit window that owns the wgpu surface.

§vsync_mode: VsyncMode

Vsync presentation mode.

§power_preference: PowerPreference

GPU power preference (low-power vs high-performance).

§window_opacity: f32

Window opacity (0.0 fully transparent – 1.0 fully opaque).

§font_family: Option<&'a str>

Primary font family name (None = system default).

§font_family_bold: Option<&'a str>

Bold variant family override.

§font_family_italic: Option<&'a str>

Italic variant family override.

§font_family_bold_italic: Option<&'a str>

Bold-italic variant family override.

§font_ranges: &'a [FontRange]

Additional Unicode ranges and their fallback fonts.

§font_size: f32

Font size in points.

§enable_text_shaping: bool

Enable HarfBuzz text shaping.

§enable_ligatures: bool

Enable OpenType ligatures.

§enable_kerning: bool

Enable OpenType kerning.

§font_antialias: bool

Enable font anti-aliasing.

§font_hinting: bool

Enable font hinting.

§font_thin_strokes: ThinStrokesMode

Thin-strokes rendering mode.

§minimum_contrast: f32

Minimum contrast ratio between foreground and background.

§window_padding: f32

Padding around the terminal content in logical pixels.

§line_spacing: f32

Line height multiplier.

§char_spacing: f32

Character width multiplier.

§scrollbar_position: &'a str

Scrollbar position string (“left”, “right”, “hidden”).

§scrollbar_width: f32

Scrollbar width in logical pixels.

§scrollbar_thumb_color: [f32; 4]

Scrollbar thumb color [R, G, B, A].

§scrollbar_track_color: [f32; 4]

Scrollbar track color [R, G, B, A].

§background_color: [u8; 3]

Theme background color [R, G, B].

§background_image_path: Option<&'a str>

Optional background image file path.

§background_image_enabled: bool

Whether the background image feature is enabled.

§background_image_mode: BackgroundImageMode

How the background image is displayed (stretch, tile, etc.).

§background_image_opacity: f32

Background image opacity (0.0 – 1.0).

§custom_shader_path: Option<&'a str>

Name / path of the custom background shader.

§custom_shader_enabled: bool

Whether the custom shader is enabled.

§custom_shader_animation: bool

Whether the custom shader is animated.

§custom_shader_animation_speed: f32

Animation speed multiplier for the custom shader.

§custom_shader_full_content: bool

Whether the shader renders over the full surface (vs. terminal area).

§custom_shader_brightness: f32

Brightness multiplier applied to the shader output.

§custom_shader_channel_paths: &'a [Option<PathBuf>; 4]

Channel texture paths (iChannel0..3).

§custom_shader_cubemap_path: Option<&'a Path>

Cubemap texture path prefix (iCubemap).

§use_background_as_channel0: bool

Use the background image as iChannel0.

§image_scaling_mode: ImageScalingMode

Scaling filter for inline images (nearest vs linear).

§image_preserve_aspect_ratio: bool

Whether to preserve aspect ratio when scaling inline images.

§cursor_shader_path: Option<&'a str>

Name / path of the cursor shader.

§cursor_shader_enabled: bool

Whether the cursor shader is enabled.

§cursor_shader_animation: bool

Whether the cursor shader is animated.

§cursor_shader_animation_speed: f32

Animation speed multiplier for the cursor shader.

Auto Trait Implementations§

§

impl<'a> Freeze for RendererParams<'a>

§

impl<'a> !RefUnwindSafe for RendererParams<'a>

§

impl<'a> Send for RendererParams<'a>

§

impl<'a> Sync for RendererParams<'a>

§

impl<'a> Unpin for RendererParams<'a>

§

impl<'a> UnsafeUnpin for RendererParams<'a>

§

impl<'a> !UnwindSafe for RendererParams<'a>

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

Source§

fn downcast(&self) -> &T

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 + Send + Sync>

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> 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, 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> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

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
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,