Enum Input 

#[non_exhaustive]
pub enum Input {
    Frame,
    Backdrop,
    Image(Rc<RasterImage>),
    Node(NodeId),
}

What a shader reads besides its own parameters.

The frame and the backdrop are the pixels drawn before the node. Inside a layer (a group with opacity below 1, a blur, a clip, a blend, a shadow or an effect) both are what that layer drew before the node.

A custom shade reads an input named "photo" with sample_photo(uv), which returns straight-alpha sRGB vec4<f32>; uv runs from 0 to 1 across the image and is clamped at the edges.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Frame

Everything painted before this node, in screen coordinates.

Backdrop

What the parent painted before this node. On a node that is not in a layer this is the same as Input::Frame.

Image(Rc<RasterImage>)

A PNG or JPEG image.

Node(NodeId)

Another node’s pixels, usually one added with .offscreen().

Implementations

impl Input

pub fn frame() -> Self

The whole frame before this node.

pub fn backdrop() -> Self

What was painted before this node in its parent’s layer.

pub fn image(bytes: &[u8]) -> Self

A PNG or JPEG image from its bytes, e.g. include_bytes!.

Panics

If the bytes are not a PNG or JPEG image.

pub fn file(path: impl AsRef<Path>) -> Self

Reads a PNG or JPEG file (native only).

Panics

If the file cannot be read or decoded.

pub fn node(node: impl Into<Node>) -> Self

The pixels of node and its children, drawn alone on a clear background. uv runs from 0 to 1 across the node’s box. Add the node with .offscreen() to draw it only for the shader.

pub fn name(&self) -> &'static str

"frame", "backdrop", "image" or "node".

Trait Implementations

impl Clone for Input

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Input

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Input

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.