TuiRendererOptions class
Options for configuring a TuiRenderer.
These values are derived from ProgramOptions so the runtime can switch between full-screen and inline presentation without changing renderer implementations.
Constructors
- TuiRendererOptions({int fps = 60, bool altScreen = true, bool hideCursor = true, bool ansiCompress = false, ScreenMode screenMode = ScreenMode.fullScreen, int inlineHeight = 4, UiAnchor uiAnchor = UiAnchor.bottom, FixedViewport? fixedViewport})
-
Creates renderer options.
const
Properties
- altScreen → bool
-
Whether to use the alternate screen buffer.
final
- ansiCompress → bool
-
Whether to compress redundant ANSI sequences.
final
- fixedViewport → FixedViewport?
-
Rectangle owned by a ScreenMode.fixed renderer.
final
- fps → int
-
Maximum frames per second for rendering.
final
- frameTime → Duration
-
The minimum time between renders.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- hideCursor → bool
-
Whether to hide the cursor during rendering.
final
- inlineHeight → int
-
Height of the inline UI region in rows.
final
- isBounded → bool
-
Whether output is constrained to a primary-screen viewport.
no setter
- isInline → bool
-
Whether the renderer operates in inline (non-alt-screen) mode.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- screenMode → ScreenMode
-
The effective screen mode for this renderer.
final
- uiAnchor → UiAnchor
-
Which edge of the viewport this inline UI region is anchored to.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited