Struct Shader 

pub struct Shader { /* private fields */ }

A live effect viewport that renders a Program into half-block cells.

The program advances on the shared presentation clock and repaints at FRAME cadence while presented; a still program paints once and requests nothing. Unlit cells stay transparent, so set bg for a backdrop. Mount it in dom! as an expression child, or register a factory for a <shader> markup tag through crate::Elements.

use omp_tui::{components::Shader, dom, scene::vec3};

// A still radial glow; animated effects implement `shader::Program`.
let glow = |x: f32, y: f32| {
	let (dx, dy) = (x - 12.0, y - 8.0);
	let fall = 1.0 - ((dx * dx + dy * dy).sqrt() / 10.0).min(1.0);
	(vec3(0.4, 0.8, 1.0) * fall, fall)
};
let tree = dom! {
	<col>
		{Shader::new(glow).size(24, 8).still()}
	</col>
};

Implementations

impl Shader

pub fn new(program: impl Program + 'static) -> Self

Creates a 24×8-cell viewport over program.

Examples found in repository

examples/gallery/eclipse.rs (line 14)

pub(crate) fn pane(viewport: Size, rows: u16) -> Box<dyn Component> {
	dom! {
		<col>
			{Shader::new(Eclipse::default()).size(viewport.width, rows)}
			<text dim>{"stencil.so eclipse"}</text>
		</col>
	}
	.into_component()
}

pub const fn size(self, cols: u16, rows: u16) -> Self

Sets the viewport size in terminal cells.

A live w (in cells) or h prop overrides this, so a host resizes the viewport with crate::Ui::set_prop / crate::Ui::set_height instead of rebuilding the tree.

Examples found in repository

examples/gallery/eclipse.rs (line 14)

pub(crate) fn pane(viewport: Size, rows: u16) -> Box<dyn Component> {
	dom! {
		<col>
			{Shader::new(Eclipse::default()).size(viewport.width, rows)}
			<text dim>{"stencil.so eclipse"}</text>
		</col>
	}
	.into_component()
}

pub const fn still(self) -> Self

Paints once instead of animating — for programs that ignore the clock.

pub fn with(self, prop: Prop, value: impl Into<PropValue>) -> Self

Sets one shader property.

Trait Implementations

impl Component for Shader

fn props(&self) -> &Props

Component properties.

fn props_mut(&mut self) -> &mut Props

Mutable component properties.

fn slot(&self) -> Slot

Stable identity.

fn measure(&mut self, _ctx: &UiContext) -> (u16, u16)

Content width bounds, exclusive of this component’s chrome.

fn height(&mut self, _ctx: &UiContext, _width: u16) -> u16

Content height at the supplied content width.

fn paint(&mut self, pc: &mut PaintCtx<'_>, rect: Rect)

Paints content inside the supplied content rectangle.

fn kind(&self) -> &'static str

Concrete implementation name for debug tooling; defaults to the type’s full path via std::any::type_name. The OMP_TUI_DEBUG tree dump trims it to the trailing path segment.

fn children(&self) -> &[Cached]

Every owned child, including embedded inactive subtrees.

fn children_mut(&mut self) -> &mut [Cached]

Every owned child, including embedded inactive subtrees.

fn place(&mut self, ctx: &UiContext, content: Rect)

Places children inside the supplied content rectangle.

fn paints_border(&self) -> bool

Whether Cached should paint this component’s border property as chrome.

fn paints_background(&self) -> bool

Whether Cached should paint this component’s background property across its rectangle. Components that own a partial background fill opt out and paint it themselves.

fn gradient_bounds(&self, content: Rect) -> Option<Rect>

A narrowed projection frame for two-stop fg=/bg= ramps, given the painted content rectangle. None projects across the full chrome; content-sized leaves (crate::components::Pre) return their authored extent so the ramp completes across the glyphs instead of the stretched layout width.

fn resize_tail(&mut self) -> Option<ResizeTail<'_>>

Opt-in viewport-tail provider for resize drags: children a drag frame may compose bottom-up, with the vertical gap between them. None — the default — renders this component whole.

fn validation_error(&self) -> Option<String>

A validation error blocking submission — an unmet required or match= constraint owned by this component’s internal records; None when valid. Component-level props are checked by the caller.

fn stretch_in_row(&self) -> bool

Whether a row should stretch this component across its cross axis.

fn focusable(&self) -> bool

Whether this component contributes its own slot to the focus ring. The default honors the focus flag, so any container can opt into keyboard navigation from markup.

fn enter(&mut self, forward: bool)

Positions internal selection when focus enters from either direction.

fn ring(&self, out: &mut Vec<Slot>)

Appends focusable slots in document order.

fn key(&mut self, ec: &mut EventCtx<'_>, key: Key) -> Flow

Handles a keyboard event.

fn mouse( &mut self, ec: &mut EventCtx<'_>, tag: HitTag, at: (u16, u16), rect: Rect, mouse: Mouse, ) -> Flow

Handles a mouse gesture over one of this component’s hit regions.

fn paste(&mut self, ec: &mut EventCtx<'_>, text: &str) -> Flow

Pastes text into this component: Flow::Consumed repaints, Flow::Event additionally surfaces a crate::UiEvent, and Flow::Skip leaves the paste unhandled.

fn paste_raw(&mut self, ec: &mut EventCtx<'_>, text: &str) -> Flow

Pastes text verbatim, bypassing any smart-paste interpretation the component applies in Component::paste (drop classification, large-paste collapse). Defaults to Component::paste for components without such interpretation.

fn value(&self, out: &mut Map<String, Value>)

Adds this component’s named value to an output object.

fn set_text(&mut self, ctx: &UiContext, text: Str) -> bool

Replaces text content where supported.