Struct ShaderBuilder 

pub struct ShaderBuilder { /* private fields */ }

Builder for a Shader node.

Implementations

impl ShaderBuilder

pub fn width(self, v: impl Into<Span>) -> Self

Width in pixels, or pct(100) for the whole frame.

pub fn height(self, v: impl Into<Span>) -> Self

Height in pixels, or a percentage of the frame.

pub fn size(self, width: impl Into<Span>, height: impl Into<Span>) -> Self

Width and height together: .size(800.0, 450.0) or .size(pct(100), 300.0).

pub fn fullscreen(self) -> Self

Uses the frame as the box. Put the node on the view so a camera does not move it.

pub fn uniform(self, name: impl Into<String>, value: f64) -> Self

Sets a numeric Params field. A name that is not in the shader fails check (param_unknown).

pub fn uniform_vec2( self, name: impl Into<String>, value: impl Into<Vec2>, ) -> Self

Sets a vec2<f32> field from a point.

pub fn uniform_color( self, name: impl Into<String>, value: impl IntoPaint, ) -> Self

Sets a vec4<f32> field from a color or a theme role such as Accent.

pub fn uniform_bool(self, name: impl Into<String>, value: bool) -> Self

Sets a bool field.

pub fn amp(self, value: f64) -> Self

Wave height, as a fraction of the box. The preset default is 0.05.

pub fn speed(self, value: f64) -> Self

How fast the crest travels. The preset default is 1.

pub fn deep(self, value: impl IntoPaint) -> Self

Color below the crest. A theme role such as Accent follows the theme.

pub fn foam(self, value: impl IntoPaint) -> Self

Color of the crest.

pub fn input(self, name: impl Into<String>, input: Input) -> Self

Names what the shader reads. lens_drops reads "scene", which is the frame drawn before it whether or not this is called. A name the preset does not read fails check (param_unknown).

A custom shade reads input "photo" with sample_photo(uv):

Shader::file("shaders/wobble.wgsl").input("photo", Input::file("photo.png"))
// in WGSL: return sample_photo(i.uv + vec2<f32>(sin(i.uv.y * 40.0) * 0.01, 0.0));

With Input::frame the shader reads what was drawn before it and is painted over it inside its box: sample_scene(i.screen / ox.resolution).

pub fn wetness(self, value: f64) -> Self

How many drops cover the lens of lens_drops, 0 to 1. The preset default is 0.6; start from 0 to keep the lens dry until a splash.

pub fn seed(self, value: u64) -> Self

Drop layout of lens_drops. The same seed places the same drops.

pub fn drop_size(self, value: f64) -> Self

Drop size of lens_drops, as a multiple of the default.

Trait Implementations

impl NodeBuilder for ShaderBuilder

type Handle = Shader

Handle returned by Node::add.

fn name(self, v: impl Into<String>) -> Self

Name shown in the editor and in oxframe check / oxframe inspect. Without it, the node is labeled by the add call site (src/main.rs:42).

fn x(self, v: f64) -> Self

Horizontal position; 0 is the parent’s center, positive is right.

fn y(self, v: f64) -> Self

Vertical position; 0 is the parent’s center, positive is down.

fn position(self, v: impl Into<Vec2>) -> Self

Sets x and y together, e.g. .position((100.0, -50.0)).

fn rotation(self, v: f64) -> Self

Degrees, clockwise.

fn scale(self, v: impl IntoScale) -> Self

Scale; 1 is the natural size. One number for both axes (1.5) or a pair ((2.0, 0.5), a Vec2).

fn scale_xy(self, v: impl Into<Vec2>) -> Self

Separate horizontal and vertical scale.

fn opacity(self, v: f64) -> Self

Opacity of the node and its children, 0 (invisible) to 1.

fn fill(self, v: impl IntoPaint) -> Self

Fill color: a Color or a theme role such as Accent. Default: transparent, except text, which uses the theme’s text color.

fn stroke(self, v: impl IntoPaint) -> Self

Outline color; also set line_width. A theme role works the same as a color. Default: transparent.

fn line_width(self, v: f64) -> Self

Outline width in pixels. Default: 0 (no outline).

fn start(self, v: f64) -> Self

Start of the drawn part of the outline, fraction of its length.

fn end(self, v: f64) -> Self

End of the drawn part of the outline; animate 0 → 1 to draw it on.

fn fill_gradient(self, g: Gradient) -> Self

Gradient fill (local coordinates, origin at the node center); overrides fill.

fn stroke_gradient(self, g: Gradient) -> Self

Gradient outline; overrides stroke.

fn dash(self, pattern: impl Into<Vec<f64>>) -> Self

Dash pattern: on, off, on, … lengths. Animate dash_offset for marching ants.

fn dash_offset(self, v: f64) -> Self

Shifts the dash pattern along the outline.

fn line_cap(self, v: LineCap) -> Self

Shape of outline ends. Default: round.

fn line_join(self, v: LineJoin) -> Self

Shape of outline corners. Default: round.

fn blur(self, v: f64) -> Self

Gaussian blur of the node and its children (standard deviation, in the node’s units).

fn shadow( self, color: impl IntoPaint, blur: f64, offset: impl Into<Vec2>, ) -> Self

Drop shadow under the node and its children.

fn elevation(self, step: Step) -> Self

The theme’s shadow for this step (Xs and Sm are the small one, Xl the large).

fn glow(self, color: impl IntoPaint, blur: f64) -> Self

A shadow without offset.

fn clip(self, v: bool) -> Self

Clip children to this node’s outline (or box).

fn blend(self, v: BlendMode) -> Self

How the node is composited onto what is below it.

fn offscreen(self) -> Self

Not drawn on screen: the node and its children are drawn only for a shader that reads them with Input::node. check skips them.

fn z_index(self, v: f64) -> Self

Paint order among siblings; higher is on top.

fn anchor(self, v: impl Into<Vec2>) -> Self

Pivot and placement point: (-1, -1) top-left … (1, 1) bottom-right.

fn grow(self, v: f64) -> Self

Inside a Layout: share of the free space this node takes.

fn shrink(self, v: f64) -> Self

Inside a Layout: how much this node gives up when space is short.

fn basis(self, v: f64) -> Self

Inside a Layout: main-axis size before growing/shrinking.

fn margin(self, v: impl Len) -> Self

Inside a Layout: space around this node, in pixels or a theme step (.margin(Md)).

fn align_self(self, v: LayoutAlign) -> Self

Inside a Layout: overrides the layout’s cross-axis alignment.

fn next_to(self, other: impl Into<Node>, side: Side) -> Self

Sits just outside other, on side. The gap is the theme’s Md step. Recomputed every frame, so this node follows other.

fn align_to(self, other: impl Into<Node>, edge: Edge) -> Self

Lines this node’s edge up with the same edge of other.

fn to_edge(self, edge: Edge) -> Self

Pins one edge to the safe area (not the raw frame edge). The other axis stays at x or y.

fn center_in(self, other: impl Into<Node>) -> Self

Same center as other. Pass the view to center in the frame.

fn child<C: NodeBuilder>(self, child: C) -> Self

Adds a child created together with this node. Use Node::add when you need the child’s handle.